Debian Codegraph @

docs/dyn/compute_beta.networkFirewallPolicies.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.networkFirewallPolicies.html">networkFirewallPolicies</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addAssociation">addAssociation(project, firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Inserts an association for the specified firewall policy.</p>
80 <p class="toc_element">
81 <code><a href="#addPacketMirroringRule">addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Inserts a packet mirroring rule into a firewall policy.</p>
83 <p class="toc_element">
84 <code><a href="#addRule">addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Inserts a rule into a firewall policy.</p>
86 <p class="toc_element">
87 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves an aggregated list of network firewall policies, listing network</p>
89 <p class="toc_element">
90 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#cloneRules">cloneRules(project, firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Copies rules to the specified firewall policy.</p>
95 <p class="toc_element">
96 <code><a href="#close">close()</a></code></p>
97 <p class="firstline">Close httplib2 connections.</p>
98 <p class="toc_element">
99 <code><a href="#delete">delete(project, firewallPolicy, requestId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Deletes the specified policy.</p>
101 <p class="toc_element">
102 <code><a href="#get">get(project, firewallPolicy, x__xgafv=None)</a></code></p>
103 <p class="firstline">Returns the specified network firewall policy.</p>
104 <p class="toc_element">
105 <code><a href="#getAssociation">getAssociation(project, firewallPolicy, name=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Gets an association with the specified name.</p>
107 <p class="toc_element">
108 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
110 <p class="toc_element">
111 <code><a href="#getPacketMirroringRule">getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Gets a packet mirroring rule of the specified priority.</p>
113 <p class="toc_element">
114 <code><a href="#getRule">getRule(project, firewallPolicy, priority=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Gets a rule of the specified priority.</p>
116 <p class="toc_element">
117 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Creates a new policy in the specified project using the data included in</p>
119 <p class="toc_element">
120 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Lists all the policies that have been configured for the specified project.</p>
122 <p class="toc_element">
123 <code><a href="#list_next">list_next()</a></code></p>
124 <p class="firstline">Retrieves the next page of results.</p>
125 <p class="toc_element">
126 <code><a href="#patch">patch(project, firewallPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Patches the specified policy with the data included in the request.</p>
128 <p class="toc_element">
129 <code><a href="#patchPacketMirroringRule">patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Patches a packet mirroring rule of the specified priority.</p>
131 <p class="toc_element">
132 <code><a href="#patchRule">patchRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</a></code></p>
133 <p class="firstline">Patches a rule of the specified priority.</p>
134 <p class="toc_element">
135 <code><a href="#removeAssociation">removeAssociation(project, firewallPolicy, name=None, requestId=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Removes an association for the specified firewall policy.</p>
137 <p class="toc_element">
138 <code><a href="#removePacketMirroringRule">removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</a></code></p>
139 <p class="firstline">Deletes a packet mirroring rule of the specified priority.</p>
140 <p class="toc_element">
141 <code><a href="#removeRule">removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</a></code></p>
142 <p class="firstline">Deletes a rule of the specified priority.</p>
143 <p class="toc_element">
144 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Sets the access control policy on the specified resource.</p>
146 <p class="toc_element">
147 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
148 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
149 <h3>Method Details</h3>
150 <div class="method">
151 <code class="details" id="addAssociation">addAssociation(project, firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</code>
152 <pre>Inserts an association for the specified firewall policy.
153
154 Args:
155 project: string, Project ID for this request. (required)
156 firewallPolicy: string, Name of the firewall policy to update. (required)
157 body: object, The request body.
158 The object takes the form of:
159
160 {
161 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
162 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
163 # of the firewall policy of the association.
164 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
165 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
166 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
167 # must be a positive value between 1 and 2147483647.
168 # Firewall Policies are evaluated from highest to lowest priority where 1
169 # is the highest priority and 2147483647 is the lowest priority.
170 # The default value is `1000`. If two associations have the same priority
171 # then lexicographical order on association names is applied.
172 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
173 }
174
175 replaceExistingAssociation: boolean, Indicates whether or not to replace it if an association of the attachment
176 already exists. This is false by default, in which case an error will be
177 returned if an association already exists.
178 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
179 that if you must retry your request, the server will know to ignore the
180 request if it has already been completed.
181
182 For example, consider a situation where you make an initial request and
183 the request times out. If you make the request again with the same
184 request ID, the server can check if original operation with the same
185 request ID was received, and if so, will ignore the second request. This
186 prevents clients from accidentally creating duplicate commitments.
187
188 The request ID must be
189 a valid UUID with the exception that zero UUID is not supported
190 (00000000-0000-0000-0000-000000000000).
191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
195
196 Returns:
197 An object of the form:
198
199 { # Represents an Operation resource.
200 #
201 # Google Compute Engine has three Operation resources:
202 #
203 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
204 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
205 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
206 #
207 # You can use an operation resource to manage asynchronous API requests.
208 # For more information, readHandling
209 # API responses.
210 #
211 # Operations can be global, regional or zonal.
212 #
213 # - For global operations, use the `globalOperations`
214 # resource.
215 # - For regional operations, use the
216 # `regionOperations` resource.
217 # - For zonal operations, use
218 # the `zoneOperations` resource.
219 #
220 #
221 #
222 # For more information, read
223 # Global, Regional, and Zonal Resources.
224 #
225 # Note that completed Operation resources have a limited
226 # retention period.
227 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
228 # Not present otherwise.
229 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
230 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
231 # set when the operation is created.
232 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
233 # text format.
234 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
235 # this field will be populated.
236 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
237 # operation.
238 {
239 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
240 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
241 # details. There is a set of defined message types to use for providing
242 # details.The syntax depends on the error code. For example,
243 # QuotaExceededInfo will have details when the error code is
244 # QUOTA_EXCEEDED.
245 {
246 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
247 #
248 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
249 # is not enabled:
250 #
251 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
252 # &quot;domain&quot;: &quot;googleapis.com&quot;
253 # &quot;metadata&quot;: {
254 # &quot;resource&quot;: &quot;projects/123&quot;,
255 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
256 # }
257 # }
258 #
259 # This response indicates that the pubsub.googleapis.com API is not enabled.
260 #
261 # Example of an error that is returned when attempting to create a Spanner
262 # instance in a region that is out of stock:
263 #
264 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
265 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
266 # &quot;metadata&quot;: {
267 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
268 # }
269 # }
270 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
271 # is typically the registered service name of the tool or product that
272 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
273 # generated by some common infrastructure, the error domain must be a
274 # globally unique value that identifies the infrastructure. For Google API
275 # infrastructure, the error domain is &quot;googleapis.com&quot;.
276 &quot;metadatas&quot;: { # Additional structured details about this error.
277 #
278 # Keys must match a regular expression of `a-z+` but should
279 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
280 # length. When identifying the current value of an exceeded limit, the units
281 # should be contained in the key, not the value. For example, rather than
282 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
283 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
284 # instances that can be created in a single (batch) request.
285 &quot;a_key&quot;: &quot;A String&quot;,
286 },
287 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
288 # proximate cause of the error. Error reasons are unique within a particular
289 # domain of errors. This should be at most 63 characters and match a
290 # regular expression of `A-Z+[A-Z0-9]`, which represents
291 # UPPER_SNAKE_CASE.
292 },
293 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
294 #
295 # For example, if a quota check failed with an error indicating the calling
296 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
297 # directly to the right place in the developer console to flip the bit.
298 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
299 { # Describes a URL link.
300 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
301 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
302 },
303 ],
304 },
305 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
306 # which can be attached to an RPC error.
307 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
308 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
309 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
310 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
311 },
312 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
313 &quot;dimensions&quot;: { # The map holding related quota dimensions.
314 &quot;a_key&quot;: &quot;A String&quot;,
315 },
316 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
317 # type or metric.
318 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
319 # or metric.
320 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
321 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
322 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
323 },
324 },
325 ],
326 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
327 # This property is optional.
328 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
329 },
330 ],
331 },
332 &quot;getVersionOperationMetadata&quot;: {
333 &quot;inlineSbomInfo&quot;: {
334 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
335 # appropriate identifiers.
336 &quot;a_key&quot;: &quot;A String&quot;,
337 },
338 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
339 # identifiers.
340 &quot;a_key&quot;: &quot;A String&quot;,
341 },
342 },
343 },
344 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
345 # message that was returned, such as `NOT FOUND`.
346 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
347 # status code that was returned. For example, a `404` means the
348 # resource was not found.
349 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
350 # defined by the server.
351 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
352 # This value is inRFC3339
353 # text format.
354 &quot;instancesBulkInsertOperationMetadata&quot;: {
355 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
356 # Example key: zones/us-central1-a
357 &quot;a_key&quot;: {
358 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
359 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
360 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
361 # error.
362 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
363 # if the flow is rolling forward or rolling back.
364 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
365 },
366 },
367 },
368 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
369 # Operation resources.
370 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
371 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
372 # group of operations results from a `bulkInsert` API request.
373 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
374 # `update`, or `delete`, and so on.
375 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
376 # There is no requirement that this be linear or support any granularity of
377 # operations. This should not be used to guess when the operation will be
378 # complete. This number should monotonically increase as the operation
379 # progresses.
380 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
381 # applicable when performing regional operations.
382 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
383 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
384 # this field will contain information on all underlying zonal actions and
385 # their state.
386 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
387 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
388 # Example key: zones/us-central1-a
389 &quot;a_key&quot;: {
390 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
391 # populated.
392 # different programming environments, including REST APIs and RPC APIs. It is
393 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
394 # three pieces of data: error code, error message, and error details.
395 #
396 # You can find out more about this error model and how to work with it in the
397 # [API Design Guide](https://cloud.google.com/apis/design/errors).
398 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
399 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
400 # message types for APIs to use.
401 {
402 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
403 },
404 ],
405 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
406 # user-facing error message should be localized and sent in the
407 # google.rpc.Status.details field, or localized by the client.
408 },
409 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
410 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
411 },
412 },
413 },
414 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
415 # This value is inRFC3339
416 # text format.
417 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
418 # following:
419 # `PENDING`, `RUNNING`, or `DONE`.
420 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
421 # operation.
422 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
423 # of the target resource.
424 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
425 # operations related to creating a snapshot, this points to the disk
426 # that the snapshot was created from.
427 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
428 # `[email protected]` or
429 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
430 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
431 # operation, this field will be populated.
432 {
433 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
434 # Engine returns NO_RESULTS_ON_PAGE if there
435 # are no results in the response.
436 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
437 # value format. For example:
438 #
439 # &quot;data&quot;: [
440 # {
441 # &quot;key&quot;: &quot;scope&quot;,
442 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
443 # }
444 {
445 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
446 # returned. For example, for warnings where there are no results in a list
447 # request for a particular zone, this key might be scope and
448 # the key value might be the zone name. Other examples might be a key
449 # indicating a deprecated resource and a suggested replacement, or a
450 # warning about invalid network settings (for example, if an instance
451 # attempts to perform IP forwarding but is not enabled for IP forwarding).
452 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
453 },
454 ],
455 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
456 },
457 ],
458 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
459 # applicable when performing per-zone operations.
460 }</pre>
461 </div>
462
463 <div class="method">
464 <code class="details" id="addPacketMirroringRule">addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</code>
465 <pre>Inserts a packet mirroring rule into a firewall policy.
466
467 Args:
468 project: string, Project ID for this request. (required)
469 firewallPolicy: string, Name of the firewall policy to update. (required)
470 body: object, The request body.
471 The object takes the form of:
472
473 { # Represents a rule that describes one or more match conditions along with
474 # the action to be taken when traffic matches this condition (allow or deny).
475 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
476 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
477 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
478 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
479 # and &quot;goto_next&quot;.
480 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
481 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
482 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
483 # the firewall policy rule is not enforced and traffic behaves as if it did
484 # not exist. If this is unspecified, the firewall policy rule will be
485 # enabled.
486 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
487 # enabled, logs will be exported to the configured export destination in
488 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
489 # cannot enable logging on &quot;goto_next&quot; rules.
490 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
491 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
492 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
493 # Exactly one field must be specified.
494 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
495 # Maximum number of destination address groups is 10.
496 &quot;A String&quot;,
497 ],
498 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
499 # traffic destination.
500 # Maximum number of destination fqdn allowed is 100.
501 &quot;A String&quot;,
502 ],
503 &quot;destIpRanges&quot;: [ # CIDR IP address range.
504 # Maximum number of destination CIDR IP ranges allowed is 5000.
505 &quot;A String&quot;,
506 ],
507 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
508 #
509 #
510 # - UNSPECIFIED
511 # - INTERNET
512 # - NON_INTERNET
513 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
514 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
515 #
516 #
517 # - UNSPECIFIED
518 # - INTERNET
519 # - NON_INTERNET
520 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
521 # of traffic. Should be specified as 2 letter country code defined as per
522 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
523 # Maximum number of dest region codes allowed is 5000.
524 &quot;A String&quot;,
525 ],
526 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
527 # The IPs in these lists will be matched against traffic destination.
528 &quot;A String&quot;,
529 ],
530 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
531 {
532 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
533 # required when creating a firewall rule. This value can either be
534 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
535 # protocol number.
536 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
537 # only applicable for UDP or TCP protocol. Each entry must be either
538 # an integer or a range. If not specified, this rule applies to
539 # connections through any port.
540 #
541 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
542 &quot;A String&quot;,
543 ],
544 },
545 ],
546 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
547 # Maximum number of source address groups is 10.
548 &quot;A String&quot;,
549 ],
550 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
551 # traffic source.
552 # Maximum number of source fqdn allowed is 100.
553 &quot;A String&quot;,
554 ],
555 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
556 # Maximum number of source CIDR IP ranges allowed is 5000.
557 &quot;A String&quot;,
558 ],
559 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
560 #
561 #
562 # - UNSPECIFIED
563 # - INTERNET
564 # - INTRA_VPC
565 # - NON_INTERNET
566 # - VPC_NETWORKS
567 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
568 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
569 #
570 #
571 # - UNSPECIFIED
572 # - INTERNET
573 # - INTRA_VPC
574 # - NON_INTERNET
575 # - VPC_NETWORKS
576 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
577 &quot;A String&quot;,
578 ],
579 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
580 # of traffic. Should be specified as 2 letter country code defined as per
581 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
582 # Maximum number of source region codes allowed is 5000.
583 &quot;A String&quot;,
584 ],
585 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
586 # of the traffic.
587 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
588 # and there is no srcIpRange, this rule will be ignored.
589 # Maximum number of source tag values allowed is 256.
590 {
591 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
592 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
593 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
594 # or its network is deleted.
595 },
596 ],
597 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
598 # The IPs in these lists will be matched against traffic source.
599 &quot;A String&quot;,
600 ],
601 },
602 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
603 # must be a positive value between 0 and 2147483647.
604 # Rules are evaluated from highest to lowest priority where 0 is the
605 # highest priority and 2147483647 is the lowest priority.
606 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
607 # and can be updated.
608 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
609 # rule.
610 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
611 # Example:
612 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
613 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
614 # &#x27;mirror&#x27;. Cannot be specified for other actions.
615 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
616 # This field allows you to control which load balancers get this rule.
617 # For example, the following are valid values:
618 #
619 #
620 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
621 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
622 # - projects/project/global/
623 # forwardingRules/forwardingRule
624 # - projects/project/regions/region/forwardingRules/
625 # forwardingRule
626 &quot;A String&quot;,
627 ],
628 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
629 # allows you to control which network&#x27;s VMs get this rule. If this field
630 # is left blank, all VMs within the organization will receive the rule.
631 &quot;A String&quot;,
632 ],
633 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
634 # applies to. If targetSecureTag are specified, then the
635 # firewall rule applies only to instances in the VPC network that have one
636 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
637 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
638 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
639 # to all instances on the specified network.
640 # Maximum number of target label tags allowed is 256.
641 {
642 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
643 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
644 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
645 # or its network is deleted.
646 },
647 ],
648 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
649 # applied with this rule.
650 &quot;A String&quot;,
651 ],
652 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
653 # Default value is INSTANCES.
654 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
655 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
656 # be set for other actions.
657 }
658
659 maxPriority: integer, When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority&gt;.
660 This field is exclusive with rule.priority.
661 minPriority: integer, When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority&gt;.
662 This field is exclusive with rule.priority.
663 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
664 that if you must retry your request, the server will know to ignore the
665 request if it has already been completed.
666
667 For example, consider a situation where you make an initial request and
668 the request times out. If you make the request again with the same
669 request ID, the server can check if original operation with the same
670 request ID was received, and if so, will ignore the second request. This
671 prevents clients from accidentally creating duplicate commitments.
672
673 The request ID must be
674 a valid UUID with the exception that zero UUID is not supported
675 (00000000-0000-0000-0000-000000000000).
676 x__xgafv: string, V1 error format.
677 Allowed values
678 1 - v1 error format
679 2 - v2 error format
680
681 Returns:
682 An object of the form:
683
684 { # Represents an Operation resource.
685 #
686 # Google Compute Engine has three Operation resources:
687 #
688 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
689 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
690 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
691 #
692 # You can use an operation resource to manage asynchronous API requests.
693 # For more information, readHandling
694 # API responses.
695 #
696 # Operations can be global, regional or zonal.
697 #
698 # - For global operations, use the `globalOperations`
699 # resource.
700 # - For regional operations, use the
701 # `regionOperations` resource.
702 # - For zonal operations, use
703 # the `zoneOperations` resource.
704 #
705 #
706 #
707 # For more information, read
708 # Global, Regional, and Zonal Resources.
709 #
710 # Note that completed Operation resources have a limited
711 # retention period.
712 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
713 # Not present otherwise.
714 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
715 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
716 # set when the operation is created.
717 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
718 # text format.
719 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
720 # this field will be populated.
721 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
722 # operation.
723 {
724 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
725 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
726 # details. There is a set of defined message types to use for providing
727 # details.The syntax depends on the error code. For example,
728 # QuotaExceededInfo will have details when the error code is
729 # QUOTA_EXCEEDED.
730 {
731 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
732 #
733 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
734 # is not enabled:
735 #
736 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
737 # &quot;domain&quot;: &quot;googleapis.com&quot;
738 # &quot;metadata&quot;: {
739 # &quot;resource&quot;: &quot;projects/123&quot;,
740 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
741 # }
742 # }
743 #
744 # This response indicates that the pubsub.googleapis.com API is not enabled.
745 #
746 # Example of an error that is returned when attempting to create a Spanner
747 # instance in a region that is out of stock:
748 #
749 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
750 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
751 # &quot;metadata&quot;: {
752 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
753 # }
754 # }
755 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
756 # is typically the registered service name of the tool or product that
757 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
758 # generated by some common infrastructure, the error domain must be a
759 # globally unique value that identifies the infrastructure. For Google API
760 # infrastructure, the error domain is &quot;googleapis.com&quot;.
761 &quot;metadatas&quot;: { # Additional structured details about this error.
762 #
763 # Keys must match a regular expression of `a-z+` but should
764 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
765 # length. When identifying the current value of an exceeded limit, the units
766 # should be contained in the key, not the value. For example, rather than
767 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
768 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
769 # instances that can be created in a single (batch) request.
770 &quot;a_key&quot;: &quot;A String&quot;,
771 },
772 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
773 # proximate cause of the error. Error reasons are unique within a particular
774 # domain of errors. This should be at most 63 characters and match a
775 # regular expression of `A-Z+[A-Z0-9]`, which represents
776 # UPPER_SNAKE_CASE.
777 },
778 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
779 #
780 # For example, if a quota check failed with an error indicating the calling
781 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
782 # directly to the right place in the developer console to flip the bit.
783 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
784 { # Describes a URL link.
785 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
786 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
787 },
788 ],
789 },
790 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
791 # which can be attached to an RPC error.
792 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
793 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
794 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
795 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
796 },
797 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
798 &quot;dimensions&quot;: { # The map holding related quota dimensions.
799 &quot;a_key&quot;: &quot;A String&quot;,
800 },
801 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
802 # type or metric.
803 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
804 # or metric.
805 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
806 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
807 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
808 },
809 },
810 ],
811 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
812 # This property is optional.
813 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
814 },
815 ],
816 },
817 &quot;getVersionOperationMetadata&quot;: {
818 &quot;inlineSbomInfo&quot;: {
819 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
820 # appropriate identifiers.
821 &quot;a_key&quot;: &quot;A String&quot;,
822 },
823 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
824 # identifiers.
825 &quot;a_key&quot;: &quot;A String&quot;,
826 },
827 },
828 },
829 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
830 # message that was returned, such as `NOT FOUND`.
831 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
832 # status code that was returned. For example, a `404` means the
833 # resource was not found.
834 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
835 # defined by the server.
836 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
837 # This value is inRFC3339
838 # text format.
839 &quot;instancesBulkInsertOperationMetadata&quot;: {
840 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
841 # Example key: zones/us-central1-a
842 &quot;a_key&quot;: {
843 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
844 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
845 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
846 # error.
847 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
848 # if the flow is rolling forward or rolling back.
849 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
850 },
851 },
852 },
853 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
854 # Operation resources.
855 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
856 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
857 # group of operations results from a `bulkInsert` API request.
858 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
859 # `update`, or `delete`, and so on.
860 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
861 # There is no requirement that this be linear or support any granularity of
862 # operations. This should not be used to guess when the operation will be
863 # complete. This number should monotonically increase as the operation
864 # progresses.
865 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
866 # applicable when performing regional operations.
867 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
868 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
869 # this field will contain information on all underlying zonal actions and
870 # their state.
871 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
872 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
873 # Example key: zones/us-central1-a
874 &quot;a_key&quot;: {
875 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
876 # populated.
877 # different programming environments, including REST APIs and RPC APIs. It is
878 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
879 # three pieces of data: error code, error message, and error details.
880 #
881 # You can find out more about this error model and how to work with it in the
882 # [API Design Guide](https://cloud.google.com/apis/design/errors).
883 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
884 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
885 # message types for APIs to use.
886 {
887 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
888 },
889 ],
890 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
891 # user-facing error message should be localized and sent in the
892 # google.rpc.Status.details field, or localized by the client.
893 },
894 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
895 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
896 },
897 },
898 },
899 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
900 # This value is inRFC3339
901 # text format.
902 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
903 # following:
904 # `PENDING`, `RUNNING`, or `DONE`.
905 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
906 # operation.
907 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
908 # of the target resource.
909 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
910 # operations related to creating a snapshot, this points to the disk
911 # that the snapshot was created from.
912 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
913 # `[email protected]` or
914 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
915 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
916 # operation, this field will be populated.
917 {
918 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
919 # Engine returns NO_RESULTS_ON_PAGE if there
920 # are no results in the response.
921 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
922 # value format. For example:
923 #
924 # &quot;data&quot;: [
925 # {
926 # &quot;key&quot;: &quot;scope&quot;,
927 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
928 # }
929 {
930 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
931 # returned. For example, for warnings where there are no results in a list
932 # request for a particular zone, this key might be scope and
933 # the key value might be the zone name. Other examples might be a key
934 # indicating a deprecated resource and a suggested replacement, or a
935 # warning about invalid network settings (for example, if an instance
936 # attempts to perform IP forwarding but is not enabled for IP forwarding).
937 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
938 },
939 ],
940 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
941 },
942 ],
943 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
944 # applicable when performing per-zone operations.
945 }</pre>
946 </div>
947
948 <div class="method">
949 <code class="details" id="addRule">addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</code>
950 <pre>Inserts a rule into a firewall policy.
951
952 Args:
953 project: string, Project ID for this request. (required)
954 firewallPolicy: string, Name of the firewall policy to update. (required)
955 body: object, The request body.
956 The object takes the form of:
957
958 { # Represents a rule that describes one or more match conditions along with
959 # the action to be taken when traffic matches this condition (allow or deny).
960 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
961 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
962 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
963 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
964 # and &quot;goto_next&quot;.
965 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
966 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
967 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
968 # the firewall policy rule is not enforced and traffic behaves as if it did
969 # not exist. If this is unspecified, the firewall policy rule will be
970 # enabled.
971 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
972 # enabled, logs will be exported to the configured export destination in
973 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
974 # cannot enable logging on &quot;goto_next&quot; rules.
975 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
976 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
977 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
978 # Exactly one field must be specified.
979 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
980 # Maximum number of destination address groups is 10.
981 &quot;A String&quot;,
982 ],
983 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
984 # traffic destination.
985 # Maximum number of destination fqdn allowed is 100.
986 &quot;A String&quot;,
987 ],
988 &quot;destIpRanges&quot;: [ # CIDR IP address range.
989 # Maximum number of destination CIDR IP ranges allowed is 5000.
990 &quot;A String&quot;,
991 ],
992 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
993 #
994 #
995 # - UNSPECIFIED
996 # - INTERNET
997 # - NON_INTERNET
998 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
999 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
1000 #
1001 #
1002 # - UNSPECIFIED
1003 # - INTERNET
1004 # - NON_INTERNET
1005 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
1006 # of traffic. Should be specified as 2 letter country code defined as per
1007 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1008 # Maximum number of dest region codes allowed is 5000.
1009 &quot;A String&quot;,
1010 ],
1011 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1012 # The IPs in these lists will be matched against traffic destination.
1013 &quot;A String&quot;,
1014 ],
1015 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1016 {
1017 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1018 # required when creating a firewall rule. This value can either be
1019 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1020 # protocol number.
1021 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1022 # only applicable for UDP or TCP protocol. Each entry must be either
1023 # an integer or a range. If not specified, this rule applies to
1024 # connections through any port.
1025 #
1026 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1027 &quot;A String&quot;,
1028 ],
1029 },
1030 ],
1031 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1032 # Maximum number of source address groups is 10.
1033 &quot;A String&quot;,
1034 ],
1035 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1036 # traffic source.
1037 # Maximum number of source fqdn allowed is 100.
1038 &quot;A String&quot;,
1039 ],
1040 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1041 # Maximum number of source CIDR IP ranges allowed is 5000.
1042 &quot;A String&quot;,
1043 ],
1044 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1045 #
1046 #
1047 # - UNSPECIFIED
1048 # - INTERNET
1049 # - INTRA_VPC
1050 # - NON_INTERNET
1051 # - VPC_NETWORKS
1052 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1053 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1054 #
1055 #
1056 # - UNSPECIFIED
1057 # - INTERNET
1058 # - INTRA_VPC
1059 # - NON_INTERNET
1060 # - VPC_NETWORKS
1061 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1062 &quot;A String&quot;,
1063 ],
1064 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1065 # of traffic. Should be specified as 2 letter country code defined as per
1066 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1067 # Maximum number of source region codes allowed is 5000.
1068 &quot;A String&quot;,
1069 ],
1070 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1071 # of the traffic.
1072 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1073 # and there is no srcIpRange, this rule will be ignored.
1074 # Maximum number of source tag values allowed is 256.
1075 {
1076 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1077 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1078 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1079 # or its network is deleted.
1080 },
1081 ],
1082 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1083 # The IPs in these lists will be matched against traffic source.
1084 &quot;A String&quot;,
1085 ],
1086 },
1087 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1088 # must be a positive value between 0 and 2147483647.
1089 # Rules are evaluated from highest to lowest priority where 0 is the
1090 # highest priority and 2147483647 is the lowest priority.
1091 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1092 # and can be updated.
1093 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1094 # rule.
1095 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1096 # Example:
1097 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1098 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1099 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1100 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
1101 # This field allows you to control which load balancers get this rule.
1102 # For example, the following are valid values:
1103 #
1104 #
1105 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
1106 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1107 # - projects/project/global/
1108 # forwardingRules/forwardingRule
1109 # - projects/project/regions/region/forwardingRules/
1110 # forwardingRule
1111 &quot;A String&quot;,
1112 ],
1113 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
1114 # allows you to control which network&#x27;s VMs get this rule. If this field
1115 # is left blank, all VMs within the organization will receive the rule.
1116 &quot;A String&quot;,
1117 ],
1118 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
1119 # applies to. If targetSecureTag are specified, then the
1120 # firewall rule applies only to instances in the VPC network that have one
1121 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
1122 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
1123 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
1124 # to all instances on the specified network.
1125 # Maximum number of target label tags allowed is 256.
1126 {
1127 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1128 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1129 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1130 # or its network is deleted.
1131 },
1132 ],
1133 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
1134 # applied with this rule.
1135 &quot;A String&quot;,
1136 ],
1137 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
1138 # Default value is INSTANCES.
1139 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
1140 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
1141 # be set for other actions.
1142 }
1143
1144 maxPriority: integer, When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority&gt;.
1145 This field is exclusive with rule.priority.
1146 minPriority: integer, When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority&gt;.
1147 This field is exclusive with rule.priority.
1148 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1149 that if you must retry your request, the server will know to ignore the
1150 request if it has already been completed.
1151
1152 For example, consider a situation where you make an initial request and
1153 the request times out. If you make the request again with the same
1154 request ID, the server can check if original operation with the same
1155 request ID was received, and if so, will ignore the second request. This
1156 prevents clients from accidentally creating duplicate commitments.
1157
1158 The request ID must be
1159 a valid UUID with the exception that zero UUID is not supported
1160 (00000000-0000-0000-0000-000000000000).
1161 x__xgafv: string, V1 error format.
1162 Allowed values
1163 1 - v1 error format
1164 2 - v2 error format
1165
1166 Returns:
1167 An object of the form:
1168
1169 { # Represents an Operation resource.
1170 #
1171 # Google Compute Engine has three Operation resources:
1172 #
1173 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1174 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1175 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1176 #
1177 # You can use an operation resource to manage asynchronous API requests.
1178 # For more information, readHandling
1179 # API responses.
1180 #
1181 # Operations can be global, regional or zonal.
1182 #
1183 # - For global operations, use the `globalOperations`
1184 # resource.
1185 # - For regional operations, use the
1186 # `regionOperations` resource.
1187 # - For zonal operations, use
1188 # the `zoneOperations` resource.
1189 #
1190 #
1191 #
1192 # For more information, read
1193 # Global, Regional, and Zonal Resources.
1194 #
1195 # Note that completed Operation resources have a limited
1196 # retention period.
1197 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1198 # Not present otherwise.
1199 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1200 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1201 # set when the operation is created.
1202 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1203 # text format.
1204 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1205 # this field will be populated.
1206 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1207 # operation.
1208 {
1209 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1210 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1211 # details. There is a set of defined message types to use for providing
1212 # details.The syntax depends on the error code. For example,
1213 # QuotaExceededInfo will have details when the error code is
1214 # QUOTA_EXCEEDED.
1215 {
1216 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1217 #
1218 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1219 # is not enabled:
1220 #
1221 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1222 # &quot;domain&quot;: &quot;googleapis.com&quot;
1223 # &quot;metadata&quot;: {
1224 # &quot;resource&quot;: &quot;projects/123&quot;,
1225 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1226 # }
1227 # }
1228 #
1229 # This response indicates that the pubsub.googleapis.com API is not enabled.
1230 #
1231 # Example of an error that is returned when attempting to create a Spanner
1232 # instance in a region that is out of stock:
1233 #
1234 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1235 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1236 # &quot;metadata&quot;: {
1237 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1238 # }
1239 # }
1240 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1241 # is typically the registered service name of the tool or product that
1242 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1243 # generated by some common infrastructure, the error domain must be a
1244 # globally unique value that identifies the infrastructure. For Google API
1245 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1246 &quot;metadatas&quot;: { # Additional structured details about this error.
1247 #
1248 # Keys must match a regular expression of `a-z+` but should
1249 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1250 # length. When identifying the current value of an exceeded limit, the units
1251 # should be contained in the key, not the value. For example, rather than
1252 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1253 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1254 # instances that can be created in a single (batch) request.
1255 &quot;a_key&quot;: &quot;A String&quot;,
1256 },
1257 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1258 # proximate cause of the error. Error reasons are unique within a particular
1259 # domain of errors. This should be at most 63 characters and match a
1260 # regular expression of `A-Z+[A-Z0-9]`, which represents
1261 # UPPER_SNAKE_CASE.
1262 },
1263 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1264 #
1265 # For example, if a quota check failed with an error indicating the calling
1266 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1267 # directly to the right place in the developer console to flip the bit.
1268 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1269 { # Describes a URL link.
1270 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1271 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1272 },
1273 ],
1274 },
1275 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1276 # which can be attached to an RPC error.
1277 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1278 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1279 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1280 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1281 },
1282 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1283 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1284 &quot;a_key&quot;: &quot;A String&quot;,
1285 },
1286 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1287 # type or metric.
1288 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1289 # or metric.
1290 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1291 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1292 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1293 },
1294 },
1295 ],
1296 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1297 # This property is optional.
1298 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1299 },
1300 ],
1301 },
1302 &quot;getVersionOperationMetadata&quot;: {
1303 &quot;inlineSbomInfo&quot;: {
1304 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1305 # appropriate identifiers.
1306 &quot;a_key&quot;: &quot;A String&quot;,
1307 },
1308 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1309 # identifiers.
1310 &quot;a_key&quot;: &quot;A String&quot;,
1311 },
1312 },
1313 },
1314 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1315 # message that was returned, such as `NOT FOUND`.
1316 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1317 # status code that was returned. For example, a `404` means the
1318 # resource was not found.
1319 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1320 # defined by the server.
1321 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1322 # This value is inRFC3339
1323 # text format.
1324 &quot;instancesBulkInsertOperationMetadata&quot;: {
1325 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1326 # Example key: zones/us-central1-a
1327 &quot;a_key&quot;: {
1328 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1329 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1330 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1331 # error.
1332 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1333 # if the flow is rolling forward or rolling back.
1334 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1335 },
1336 },
1337 },
1338 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1339 # Operation resources.
1340 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1341 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1342 # group of operations results from a `bulkInsert` API request.
1343 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1344 # `update`, or `delete`, and so on.
1345 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1346 # There is no requirement that this be linear or support any granularity of
1347 # operations. This should not be used to guess when the operation will be
1348 # complete. This number should monotonically increase as the operation
1349 # progresses.
1350 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1351 # applicable when performing regional operations.
1352 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1353 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1354 # this field will contain information on all underlying zonal actions and
1355 # their state.
1356 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1357 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1358 # Example key: zones/us-central1-a
1359 &quot;a_key&quot;: {
1360 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
1361 # populated.
1362 # different programming environments, including REST APIs and RPC APIs. It is
1363 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1364 # three pieces of data: error code, error message, and error details.
1365 #
1366 # You can find out more about this error model and how to work with it in the
1367 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1368 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1369 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1370 # message types for APIs to use.
1371 {
1372 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1373 },
1374 ],
1375 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1376 # user-facing error message should be localized and sent in the
1377 # google.rpc.Status.details field, or localized by the client.
1378 },
1379 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1380 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1381 },
1382 },
1383 },
1384 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1385 # This value is inRFC3339
1386 # text format.
1387 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1388 # following:
1389 # `PENDING`, `RUNNING`, or `DONE`.
1390 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1391 # operation.
1392 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1393 # of the target resource.
1394 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1395 # operations related to creating a snapshot, this points to the disk
1396 # that the snapshot was created from.
1397 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1398 # `[email protected]` or
1399 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1400 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1401 # operation, this field will be populated.
1402 {
1403 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1404 # Engine returns NO_RESULTS_ON_PAGE if there
1405 # are no results in the response.
1406 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1407 # value format. For example:
1408 #
1409 # &quot;data&quot;: [
1410 # {
1411 # &quot;key&quot;: &quot;scope&quot;,
1412 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1413 # }
1414 {
1415 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1416 # returned. For example, for warnings where there are no results in a list
1417 # request for a particular zone, this key might be scope and
1418 # the key value might be the zone name. Other examples might be a key
1419 # indicating a deprecated resource and a suggested replacement, or a
1420 # warning about invalid network settings (for example, if an instance
1421 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1422 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1423 },
1424 ],
1425 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1426 },
1427 ],
1428 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1429 # applicable when performing per-zone operations.
1430 }</pre>
1431 </div>
1432
1433 <div class="method">
1434 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
1435 <pre>Retrieves an aggregated list of network firewall policies, listing network
1436 firewall policies from all applicable scopes (global and regional) and
1437 grouping the results per scope.
1438
1439 To prevent failure, it is recommended that you set the
1440 `returnPartialSuccess` parameter to `true`.
1441
1442 Args:
1443 project: string, Project ID for this request. (required)
1444 filter: string, A filter expression that filters resources listed in the response. Most
1445 Compute resources support two types of filter expressions:
1446 expressions that support regular expressions and expressions that follow
1447 API improvement proposal AIP-160.
1448 These two types of filter expressions cannot be mixed in one request.
1449
1450 If you want to use AIP-160, your expression must specify the field name, an
1451 operator, and the value that you want to use for filtering. The value
1452 must be a string, a number, or a boolean. The operator
1453 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1454
1455 For example, if you are filtering Compute Engine instances, you can
1456 exclude instances named `example-instance` by specifying
1457 `name != example-instance`.
1458
1459 The `:*` comparison can be used to test whether a key has been defined.
1460 For example, to find all objects with `owner` label use:
1461 ```
1462 labels.owner:*
1463 ```
1464
1465 You can also filter nested fields. For example, you could specify
1466 `scheduling.automaticRestart = false` to include instances only
1467 if they are not scheduled for automatic restarts. You can use filtering
1468 on nested fields to filter based onresource labels.
1469
1470 To filter on multiple expressions, provide each separate expression within
1471 parentheses. For example:
1472 ```
1473 (scheduling.automaticRestart = true)
1474 (cpuPlatform = &quot;Intel Skylake&quot;)
1475 ```
1476 By default, each expression is an `AND` expression. However, you
1477 can include `AND` and `OR` expressions explicitly.
1478 For example:
1479 ```
1480 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1481 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1482 (scheduling.automaticRestart = true)
1483 ```
1484
1485 If you want to use a regular expression, use the `eq` (equal) or `ne`
1486 (not equal) operator against a single un-parenthesized expression with or
1487 without quotes or against multiple parenthesized expressions. Examples:
1488
1489 `fieldname eq unquoted literal`
1490 `fieldname eq &#x27;single quoted literal&#x27;`
1491 `fieldname eq &quot;double quoted literal&quot;`
1492 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1493
1494 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1495 The literal value must match the entire field.
1496
1497 For example, to filter for instances that do not end with name &quot;instance&quot;,
1498 you would use `name ne .*instance`.
1499
1500 You cannot combine constraints on multiple fields using regular
1501 expressions.
1502 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
1503 global) should be included in the response. For new resource types added
1504 after this field, the flag has no effect as new resource types will always
1505 include every visible scope for each scope type in response. For resource
1506 types which predate this field, if this flag is omitted or false, only
1507 scopes of the scope types where the resource type is expected to be found
1508 will be included.
1509 maxResults: integer, The maximum number of results per page that should be returned.
1510 If the number of available results is larger than `maxResults`,
1511 Compute Engine returns a `nextPageToken` that can be used to get
1512 the next page of results in subsequent list requests. Acceptable values are
1513 `0` to `500`, inclusive. (Default: `500`)
1514 orderBy: string, Sorts list results by a certain order. By default, results
1515 are returned in alphanumerical order based on the resource name.
1516
1517 You can also sort results in descending order based on the creation
1518 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1519 results based on the `creationTimestamp` field in
1520 reverse chronological order (newest result first). Use this to sort
1521 resources like operations so that the newest operation is returned first.
1522
1523 Currently, only sorting by `name` or
1524 `creationTimestamp desc` is supported.
1525 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1526 `nextPageToken` returned by a previous list request to get
1527 the next page of results.
1528 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1529 of failure. The default value is false.
1530
1531 For example, when partial success behavior is enabled, aggregatedList for a
1532 single zone scope either returns all resources in the zone or no resources,
1533 with an error code.
1534 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
1535 aggregated list request is invoked for subnetworks list-usable api.
1536 x__xgafv: string, V1 error format.
1537 Allowed values
1538 1 - v1 error format
1539 2 - v2 error format
1540
1541 Returns:
1542 An object of the form:
1543
1544 {
1545 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1546 &quot;items&quot;: { # A list of FirewallPoliciesScopedList resources.
1547 &quot;a_key&quot;: { # Name of the scope containing this set of addresses.
1548 &quot;firewallPolicies&quot;: [ # A list of firewall policies contained in this scope.
1549 { # Represents a Firewall Policy resource.
1550 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
1551 {
1552 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
1553 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
1554 # of the firewall policy of the association.
1555 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
1556 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
1557 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
1558 # must be a positive value between 1 and 2147483647.
1559 # Firewall Policies are evaluated from highest to lowest priority where 1
1560 # is the highest priority and 2147483647 is the lowest priority.
1561 # The default value is `1000`. If two associations have the same priority
1562 # then lexicographical order on association names is applied.
1563 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
1564 },
1565 ],
1566 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1567 # text format.
1568 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1569 # create the resource.
1570 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
1571 # Organization firewall policy. The name should be unique in the organization
1572 # in which the firewall policy is created.
1573 # This field is not applicable to network firewall policies.
1574 # This name must be set on creation and cannot be changed.
1575 # The name must be 1-63 characters long, and comply
1576 # with RFC1035. Specifically, the name must be 1-63 characters
1577 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
1578 # means the first character must be a lowercase letter, and all following
1579 # characters must be a dash, lowercase letter, or digit, except the last
1580 # character, which cannot be a dash.
1581 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
1582 # the metadata&#x27;s contents and used for optimistic locking. The
1583 # fingerprint is initially generated by Compute Engine and changes after
1584 # every request to modify or update metadata. You must always provide an
1585 # up-to-date fingerprint hash in order to update or change metadata,
1586 # otherwise the request will fail with error412 conditionNotMet.
1587 #
1588 # To see the latest fingerprint, make get() request to the
1589 # firewall policy.
1590 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1591 # defined by the server.
1592 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
1593 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
1594 # [Output Only] numeric ID allocated by Google Cloud which uniquely
1595 # identifies the Organization Firewall Policy.
1596 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
1597 { # Represents a rule that describes one or more match conditions along with
1598 # the action to be taken when traffic matches this condition (allow or deny).
1599 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
1600 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
1601 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
1602 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
1603 # and &quot;goto_next&quot;.
1604 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
1605 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
1606 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
1607 # the firewall policy rule is not enforced and traffic behaves as if it did
1608 # not exist. If this is unspecified, the firewall policy rule will be
1609 # enabled.
1610 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
1611 # enabled, logs will be exported to the configured export destination in
1612 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
1613 # cannot enable logging on &quot;goto_next&quot; rules.
1614 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
1615 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
1616 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
1617 # Exactly one field must be specified.
1618 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
1619 # Maximum number of destination address groups is 10.
1620 &quot;A String&quot;,
1621 ],
1622 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1623 # traffic destination.
1624 # Maximum number of destination fqdn allowed is 100.
1625 &quot;A String&quot;,
1626 ],
1627 &quot;destIpRanges&quot;: [ # CIDR IP address range.
1628 # Maximum number of destination CIDR IP ranges allowed is 5000.
1629 &quot;A String&quot;,
1630 ],
1631 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
1632 #
1633 #
1634 # - UNSPECIFIED
1635 # - INTERNET
1636 # - NON_INTERNET
1637 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
1638 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
1639 #
1640 #
1641 # - UNSPECIFIED
1642 # - INTERNET
1643 # - NON_INTERNET
1644 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
1645 # of traffic. Should be specified as 2 letter country code defined as per
1646 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1647 # Maximum number of dest region codes allowed is 5000.
1648 &quot;A String&quot;,
1649 ],
1650 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1651 # The IPs in these lists will be matched against traffic destination.
1652 &quot;A String&quot;,
1653 ],
1654 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1655 {
1656 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1657 # required when creating a firewall rule. This value can either be
1658 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1659 # protocol number.
1660 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1661 # only applicable for UDP or TCP protocol. Each entry must be either
1662 # an integer or a range. If not specified, this rule applies to
1663 # connections through any port.
1664 #
1665 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1666 &quot;A String&quot;,
1667 ],
1668 },
1669 ],
1670 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1671 # Maximum number of source address groups is 10.
1672 &quot;A String&quot;,
1673 ],
1674 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1675 # traffic source.
1676 # Maximum number of source fqdn allowed is 100.
1677 &quot;A String&quot;,
1678 ],
1679 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1680 # Maximum number of source CIDR IP ranges allowed is 5000.
1681 &quot;A String&quot;,
1682 ],
1683 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1684 #
1685 #
1686 # - UNSPECIFIED
1687 # - INTERNET
1688 # - INTRA_VPC
1689 # - NON_INTERNET
1690 # - VPC_NETWORKS
1691 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1692 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1693 #
1694 #
1695 # - UNSPECIFIED
1696 # - INTERNET
1697 # - INTRA_VPC
1698 # - NON_INTERNET
1699 # - VPC_NETWORKS
1700 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1701 &quot;A String&quot;,
1702 ],
1703 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1704 # of traffic. Should be specified as 2 letter country code defined as per
1705 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1706 # Maximum number of source region codes allowed is 5000.
1707 &quot;A String&quot;,
1708 ],
1709 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1710 # of the traffic.
1711 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1712 # and there is no srcIpRange, this rule will be ignored.
1713 # Maximum number of source tag values allowed is 256.
1714 {
1715 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1716 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1717 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1718 # or its network is deleted.
1719 },
1720 ],
1721 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1722 # The IPs in these lists will be matched against traffic source.
1723 &quot;A String&quot;,
1724 ],
1725 },
1726 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1727 # must be a positive value between 0 and 2147483647.
1728 # Rules are evaluated from highest to lowest priority where 0 is the
1729 # highest priority and 2147483647 is the lowest priority.
1730 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1731 # and can be updated.
1732 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1733 # rule.
1734 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1735 # Example:
1736 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1737 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1738 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1739 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
1740 # This field allows you to control which load balancers get this rule.
1741 # For example, the following are valid values:
1742 #
1743 #
1744 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
1745 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1746 # - projects/project/global/
1747 # forwardingRules/forwardingRule
1748 # - projects/project/regions/region/forwardingRules/
1749 # forwardingRule
1750 &quot;A String&quot;,
1751 ],
1752 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
1753 # allows you to control which network&#x27;s VMs get this rule. If this field
1754 # is left blank, all VMs within the organization will receive the rule.
1755 &quot;A String&quot;,
1756 ],
1757 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
1758 # applies to. If targetSecureTag are specified, then the
1759 # firewall rule applies only to instances in the VPC network that have one
1760 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
1761 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
1762 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
1763 # to all instances on the specified network.
1764 # Maximum number of target label tags allowed is 256.
1765 {
1766 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1767 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1768 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1769 # or its network is deleted.
1770 },
1771 ],
1772 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
1773 # applied with this rule.
1774 &quot;A String&quot;,
1775 ],
1776 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
1777 # Default value is INSTANCES.
1778 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
1779 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
1780 # be set for other actions.
1781 },
1782 ],
1783 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
1784 # This field is not applicable to network firewall policies.
1785 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
1786 # creation and defaults to USER_DEFINED.
1787 #
1788 # The USER_DEFINED value indicates a regular firewall policy.
1789 #
1790 # The SYSTEM value indicates a system-level policy managed by an
1791 # internal service like GKE. This SYSTEM value is reserved for
1792 # internal services and cannot be set by users during policy creation.
1793 # Policies with a SYSTEM source cannot be modified or deleted by
1794 # users.
1795 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
1796 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
1797 #
1798 # Note: if not specified then VPC_POLICY will be used.
1799 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
1800 # This field is not applicable to global firewall policies.
1801 # You must specify this field as part of the HTTP request URL. It is
1802 # not settable as a field in the request body.
1803 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
1804 # policy can not exceed a set number of tuples.
1805 &quot;rules&quot;: [ # A list of rules that belong to this policy.
1806 # There must always be a default rule (rule with priority 2147483647 and
1807 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
1808 # default rule with action &quot;allow&quot; will be added.
1809 { # Represents a rule that describes one or more match conditions along with
1810 # the action to be taken when traffic matches this condition (allow or deny).
1811 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
1812 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
1813 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
1814 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
1815 # and &quot;goto_next&quot;.
1816 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
1817 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
1818 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
1819 # the firewall policy rule is not enforced and traffic behaves as if it did
1820 # not exist. If this is unspecified, the firewall policy rule will be
1821 # enabled.
1822 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
1823 # enabled, logs will be exported to the configured export destination in
1824 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
1825 # cannot enable logging on &quot;goto_next&quot; rules.
1826 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
1827 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
1828 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
1829 # Exactly one field must be specified.
1830 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
1831 # Maximum number of destination address groups is 10.
1832 &quot;A String&quot;,
1833 ],
1834 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1835 # traffic destination.
1836 # Maximum number of destination fqdn allowed is 100.
1837 &quot;A String&quot;,
1838 ],
1839 &quot;destIpRanges&quot;: [ # CIDR IP address range.
1840 # Maximum number of destination CIDR IP ranges allowed is 5000.
1841 &quot;A String&quot;,
1842 ],
1843 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
1844 #
1845 #
1846 # - UNSPECIFIED
1847 # - INTERNET
1848 # - NON_INTERNET
1849 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
1850 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
1851 #
1852 #
1853 # - UNSPECIFIED
1854 # - INTERNET
1855 # - NON_INTERNET
1856 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
1857 # of traffic. Should be specified as 2 letter country code defined as per
1858 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1859 # Maximum number of dest region codes allowed is 5000.
1860 &quot;A String&quot;,
1861 ],
1862 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1863 # The IPs in these lists will be matched against traffic destination.
1864 &quot;A String&quot;,
1865 ],
1866 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1867 {
1868 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1869 # required when creating a firewall rule. This value can either be
1870 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1871 # protocol number.
1872 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1873 # only applicable for UDP or TCP protocol. Each entry must be either
1874 # an integer or a range. If not specified, this rule applies to
1875 # connections through any port.
1876 #
1877 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1878 &quot;A String&quot;,
1879 ],
1880 },
1881 ],
1882 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1883 # Maximum number of source address groups is 10.
1884 &quot;A String&quot;,
1885 ],
1886 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1887 # traffic source.
1888 # Maximum number of source fqdn allowed is 100.
1889 &quot;A String&quot;,
1890 ],
1891 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1892 # Maximum number of source CIDR IP ranges allowed is 5000.
1893 &quot;A String&quot;,
1894 ],
1895 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1896 #
1897 #
1898 # - UNSPECIFIED
1899 # - INTERNET
1900 # - INTRA_VPC
1901 # - NON_INTERNET
1902 # - VPC_NETWORKS
1903 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1904 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1905 #
1906 #
1907 # - UNSPECIFIED
1908 # - INTERNET
1909 # - INTRA_VPC
1910 # - NON_INTERNET
1911 # - VPC_NETWORKS
1912 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1913 &quot;A String&quot;,
1914 ],
1915 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1916 # of traffic. Should be specified as 2 letter country code defined as per
1917 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1918 # Maximum number of source region codes allowed is 5000.
1919 &quot;A String&quot;,
1920 ],
1921 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1922 # of the traffic.
1923 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1924 # and there is no srcIpRange, this rule will be ignored.
1925 # Maximum number of source tag values allowed is 256.
1926 {
1927 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1928 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1929 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1930 # or its network is deleted.
1931 },
1932 ],
1933 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1934 # The IPs in these lists will be matched against traffic source.
1935 &quot;A String&quot;,
1936 ],
1937 },
1938 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1939 # must be a positive value between 0 and 2147483647.
1940 # Rules are evaluated from highest to lowest priority where 0 is the
1941 # highest priority and 2147483647 is the lowest priority.
1942 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1943 # and can be updated.
1944 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1945 # rule.
1946 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1947 # Example:
1948 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1949 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1950 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1951 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
1952 # This field allows you to control which load balancers get this rule.
1953 # For example, the following are valid values:
1954 #
1955 #
1956 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
1957 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1958 # - projects/project/global/
1959 # forwardingRules/forwardingRule
1960 # - projects/project/regions/region/forwardingRules/
1961 # forwardingRule
1962 &quot;A String&quot;,
1963 ],
1964 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
1965 # allows you to control which network&#x27;s VMs get this rule. If this field
1966 # is left blank, all VMs within the organization will receive the rule.
1967 &quot;A String&quot;,
1968 ],
1969 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
1970 # applies to. If targetSecureTag are specified, then the
1971 # firewall rule applies only to instances in the VPC network that have one
1972 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
1973 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
1974 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
1975 # to all instances on the specified network.
1976 # Maximum number of target label tags allowed is 256.
1977 {
1978 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1979 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1980 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1981 # or its network is deleted.
1982 },
1983 ],
1984 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
1985 # applied with this rule.
1986 &quot;A String&quot;,
1987 ],
1988 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
1989 # Default value is INSTANCES.
1990 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
1991 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
1992 # be set for other actions.
1993 },
1994 ],
1995 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1996 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1997 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
1998 # unique in the organization in which the firewall policy is created.
1999 # This field is not applicable to network firewall policies.
2000 # This name must be set on creation and cannot be changed. The name must be
2001 # 1-63 characters long, and comply with RFC1035.
2002 # Specifically, the name must be 1-63 characters long and match the regular
2003 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2004 # character must be a lowercase letter, and all following characters must
2005 # be a dash, lowercase letter, or digit, except the last character, which
2006 # cannot be a dash.
2007 },
2008 ],
2009 &quot;warning&quot;: { # Informational warning which replaces the list of firewall policies when
2010 # the list is empty.
2011 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2012 # Engine returns NO_RESULTS_ON_PAGE if there
2013 # are no results in the response.
2014 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2015 # value format. For example:
2016 #
2017 # &quot;data&quot;: [
2018 # {
2019 # &quot;key&quot;: &quot;scope&quot;,
2020 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2021 # }
2022 {
2023 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2024 # returned. For example, for warnings where there are no results in a list
2025 # request for a particular zone, this key might be scope and
2026 # the key value might be the zone name. Other examples might be a key
2027 # indicating a deprecated resource and a suggested replacement, or a
2028 # warning about invalid network settings (for example, if an instance
2029 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2030 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2031 },
2032 ],
2033 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2034 },
2035 },
2036 },
2037 &quot;kind&quot;: &quot;compute#networkFirewallPolicyAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#networkFirewallPoliciesAggregatedList for lists of
2038 # network firewall policies.
2039 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2040 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2041 # the query parameter pageToken in the next list request.
2042 # Subsequent list requests will have their own nextPageToken to
2043 # continue paging through the results.
2044 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2045 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
2046 &quot;A String&quot;,
2047 ],
2048 &quot;warning&quot;: { # [Output Only] Informational warning message.
2049 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2050 # Engine returns NO_RESULTS_ON_PAGE if there
2051 # are no results in the response.
2052 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2053 # value format. For example:
2054 #
2055 # &quot;data&quot;: [
2056 # {
2057 # &quot;key&quot;: &quot;scope&quot;,
2058 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2059 # }
2060 {
2061 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2062 # returned. For example, for warnings where there are no results in a list
2063 # request for a particular zone, this key might be scope and
2064 # the key value might be the zone name. Other examples might be a key
2065 # indicating a deprecated resource and a suggested replacement, or a
2066 # warning about invalid network settings (for example, if an instance
2067 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2068 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2069 },
2070 ],
2071 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2072 },
2073 }</pre>
2074 </div>
2075
2076 <div class="method">
2077 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
2078 <pre>Retrieves the next page of results.
2079
2080 Args:
2081 previous_request: The request for the previous page. (required)
2082 previous_response: The response from the request for the previous page. (required)
2083
2084 Returns:
2085 A request object that you can call &#x27;execute()&#x27; on to request the next
2086 page. Returns None if there are no more items in the collection.
2087 </pre>
2088 </div>
2089
2090 <div class="method">
2091 <code class="details" id="cloneRules">cloneRules(project, firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</code>
2092 <pre>Copies rules to the specified firewall policy.
2093
2094 Args:
2095 project: string, Project ID for this request. (required)
2096 firewallPolicy: string, Name of the firewall policy to update. (required)
2097 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2098 that if you must retry your request, the server will know to ignore the
2099 request if it has already been completed.
2100
2101 For example, consider a situation where you make an initial request and
2102 the request times out. If you make the request again with the same
2103 request ID, the server can check if original operation with the same
2104 request ID was received, and if so, will ignore the second request. This
2105 prevents clients from accidentally creating duplicate commitments.
2106
2107 The request ID must be
2108 a valid UUID with the exception that zero UUID is not supported
2109 (00000000-0000-0000-0000-000000000000).
2110 sourceFirewallPolicy: string, The firewall policy from which to copy rules.
2111 x__xgafv: string, V1 error format.
2112 Allowed values
2113 1 - v1 error format
2114 2 - v2 error format
2115
2116 Returns:
2117 An object of the form:
2118
2119 { # Represents an Operation resource.
2120 #
2121 # Google Compute Engine has three Operation resources:
2122 #
2123 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2124 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2125 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2126 #
2127 # You can use an operation resource to manage asynchronous API requests.
2128 # For more information, readHandling
2129 # API responses.
2130 #
2131 # Operations can be global, regional or zonal.
2132 #
2133 # - For global operations, use the `globalOperations`
2134 # resource.
2135 # - For regional operations, use the
2136 # `regionOperations` resource.
2137 # - For zonal operations, use
2138 # the `zoneOperations` resource.
2139 #
2140 #
2141 #
2142 # For more information, read
2143 # Global, Regional, and Zonal Resources.
2144 #
2145 # Note that completed Operation resources have a limited
2146 # retention period.
2147 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2148 # Not present otherwise.
2149 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2150 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2151 # set when the operation is created.
2152 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2153 # text format.
2154 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2155 # this field will be populated.
2156 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2157 # operation.
2158 {
2159 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2160 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2161 # details. There is a set of defined message types to use for providing
2162 # details.The syntax depends on the error code. For example,
2163 # QuotaExceededInfo will have details when the error code is
2164 # QUOTA_EXCEEDED.
2165 {
2166 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2167 #
2168 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2169 # is not enabled:
2170 #
2171 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2172 # &quot;domain&quot;: &quot;googleapis.com&quot;
2173 # &quot;metadata&quot;: {
2174 # &quot;resource&quot;: &quot;projects/123&quot;,
2175 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2176 # }
2177 # }
2178 #
2179 # This response indicates that the pubsub.googleapis.com API is not enabled.
2180 #
2181 # Example of an error that is returned when attempting to create a Spanner
2182 # instance in a region that is out of stock:
2183 #
2184 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2185 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2186 # &quot;metadata&quot;: {
2187 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2188 # }
2189 # }
2190 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2191 # is typically the registered service name of the tool or product that
2192 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2193 # generated by some common infrastructure, the error domain must be a
2194 # globally unique value that identifies the infrastructure. For Google API
2195 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2196 &quot;metadatas&quot;: { # Additional structured details about this error.
2197 #
2198 # Keys must match a regular expression of `a-z+` but should
2199 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2200 # length. When identifying the current value of an exceeded limit, the units
2201 # should be contained in the key, not the value. For example, rather than
2202 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2203 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2204 # instances that can be created in a single (batch) request.
2205 &quot;a_key&quot;: &quot;A String&quot;,
2206 },
2207 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2208 # proximate cause of the error. Error reasons are unique within a particular
2209 # domain of errors. This should be at most 63 characters and match a
2210 # regular expression of `A-Z+[A-Z0-9]`, which represents
2211 # UPPER_SNAKE_CASE.
2212 },
2213 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2214 #
2215 # For example, if a quota check failed with an error indicating the calling
2216 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2217 # directly to the right place in the developer console to flip the bit.
2218 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2219 { # Describes a URL link.
2220 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2221 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2222 },
2223 ],
2224 },
2225 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2226 # which can be attached to an RPC error.
2227 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2228 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2229 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2230 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2231 },
2232 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2233 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2234 &quot;a_key&quot;: &quot;A String&quot;,
2235 },
2236 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2237 # type or metric.
2238 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2239 # or metric.
2240 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2241 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2242 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2243 },
2244 },
2245 ],
2246 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2247 # This property is optional.
2248 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2249 },
2250 ],
2251 },
2252 &quot;getVersionOperationMetadata&quot;: {
2253 &quot;inlineSbomInfo&quot;: {
2254 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2255 # appropriate identifiers.
2256 &quot;a_key&quot;: &quot;A String&quot;,
2257 },
2258 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2259 # identifiers.
2260 &quot;a_key&quot;: &quot;A String&quot;,
2261 },
2262 },
2263 },
2264 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2265 # message that was returned, such as `NOT FOUND`.
2266 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2267 # status code that was returned. For example, a `404` means the
2268 # resource was not found.
2269 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2270 # defined by the server.
2271 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2272 # This value is inRFC3339
2273 # text format.
2274 &quot;instancesBulkInsertOperationMetadata&quot;: {
2275 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2276 # Example key: zones/us-central1-a
2277 &quot;a_key&quot;: {
2278 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2279 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2280 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2281 # error.
2282 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2283 # if the flow is rolling forward or rolling back.
2284 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2285 },
2286 },
2287 },
2288 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2289 # Operation resources.
2290 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2291 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2292 # group of operations results from a `bulkInsert` API request.
2293 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2294 # `update`, or `delete`, and so on.
2295 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2296 # There is no requirement that this be linear or support any granularity of
2297 # operations. This should not be used to guess when the operation will be
2298 # complete. This number should monotonically increase as the operation
2299 # progresses.
2300 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2301 # applicable when performing regional operations.
2302 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2303 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2304 # this field will contain information on all underlying zonal actions and
2305 # their state.
2306 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2307 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2308 # Example key: zones/us-central1-a
2309 &quot;a_key&quot;: {
2310 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
2311 # populated.
2312 # different programming environments, including REST APIs and RPC APIs. It is
2313 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2314 # three pieces of data: error code, error message, and error details.
2315 #
2316 # You can find out more about this error model and how to work with it in the
2317 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2318 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2319 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2320 # message types for APIs to use.
2321 {
2322 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2323 },
2324 ],
2325 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2326 # user-facing error message should be localized and sent in the
2327 # google.rpc.Status.details field, or localized by the client.
2328 },
2329 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2330 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2331 },
2332 },
2333 },
2334 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2335 # This value is inRFC3339
2336 # text format.
2337 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2338 # following:
2339 # `PENDING`, `RUNNING`, or `DONE`.
2340 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2341 # operation.
2342 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2343 # of the target resource.
2344 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2345 # operations related to creating a snapshot, this points to the disk
2346 # that the snapshot was created from.
2347 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2348 # `[email protected]` or
2349 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2350 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2351 # operation, this field will be populated.
2352 {
2353 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2354 # Engine returns NO_RESULTS_ON_PAGE if there
2355 # are no results in the response.
2356 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2357 # value format. For example:
2358 #
2359 # &quot;data&quot;: [
2360 # {
2361 # &quot;key&quot;: &quot;scope&quot;,
2362 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2363 # }
2364 {
2365 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2366 # returned. For example, for warnings where there are no results in a list
2367 # request for a particular zone, this key might be scope and
2368 # the key value might be the zone name. Other examples might be a key
2369 # indicating a deprecated resource and a suggested replacement, or a
2370 # warning about invalid network settings (for example, if an instance
2371 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2372 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2373 },
2374 ],
2375 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2376 },
2377 ],
2378 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2379 # applicable when performing per-zone operations.
2380 }</pre>
2381 </div>
2382
2383 <div class="method">
2384 <code class="details" id="close">close()</code>
2385 <pre>Close httplib2 connections.</pre>
2386 </div>
2387
2388 <div class="method">
2389 <code class="details" id="delete">delete(project, firewallPolicy, requestId=None, x__xgafv=None)</code>
2390 <pre>Deletes the specified policy.
2391
2392 Args:
2393 project: string, Project ID for this request. (required)
2394 firewallPolicy: string, Name of the firewall policy to delete. (required)
2395 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2396 that if you must retry your request, the server will know to ignore the
2397 request if it has already been completed.
2398
2399 For example, consider a situation where you make an initial request and
2400 the request times out. If you make the request again with the same
2401 request ID, the server can check if original operation with the same
2402 request ID was received, and if so, will ignore the second request. This
2403 prevents clients from accidentally creating duplicate commitments.
2404
2405 The request ID must be
2406 a valid UUID with the exception that zero UUID is not supported
2407 (00000000-0000-0000-0000-000000000000).
2408 x__xgafv: string, V1 error format.
2409 Allowed values
2410 1 - v1 error format
2411 2 - v2 error format
2412
2413 Returns:
2414 An object of the form:
2415
2416 { # Represents an Operation resource.
2417 #
2418 # Google Compute Engine has three Operation resources:
2419 #
2420 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2421 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2422 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2423 #
2424 # You can use an operation resource to manage asynchronous API requests.
2425 # For more information, readHandling
2426 # API responses.
2427 #
2428 # Operations can be global, regional or zonal.
2429 #
2430 # - For global operations, use the `globalOperations`
2431 # resource.
2432 # - For regional operations, use the
2433 # `regionOperations` resource.
2434 # - For zonal operations, use
2435 # the `zoneOperations` resource.
2436 #
2437 #
2438 #
2439 # For more information, read
2440 # Global, Regional, and Zonal Resources.
2441 #
2442 # Note that completed Operation resources have a limited
2443 # retention period.
2444 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2445 # Not present otherwise.
2446 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2447 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2448 # set when the operation is created.
2449 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2450 # text format.
2451 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2452 # this field will be populated.
2453 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2454 # operation.
2455 {
2456 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2457 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2458 # details. There is a set of defined message types to use for providing
2459 # details.The syntax depends on the error code. For example,
2460 # QuotaExceededInfo will have details when the error code is
2461 # QUOTA_EXCEEDED.
2462 {
2463 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2464 #
2465 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2466 # is not enabled:
2467 #
2468 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2469 # &quot;domain&quot;: &quot;googleapis.com&quot;
2470 # &quot;metadata&quot;: {
2471 # &quot;resource&quot;: &quot;projects/123&quot;,
2472 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2473 # }
2474 # }
2475 #
2476 # This response indicates that the pubsub.googleapis.com API is not enabled.
2477 #
2478 # Example of an error that is returned when attempting to create a Spanner
2479 # instance in a region that is out of stock:
2480 #
2481 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2482 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2483 # &quot;metadata&quot;: {
2484 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2485 # }
2486 # }
2487 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2488 # is typically the registered service name of the tool or product that
2489 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2490 # generated by some common infrastructure, the error domain must be a
2491 # globally unique value that identifies the infrastructure. For Google API
2492 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2493 &quot;metadatas&quot;: { # Additional structured details about this error.
2494 #
2495 # Keys must match a regular expression of `a-z+` but should
2496 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2497 # length. When identifying the current value of an exceeded limit, the units
2498 # should be contained in the key, not the value. For example, rather than
2499 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2500 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2501 # instances that can be created in a single (batch) request.
2502 &quot;a_key&quot;: &quot;A String&quot;,
2503 },
2504 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2505 # proximate cause of the error. Error reasons are unique within a particular
2506 # domain of errors. This should be at most 63 characters and match a
2507 # regular expression of `A-Z+[A-Z0-9]`, which represents
2508 # UPPER_SNAKE_CASE.
2509 },
2510 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2511 #
2512 # For example, if a quota check failed with an error indicating the calling
2513 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2514 # directly to the right place in the developer console to flip the bit.
2515 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2516 { # Describes a URL link.
2517 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2518 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2519 },
2520 ],
2521 },
2522 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2523 # which can be attached to an RPC error.
2524 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2525 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2526 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2527 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2528 },
2529 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2530 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2531 &quot;a_key&quot;: &quot;A String&quot;,
2532 },
2533 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2534 # type or metric.
2535 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2536 # or metric.
2537 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2538 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2539 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2540 },
2541 },
2542 ],
2543 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2544 # This property is optional.
2545 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2546 },
2547 ],
2548 },
2549 &quot;getVersionOperationMetadata&quot;: {
2550 &quot;inlineSbomInfo&quot;: {
2551 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2552 # appropriate identifiers.
2553 &quot;a_key&quot;: &quot;A String&quot;,
2554 },
2555 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2556 # identifiers.
2557 &quot;a_key&quot;: &quot;A String&quot;,
2558 },
2559 },
2560 },
2561 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2562 # message that was returned, such as `NOT FOUND`.
2563 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2564 # status code that was returned. For example, a `404` means the
2565 # resource was not found.
2566 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2567 # defined by the server.
2568 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2569 # This value is inRFC3339
2570 # text format.
2571 &quot;instancesBulkInsertOperationMetadata&quot;: {
2572 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2573 # Example key: zones/us-central1-a
2574 &quot;a_key&quot;: {
2575 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2576 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2577 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2578 # error.
2579 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2580 # if the flow is rolling forward or rolling back.
2581 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2582 },
2583 },
2584 },
2585 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2586 # Operation resources.
2587 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2588 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2589 # group of operations results from a `bulkInsert` API request.
2590 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2591 # `update`, or `delete`, and so on.
2592 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2593 # There is no requirement that this be linear or support any granularity of
2594 # operations. This should not be used to guess when the operation will be
2595 # complete. This number should monotonically increase as the operation
2596 # progresses.
2597 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2598 # applicable when performing regional operations.
2599 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2600 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2601 # this field will contain information on all underlying zonal actions and
2602 # their state.
2603 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2604 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2605 # Example key: zones/us-central1-a
2606 &quot;a_key&quot;: {
2607 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
2608 # populated.
2609 # different programming environments, including REST APIs and RPC APIs. It is
2610 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2611 # three pieces of data: error code, error message, and error details.
2612 #
2613 # You can find out more about this error model and how to work with it in the
2614 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2615 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2616 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2617 # message types for APIs to use.
2618 {
2619 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2620 },
2621 ],
2622 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2623 # user-facing error message should be localized and sent in the
2624 # google.rpc.Status.details field, or localized by the client.
2625 },
2626 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2627 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2628 },
2629 },
2630 },
2631 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2632 # This value is inRFC3339
2633 # text format.
2634 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2635 # following:
2636 # `PENDING`, `RUNNING`, or `DONE`.
2637 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2638 # operation.
2639 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2640 # of the target resource.
2641 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2642 # operations related to creating a snapshot, this points to the disk
2643 # that the snapshot was created from.
2644 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2645 # `[email protected]` or
2646 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2647 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2648 # operation, this field will be populated.
2649 {
2650 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2651 # Engine returns NO_RESULTS_ON_PAGE if there
2652 # are no results in the response.
2653 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2654 # value format. For example:
2655 #
2656 # &quot;data&quot;: [
2657 # {
2658 # &quot;key&quot;: &quot;scope&quot;,
2659 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2660 # }
2661 {
2662 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2663 # returned. For example, for warnings where there are no results in a list
2664 # request for a particular zone, this key might be scope and
2665 # the key value might be the zone name. Other examples might be a key
2666 # indicating a deprecated resource and a suggested replacement, or a
2667 # warning about invalid network settings (for example, if an instance
2668 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2669 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2670 },
2671 ],
2672 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2673 },
2674 ],
2675 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2676 # applicable when performing per-zone operations.
2677 }</pre>
2678 </div>
2679
2680 <div class="method">
2681 <code class="details" id="get">get(project, firewallPolicy, x__xgafv=None)</code>
2682 <pre>Returns the specified network firewall policy.
2683
2684 Args:
2685 project: string, Project ID for this request. (required)
2686 firewallPolicy: string, Name of the firewall policy to get. (required)
2687 x__xgafv: string, V1 error format.
2688 Allowed values
2689 1 - v1 error format
2690 2 - v2 error format
2691
2692 Returns:
2693 An object of the form:
2694
2695 { # Represents a Firewall Policy resource.
2696 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
2697 {
2698 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
2699 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
2700 # of the firewall policy of the association.
2701 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
2702 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
2703 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
2704 # must be a positive value between 1 and 2147483647.
2705 # Firewall Policies are evaluated from highest to lowest priority where 1
2706 # is the highest priority and 2147483647 is the lowest priority.
2707 # The default value is `1000`. If two associations have the same priority
2708 # then lexicographical order on association names is applied.
2709 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
2710 },
2711 ],
2712 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2713 # text format.
2714 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2715 # create the resource.
2716 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
2717 # Organization firewall policy. The name should be unique in the organization
2718 # in which the firewall policy is created.
2719 # This field is not applicable to network firewall policies.
2720 # This name must be set on creation and cannot be changed.
2721 # The name must be 1-63 characters long, and comply
2722 # with RFC1035. Specifically, the name must be 1-63 characters
2723 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
2724 # means the first character must be a lowercase letter, and all following
2725 # characters must be a dash, lowercase letter, or digit, except the last
2726 # character, which cannot be a dash.
2727 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
2728 # the metadata&#x27;s contents and used for optimistic locking. The
2729 # fingerprint is initially generated by Compute Engine and changes after
2730 # every request to modify or update metadata. You must always provide an
2731 # up-to-date fingerprint hash in order to update or change metadata,
2732 # otherwise the request will fail with error412 conditionNotMet.
2733 #
2734 # To see the latest fingerprint, make get() request to the
2735 # firewall policy.
2736 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2737 # defined by the server.
2738 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
2739 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
2740 # [Output Only] numeric ID allocated by Google Cloud which uniquely
2741 # identifies the Organization Firewall Policy.
2742 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
2743 { # Represents a rule that describes one or more match conditions along with
2744 # the action to be taken when traffic matches this condition (allow or deny).
2745 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
2746 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
2747 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
2748 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
2749 # and &quot;goto_next&quot;.
2750 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
2751 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
2752 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
2753 # the firewall policy rule is not enforced and traffic behaves as if it did
2754 # not exist. If this is unspecified, the firewall policy rule will be
2755 # enabled.
2756 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
2757 # enabled, logs will be exported to the configured export destination in
2758 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
2759 # cannot enable logging on &quot;goto_next&quot; rules.
2760 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
2761 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
2762 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
2763 # Exactly one field must be specified.
2764 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
2765 # Maximum number of destination address groups is 10.
2766 &quot;A String&quot;,
2767 ],
2768 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2769 # traffic destination.
2770 # Maximum number of destination fqdn allowed is 100.
2771 &quot;A String&quot;,
2772 ],
2773 &quot;destIpRanges&quot;: [ # CIDR IP address range.
2774 # Maximum number of destination CIDR IP ranges allowed is 5000.
2775 &quot;A String&quot;,
2776 ],
2777 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
2778 #
2779 #
2780 # - UNSPECIFIED
2781 # - INTERNET
2782 # - NON_INTERNET
2783 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
2784 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
2785 #
2786 #
2787 # - UNSPECIFIED
2788 # - INTERNET
2789 # - NON_INTERNET
2790 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
2791 # of traffic. Should be specified as 2 letter country code defined as per
2792 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2793 # Maximum number of dest region codes allowed is 5000.
2794 &quot;A String&quot;,
2795 ],
2796 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2797 # The IPs in these lists will be matched against traffic destination.
2798 &quot;A String&quot;,
2799 ],
2800 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
2801 {
2802 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
2803 # required when creating a firewall rule. This value can either be
2804 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
2805 # protocol number.
2806 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
2807 # only applicable for UDP or TCP protocol. Each entry must be either
2808 # an integer or a range. If not specified, this rule applies to
2809 # connections through any port.
2810 #
2811 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
2812 &quot;A String&quot;,
2813 ],
2814 },
2815 ],
2816 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
2817 # Maximum number of source address groups is 10.
2818 &quot;A String&quot;,
2819 ],
2820 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2821 # traffic source.
2822 # Maximum number of source fqdn allowed is 100.
2823 &quot;A String&quot;,
2824 ],
2825 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
2826 # Maximum number of source CIDR IP ranges allowed is 5000.
2827 &quot;A String&quot;,
2828 ],
2829 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
2830 #
2831 #
2832 # - UNSPECIFIED
2833 # - INTERNET
2834 # - INTRA_VPC
2835 # - NON_INTERNET
2836 # - VPC_NETWORKS
2837 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
2838 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
2839 #
2840 #
2841 # - UNSPECIFIED
2842 # - INTERNET
2843 # - INTRA_VPC
2844 # - NON_INTERNET
2845 # - VPC_NETWORKS
2846 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
2847 &quot;A String&quot;,
2848 ],
2849 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
2850 # of traffic. Should be specified as 2 letter country code defined as per
2851 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2852 # Maximum number of source region codes allowed is 5000.
2853 &quot;A String&quot;,
2854 ],
2855 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
2856 # of the traffic.
2857 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
2858 # and there is no srcIpRange, this rule will be ignored.
2859 # Maximum number of source tag values allowed is 256.
2860 {
2861 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2862 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2863 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2864 # or its network is deleted.
2865 },
2866 ],
2867 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2868 # The IPs in these lists will be matched against traffic source.
2869 &quot;A String&quot;,
2870 ],
2871 },
2872 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
2873 # must be a positive value between 0 and 2147483647.
2874 # Rules are evaluated from highest to lowest priority where 0 is the
2875 # highest priority and 2147483647 is the lowest priority.
2876 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
2877 # and can be updated.
2878 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
2879 # rule.
2880 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
2881 # Example:
2882 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
2883 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
2884 # &#x27;mirror&#x27;. Cannot be specified for other actions.
2885 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
2886 # This field allows you to control which load balancers get this rule.
2887 # For example, the following are valid values:
2888 #
2889 #
2890 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
2891 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2892 # - projects/project/global/
2893 # forwardingRules/forwardingRule
2894 # - projects/project/regions/region/forwardingRules/
2895 # forwardingRule
2896 &quot;A String&quot;,
2897 ],
2898 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
2899 # allows you to control which network&#x27;s VMs get this rule. If this field
2900 # is left blank, all VMs within the organization will receive the rule.
2901 &quot;A String&quot;,
2902 ],
2903 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
2904 # applies to. If targetSecureTag are specified, then the
2905 # firewall rule applies only to instances in the VPC network that have one
2906 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
2907 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
2908 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
2909 # to all instances on the specified network.
2910 # Maximum number of target label tags allowed is 256.
2911 {
2912 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2913 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2914 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2915 # or its network is deleted.
2916 },
2917 ],
2918 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
2919 # applied with this rule.
2920 &quot;A String&quot;,
2921 ],
2922 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
2923 # Default value is INSTANCES.
2924 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
2925 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
2926 # be set for other actions.
2927 },
2928 ],
2929 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
2930 # This field is not applicable to network firewall policies.
2931 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
2932 # creation and defaults to USER_DEFINED.
2933 #
2934 # The USER_DEFINED value indicates a regular firewall policy.
2935 #
2936 # The SYSTEM value indicates a system-level policy managed by an
2937 # internal service like GKE. This SYSTEM value is reserved for
2938 # internal services and cannot be set by users during policy creation.
2939 # Policies with a SYSTEM source cannot be modified or deleted by
2940 # users.
2941 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
2942 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
2943 #
2944 # Note: if not specified then VPC_POLICY will be used.
2945 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
2946 # This field is not applicable to global firewall policies.
2947 # You must specify this field as part of the HTTP request URL. It is
2948 # not settable as a field in the request body.
2949 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
2950 # policy can not exceed a set number of tuples.
2951 &quot;rules&quot;: [ # A list of rules that belong to this policy.
2952 # There must always be a default rule (rule with priority 2147483647 and
2953 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
2954 # default rule with action &quot;allow&quot; will be added.
2955 { # Represents a rule that describes one or more match conditions along with
2956 # the action to be taken when traffic matches this condition (allow or deny).
2957 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
2958 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
2959 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
2960 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
2961 # and &quot;goto_next&quot;.
2962 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
2963 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
2964 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
2965 # the firewall policy rule is not enforced and traffic behaves as if it did
2966 # not exist. If this is unspecified, the firewall policy rule will be
2967 # enabled.
2968 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
2969 # enabled, logs will be exported to the configured export destination in
2970 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
2971 # cannot enable logging on &quot;goto_next&quot; rules.
2972 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
2973 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
2974 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
2975 # Exactly one field must be specified.
2976 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
2977 # Maximum number of destination address groups is 10.
2978 &quot;A String&quot;,
2979 ],
2980 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2981 # traffic destination.
2982 # Maximum number of destination fqdn allowed is 100.
2983 &quot;A String&quot;,
2984 ],
2985 &quot;destIpRanges&quot;: [ # CIDR IP address range.
2986 # Maximum number of destination CIDR IP ranges allowed is 5000.
2987 &quot;A String&quot;,
2988 ],
2989 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
2990 #
2991 #
2992 # - UNSPECIFIED
2993 # - INTERNET
2994 # - NON_INTERNET
2995 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
2996 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
2997 #
2998 #
2999 # - UNSPECIFIED
3000 # - INTERNET
3001 # - NON_INTERNET
3002 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3003 # of traffic. Should be specified as 2 letter country code defined as per
3004 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3005 # Maximum number of dest region codes allowed is 5000.
3006 &quot;A String&quot;,
3007 ],
3008 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3009 # The IPs in these lists will be matched against traffic destination.
3010 &quot;A String&quot;,
3011 ],
3012 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3013 {
3014 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3015 # required when creating a firewall rule. This value can either be
3016 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3017 # protocol number.
3018 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3019 # only applicable for UDP or TCP protocol. Each entry must be either
3020 # an integer or a range. If not specified, this rule applies to
3021 # connections through any port.
3022 #
3023 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3024 &quot;A String&quot;,
3025 ],
3026 },
3027 ],
3028 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3029 # Maximum number of source address groups is 10.
3030 &quot;A String&quot;,
3031 ],
3032 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3033 # traffic source.
3034 # Maximum number of source fqdn allowed is 100.
3035 &quot;A String&quot;,
3036 ],
3037 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3038 # Maximum number of source CIDR IP ranges allowed is 5000.
3039 &quot;A String&quot;,
3040 ],
3041 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3042 #
3043 #
3044 # - UNSPECIFIED
3045 # - INTERNET
3046 # - INTRA_VPC
3047 # - NON_INTERNET
3048 # - VPC_NETWORKS
3049 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3050 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3051 #
3052 #
3053 # - UNSPECIFIED
3054 # - INTERNET
3055 # - INTRA_VPC
3056 # - NON_INTERNET
3057 # - VPC_NETWORKS
3058 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3059 &quot;A String&quot;,
3060 ],
3061 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3062 # of traffic. Should be specified as 2 letter country code defined as per
3063 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3064 # Maximum number of source region codes allowed is 5000.
3065 &quot;A String&quot;,
3066 ],
3067 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3068 # of the traffic.
3069 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3070 # and there is no srcIpRange, this rule will be ignored.
3071 # Maximum number of source tag values allowed is 256.
3072 {
3073 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3074 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3075 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3076 # or its network is deleted.
3077 },
3078 ],
3079 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3080 # The IPs in these lists will be matched against traffic source.
3081 &quot;A String&quot;,
3082 ],
3083 },
3084 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3085 # must be a positive value between 0 and 2147483647.
3086 # Rules are evaluated from highest to lowest priority where 0 is the
3087 # highest priority and 2147483647 is the lowest priority.
3088 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3089 # and can be updated.
3090 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3091 # rule.
3092 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3093 # Example:
3094 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3095 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3096 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3097 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3098 # This field allows you to control which load balancers get this rule.
3099 # For example, the following are valid values:
3100 #
3101 #
3102 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3103 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3104 # - projects/project/global/
3105 # forwardingRules/forwardingRule
3106 # - projects/project/regions/region/forwardingRules/
3107 # forwardingRule
3108 &quot;A String&quot;,
3109 ],
3110 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3111 # allows you to control which network&#x27;s VMs get this rule. If this field
3112 # is left blank, all VMs within the organization will receive the rule.
3113 &quot;A String&quot;,
3114 ],
3115 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3116 # applies to. If targetSecureTag are specified, then the
3117 # firewall rule applies only to instances in the VPC network that have one
3118 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3119 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3120 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3121 # to all instances on the specified network.
3122 # Maximum number of target label tags allowed is 256.
3123 {
3124 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3125 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3126 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3127 # or its network is deleted.
3128 },
3129 ],
3130 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3131 # applied with this rule.
3132 &quot;A String&quot;,
3133 ],
3134 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3135 # Default value is INSTANCES.
3136 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3137 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3138 # be set for other actions.
3139 },
3140 ],
3141 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3142 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3143 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
3144 # unique in the organization in which the firewall policy is created.
3145 # This field is not applicable to network firewall policies.
3146 # This name must be set on creation and cannot be changed. The name must be
3147 # 1-63 characters long, and comply with RFC1035.
3148 # Specifically, the name must be 1-63 characters long and match the regular
3149 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3150 # character must be a lowercase letter, and all following characters must
3151 # be a dash, lowercase letter, or digit, except the last character, which
3152 # cannot be a dash.
3153 }</pre>
3154 </div>
3155
3156 <div class="method">
3157 <code class="details" id="getAssociation">getAssociation(project, firewallPolicy, name=None, x__xgafv=None)</code>
3158 <pre>Gets an association with the specified name.
3159
3160 Args:
3161 project: string, Project ID for this request. (required)
3162 firewallPolicy: string, Name of the firewall policy to which the queried association belongs. (required)
3163 name: string, The name of the association to get from the firewall policy.
3164 x__xgafv: string, V1 error format.
3165 Allowed values
3166 1 - v1 error format
3167 2 - v2 error format
3168
3169 Returns:
3170 An object of the form:
3171
3172 {
3173 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
3174 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
3175 # of the firewall policy of the association.
3176 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
3177 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
3178 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
3179 # must be a positive value between 1 and 2147483647.
3180 # Firewall Policies are evaluated from highest to lowest priority where 1
3181 # is the highest priority and 2147483647 is the lowest priority.
3182 # The default value is `1000`. If two associations have the same priority
3183 # then lexicographical order on association names is applied.
3184 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
3185 }</pre>
3186 </div>
3187
3188 <div class="method">
3189 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
3190 <pre>Gets the access control policy for a resource. May be empty if no such
3191 policy or resource exists.
3192
3193 Args:
3194 project: string, Project ID for this request. (required)
3195 resource: string, Name or id of the resource for this request. (required)
3196 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
3197 x__xgafv: string, V1 error format.
3198 Allowed values
3199 1 - v1 error format
3200 2 - v2 error format
3201
3202 Returns:
3203 An object of the form:
3204
3205 { # An Identity and Access Management (IAM) policy, which specifies access
3206 # controls for Google Cloud resources.
3207 #
3208 #
3209 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3210 # `members`, or principals, to a single `role`. Principals can be user
3211 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3212 # `role` is a named list of permissions; each `role` can be an IAM predefined
3213 # role or a user-created custom role.
3214 #
3215 # For some types of Google Cloud resources, a `binding` can also specify a
3216 # `condition`, which is a logical expression that allows access to a resource
3217 # only if the expression evaluates to `true`. A condition can add constraints
3218 # based on attributes of the request, the resource, or both. To learn which
3219 # resources support conditions in their IAM policies, see the
3220 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3221 #
3222 # **JSON example:**
3223 #
3224 # ```
3225 # {
3226 # &quot;bindings&quot;: [
3227 # {
3228 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3229 # &quot;members&quot;: [
3230 # &quot;user:[email protected]&quot;,
3231 # &quot;group:[email protected]&quot;,
3232 # &quot;domain:google.com&quot;,
3233 # &quot;serviceAccount:[email protected]&quot;
3234 # ]
3235 # },
3236 # {
3237 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3238 # &quot;members&quot;: [
3239 # &quot;user:[email protected]&quot;
3240 # ],
3241 # &quot;condition&quot;: {
3242 # &quot;title&quot;: &quot;expirable access&quot;,
3243 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3244 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3245 # }
3246 # }
3247 # ],
3248 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3249 # &quot;version&quot;: 3
3250 # }
3251 # ```
3252 #
3253 # **YAML example:**
3254 #
3255 # ```
3256 # bindings:
3257 # - members:
3258 # - user:[email protected]
3259 # - group:[email protected]
3260 # - domain:google.com
3261 # - serviceAccount:[email protected]
3262 # role: roles/resourcemanager.organizationAdmin
3263 # - members:
3264 # - user:[email protected]
3265 # role: roles/resourcemanager.organizationViewer
3266 # condition:
3267 # title: expirable access
3268 # description: Does not grant access after Sep 2020
3269 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3270 # etag: BwWWja0YfJA=
3271 # version: 3
3272 # ```
3273 #
3274 # For a description of IAM and its features, see the
3275 # [IAM documentation](https://cloud.google.com/iam/docs/).
3276 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3277 { # Specifies the audit configuration for a service.
3278 # The configuration determines which permission types are logged, and what
3279 # identities, if any, are exempted from logging.
3280 # An AuditConfig must have one or more AuditLogConfigs.
3281 #
3282 # If there are AuditConfigs for both `allServices` and a specific service,
3283 # the union of the two AuditConfigs is used for that service: the log_types
3284 # specified in each AuditConfig are enabled, and the exempted_members in each
3285 # AuditLogConfig are exempted.
3286 #
3287 # Example Policy with multiple AuditConfigs:
3288 #
3289 # {
3290 # &quot;audit_configs&quot;: [
3291 # {
3292 # &quot;service&quot;: &quot;allServices&quot;,
3293 # &quot;audit_log_configs&quot;: [
3294 # {
3295 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3296 # &quot;exempted_members&quot;: [
3297 # &quot;user:[email protected]&quot;
3298 # ]
3299 # },
3300 # {
3301 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3302 # },
3303 # {
3304 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3305 # }
3306 # ]
3307 # },
3308 # {
3309 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3310 # &quot;audit_log_configs&quot;: [
3311 # {
3312 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3313 # },
3314 # {
3315 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3316 # &quot;exempted_members&quot;: [
3317 # &quot;user:[email protected]&quot;
3318 # ]
3319 # }
3320 # ]
3321 # }
3322 # ]
3323 # }
3324 #
3325 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3326 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3327 # `[email protected]` from DATA_WRITE logging.
3328 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3329 { # Provides the configuration for logging a type of permissions.
3330 # Example:
3331 #
3332 # {
3333 # &quot;audit_log_configs&quot;: [
3334 # {
3335 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3336 # &quot;exempted_members&quot;: [
3337 # &quot;user:[email protected]&quot;
3338 # ]
3339 # },
3340 # {
3341 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3342 # }
3343 # ]
3344 # }
3345 #
3346 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3347 # [email protected] from DATA_READ logging.
3348 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3349 # permission.
3350 # Follows the same format of Binding.members.
3351 &quot;A String&quot;,
3352 ],
3353 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3354 },
3355 ],
3356 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3357 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3358 # `allServices` is a special value that covers all services.
3359 },
3360 ],
3361 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3362 # may specify a `condition` that determines how and when the `bindings` are
3363 # applied. Each of the `bindings` must contain at least one principal.
3364 #
3365 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3366 # of these principals can be Google groups. Each occurrence of a principal
3367 # counts towards these limits. For example, if the `bindings` grant 50
3368 # different roles to `user:[email protected]`, and not to any other
3369 # principal, then you can add another 1,450 principals to the `bindings` in
3370 # the `Policy`.
3371 { # Associates `members`, or principals, with a `role`.
3372 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3373 #
3374 # If the condition evaluates to `true`, then this binding applies to the
3375 # current request.
3376 #
3377 # If the condition evaluates to `false`, then this binding does not apply to
3378 # the current request. However, a different role binding might grant the same
3379 # role to one or more of the principals in this binding.
3380 #
3381 # To learn which resources support conditions in their IAM policies, see the
3382 # [IAM
3383 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3384 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3385 # are documented at https://github.com/google/cel-spec.
3386 #
3387 # Example (Comparison):
3388 #
3389 # title: &quot;Summary size limit&quot;
3390 # description: &quot;Determines if a summary is less than 100 chars&quot;
3391 # expression: &quot;document.summary.size() &lt; 100&quot;
3392 #
3393 # Example (Equality):
3394 #
3395 # title: &quot;Requestor is owner&quot;
3396 # description: &quot;Determines if requestor is the document owner&quot;
3397 # expression: &quot;document.owner == request.auth.claims.email&quot;
3398 #
3399 # Example (Logic):
3400 #
3401 # title: &quot;Public documents&quot;
3402 # description: &quot;Determine whether the document should be publicly visible&quot;
3403 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3404 #
3405 # Example (Data Manipulation):
3406 #
3407 # title: &quot;Notification string&quot;
3408 # description: &quot;Create a notification string with a timestamp.&quot;
3409 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3410 #
3411 # The exact variables and functions that may be referenced within an expression
3412 # are determined by the service that evaluates it. See the service
3413 # documentation for additional information.
3414 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3415 # describes the expression, e.g. when hovered over it in a UI.
3416 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3417 # syntax.
3418 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3419 # reporting, e.g. a file name and a position in the file.
3420 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3421 # its purpose. This can be used e.g. in UIs which allow to enter the
3422 # expression.
3423 },
3424 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3425 # `members` can have the following values:
3426 #
3427 # * `allUsers`: A special identifier that represents anyone who is
3428 # on the internet; with or without a Google account.
3429 #
3430 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3431 # who is authenticated with a Google account or a service account.
3432 # Does not include identities that come from external identity providers
3433 # (IdPs) through identity federation.
3434 #
3435 # * `user:{emailid}`: An email address that represents a specific Google
3436 # account. For example, `[email protected]` .
3437 #
3438 #
3439 # * `serviceAccount:{emailid}`: An email address that represents a Google
3440 # service account. For example,
3441 # `[email protected]`.
3442 #
3443 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3444 # identifier for a
3445 # [Kubernetes service
3446 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3447 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3448 #
3449 # * `group:{emailid}`: An email address that represents a Google group.
3450 # For example, `[email protected]`.
3451 #
3452 #
3453 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3454 # users of that domain. For example, `google.com` or `example.com`.
3455 #
3456 #
3457 #
3458 #
3459 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3460 # A single identity in a workforce identity pool.
3461 #
3462 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3463 # All workforce identities in a group.
3464 #
3465 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3466 # All workforce identities with a specific attribute value.
3467 #
3468 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3469 # All identities in a workforce identity pool.
3470 #
3471 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3472 # A single identity in a workload identity pool.
3473 #
3474 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3475 # A workload identity pool group.
3476 #
3477 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3478 # All identities in a workload identity pool with a certain attribute.
3479 #
3480 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3481 # All identities in a workload identity pool.
3482 #
3483 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3484 # identifier) representing a user that has been recently deleted. For
3485 # example, `[email protected]?uid=123456789012345678901`. If the user is
3486 # recovered, this value reverts to `user:{emailid}` and the recovered user
3487 # retains the role in the binding.
3488 #
3489 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3490 # unique identifier) representing a service account that has been recently
3491 # deleted. For example,
3492 # `[email protected]?uid=123456789012345678901`.
3493 # If the service account is undeleted, this value reverts to
3494 # `serviceAccount:{emailid}` and the undeleted service account retains the
3495 # role in the binding.
3496 #
3497 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3498 # identifier) representing a Google group that has been recently
3499 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3500 # the group is recovered, this value reverts to `group:{emailid}` and the
3501 # recovered group retains the role in the binding.
3502 #
3503 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3504 # Deleted single identity in a workforce identity pool. For example,
3505 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3506 &quot;A String&quot;,
3507 ],
3508 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3509 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3510 #
3511 # For an overview of the IAM roles and permissions, see the
3512 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3513 # a list of the available pre-defined roles, see
3514 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3515 },
3516 ],
3517 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3518 # prevent simultaneous updates of a policy from overwriting each other.
3519 # It is strongly suggested that systems make use of the `etag` in the
3520 # read-modify-write cycle to perform policy updates in order to avoid race
3521 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3522 # systems are expected to put that etag in the request to `setIamPolicy` to
3523 # ensure that their change will be applied to the same version of the policy.
3524 #
3525 # **Important:** If you use IAM Conditions, you must include the `etag` field
3526 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3527 # you to overwrite a version `3` policy with a version `1` policy, and all of
3528 # the conditions in the version `3` policy are lost.
3529 &quot;version&quot;: 42, # Specifies the format of the policy.
3530 #
3531 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3532 # are rejected.
3533 #
3534 # Any operation that affects conditional role bindings must specify version
3535 # `3`. This requirement applies to the following operations:
3536 #
3537 # * Getting a policy that includes a conditional role binding
3538 # * Adding a conditional role binding to a policy
3539 # * Changing a conditional role binding in a policy
3540 # * Removing any role binding, with or without a condition, from a policy
3541 # that includes conditions
3542 #
3543 # **Important:** If you use IAM Conditions, you must include the `etag` field
3544 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3545 # you to overwrite a version `3` policy with a version `1` policy, and all of
3546 # the conditions in the version `3` policy are lost.
3547 #
3548 # If a policy does not include any conditions, operations on that policy may
3549 # specify any valid version or leave the field unset.
3550 #
3551 # To learn which resources support conditions in their IAM policies, see the
3552 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3553 }</pre>
3554 </div>
3555
3556 <div class="method">
3557 <code class="details" id="getPacketMirroringRule">getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None)</code>
3558 <pre>Gets a packet mirroring rule of the specified priority.
3559
3560 Args:
3561 project: string, Project ID for this request. (required)
3562 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
3563 priority: integer, The priority of the rule to get from the firewall policy.
3564 x__xgafv: string, V1 error format.
3565 Allowed values
3566 1 - v1 error format
3567 2 - v2 error format
3568
3569 Returns:
3570 An object of the form:
3571
3572 { # Represents a rule that describes one or more match conditions along with
3573 # the action to be taken when traffic matches this condition (allow or deny).
3574 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3575 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3576 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3577 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3578 # and &quot;goto_next&quot;.
3579 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3580 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3581 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3582 # the firewall policy rule is not enforced and traffic behaves as if it did
3583 # not exist. If this is unspecified, the firewall policy rule will be
3584 # enabled.
3585 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3586 # enabled, logs will be exported to the configured export destination in
3587 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3588 # cannot enable logging on &quot;goto_next&quot; rules.
3589 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
3590 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3591 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3592 # Exactly one field must be specified.
3593 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3594 # Maximum number of destination address groups is 10.
3595 &quot;A String&quot;,
3596 ],
3597 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3598 # traffic destination.
3599 # Maximum number of destination fqdn allowed is 100.
3600 &quot;A String&quot;,
3601 ],
3602 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3603 # Maximum number of destination CIDR IP ranges allowed is 5000.
3604 &quot;A String&quot;,
3605 ],
3606 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3607 #
3608 #
3609 # - UNSPECIFIED
3610 # - INTERNET
3611 # - NON_INTERNET
3612 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3613 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3614 #
3615 #
3616 # - UNSPECIFIED
3617 # - INTERNET
3618 # - NON_INTERNET
3619 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3620 # of traffic. Should be specified as 2 letter country code defined as per
3621 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3622 # Maximum number of dest region codes allowed is 5000.
3623 &quot;A String&quot;,
3624 ],
3625 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3626 # The IPs in these lists will be matched against traffic destination.
3627 &quot;A String&quot;,
3628 ],
3629 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3630 {
3631 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3632 # required when creating a firewall rule. This value can either be
3633 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3634 # protocol number.
3635 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3636 # only applicable for UDP or TCP protocol. Each entry must be either
3637 # an integer or a range. If not specified, this rule applies to
3638 # connections through any port.
3639 #
3640 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3641 &quot;A String&quot;,
3642 ],
3643 },
3644 ],
3645 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3646 # Maximum number of source address groups is 10.
3647 &quot;A String&quot;,
3648 ],
3649 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3650 # traffic source.
3651 # Maximum number of source fqdn allowed is 100.
3652 &quot;A String&quot;,
3653 ],
3654 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3655 # Maximum number of source CIDR IP ranges allowed is 5000.
3656 &quot;A String&quot;,
3657 ],
3658 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3659 #
3660 #
3661 # - UNSPECIFIED
3662 # - INTERNET
3663 # - INTRA_VPC
3664 # - NON_INTERNET
3665 # - VPC_NETWORKS
3666 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3667 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3668 #
3669 #
3670 # - UNSPECIFIED
3671 # - INTERNET
3672 # - INTRA_VPC
3673 # - NON_INTERNET
3674 # - VPC_NETWORKS
3675 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3676 &quot;A String&quot;,
3677 ],
3678 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3679 # of traffic. Should be specified as 2 letter country code defined as per
3680 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3681 # Maximum number of source region codes allowed is 5000.
3682 &quot;A String&quot;,
3683 ],
3684 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3685 # of the traffic.
3686 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3687 # and there is no srcIpRange, this rule will be ignored.
3688 # Maximum number of source tag values allowed is 256.
3689 {
3690 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3691 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3692 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3693 # or its network is deleted.
3694 },
3695 ],
3696 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3697 # The IPs in these lists will be matched against traffic source.
3698 &quot;A String&quot;,
3699 ],
3700 },
3701 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3702 # must be a positive value between 0 and 2147483647.
3703 # Rules are evaluated from highest to lowest priority where 0 is the
3704 # highest priority and 2147483647 is the lowest priority.
3705 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3706 # and can be updated.
3707 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3708 # rule.
3709 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3710 # Example:
3711 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3712 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3713 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3714 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3715 # This field allows you to control which load balancers get this rule.
3716 # For example, the following are valid values:
3717 #
3718 #
3719 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3720 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3721 # - projects/project/global/
3722 # forwardingRules/forwardingRule
3723 # - projects/project/regions/region/forwardingRules/
3724 # forwardingRule
3725 &quot;A String&quot;,
3726 ],
3727 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3728 # allows you to control which network&#x27;s VMs get this rule. If this field
3729 # is left blank, all VMs within the organization will receive the rule.
3730 &quot;A String&quot;,
3731 ],
3732 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3733 # applies to. If targetSecureTag are specified, then the
3734 # firewall rule applies only to instances in the VPC network that have one
3735 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3736 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3737 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3738 # to all instances on the specified network.
3739 # Maximum number of target label tags allowed is 256.
3740 {
3741 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3742 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3743 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3744 # or its network is deleted.
3745 },
3746 ],
3747 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3748 # applied with this rule.
3749 &quot;A String&quot;,
3750 ],
3751 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3752 # Default value is INSTANCES.
3753 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3754 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3755 # be set for other actions.
3756 }</pre>
3757 </div>
3758
3759 <div class="method">
3760 <code class="details" id="getRule">getRule(project, firewallPolicy, priority=None, x__xgafv=None)</code>
3761 <pre>Gets a rule of the specified priority.
3762
3763 Args:
3764 project: string, Project ID for this request. (required)
3765 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
3766 priority: integer, The priority of the rule to get from the firewall policy.
3767 x__xgafv: string, V1 error format.
3768 Allowed values
3769 1 - v1 error format
3770 2 - v2 error format
3771
3772 Returns:
3773 An object of the form:
3774
3775 { # Represents a rule that describes one or more match conditions along with
3776 # the action to be taken when traffic matches this condition (allow or deny).
3777 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3778 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3779 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3780 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3781 # and &quot;goto_next&quot;.
3782 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3783 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3784 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3785 # the firewall policy rule is not enforced and traffic behaves as if it did
3786 # not exist. If this is unspecified, the firewall policy rule will be
3787 # enabled.
3788 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3789 # enabled, logs will be exported to the configured export destination in
3790 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3791 # cannot enable logging on &quot;goto_next&quot; rules.
3792 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
3793 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3794 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3795 # Exactly one field must be specified.
3796 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3797 # Maximum number of destination address groups is 10.
3798 &quot;A String&quot;,
3799 ],
3800 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3801 # traffic destination.
3802 # Maximum number of destination fqdn allowed is 100.
3803 &quot;A String&quot;,
3804 ],
3805 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3806 # Maximum number of destination CIDR IP ranges allowed is 5000.
3807 &quot;A String&quot;,
3808 ],
3809 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3810 #
3811 #
3812 # - UNSPECIFIED
3813 # - INTERNET
3814 # - NON_INTERNET
3815 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3816 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3817 #
3818 #
3819 # - UNSPECIFIED
3820 # - INTERNET
3821 # - NON_INTERNET
3822 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3823 # of traffic. Should be specified as 2 letter country code defined as per
3824 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3825 # Maximum number of dest region codes allowed is 5000.
3826 &quot;A String&quot;,
3827 ],
3828 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3829 # The IPs in these lists will be matched against traffic destination.
3830 &quot;A String&quot;,
3831 ],
3832 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3833 {
3834 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3835 # required when creating a firewall rule. This value can either be
3836 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3837 # protocol number.
3838 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3839 # only applicable for UDP or TCP protocol. Each entry must be either
3840 # an integer or a range. If not specified, this rule applies to
3841 # connections through any port.
3842 #
3843 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3844 &quot;A String&quot;,
3845 ],
3846 },
3847 ],
3848 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3849 # Maximum number of source address groups is 10.
3850 &quot;A String&quot;,
3851 ],
3852 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3853 # traffic source.
3854 # Maximum number of source fqdn allowed is 100.
3855 &quot;A String&quot;,
3856 ],
3857 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3858 # Maximum number of source CIDR IP ranges allowed is 5000.
3859 &quot;A String&quot;,
3860 ],
3861 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3862 #
3863 #
3864 # - UNSPECIFIED
3865 # - INTERNET
3866 # - INTRA_VPC
3867 # - NON_INTERNET
3868 # - VPC_NETWORKS
3869 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3870 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3871 #
3872 #
3873 # - UNSPECIFIED
3874 # - INTERNET
3875 # - INTRA_VPC
3876 # - NON_INTERNET
3877 # - VPC_NETWORKS
3878 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3879 &quot;A String&quot;,
3880 ],
3881 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3882 # of traffic. Should be specified as 2 letter country code defined as per
3883 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3884 # Maximum number of source region codes allowed is 5000.
3885 &quot;A String&quot;,
3886 ],
3887 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3888 # of the traffic.
3889 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3890 # and there is no srcIpRange, this rule will be ignored.
3891 # Maximum number of source tag values allowed is 256.
3892 {
3893 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3894 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3895 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3896 # or its network is deleted.
3897 },
3898 ],
3899 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3900 # The IPs in these lists will be matched against traffic source.
3901 &quot;A String&quot;,
3902 ],
3903 },
3904 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3905 # must be a positive value between 0 and 2147483647.
3906 # Rules are evaluated from highest to lowest priority where 0 is the
3907 # highest priority and 2147483647 is the lowest priority.
3908 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3909 # and can be updated.
3910 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3911 # rule.
3912 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3913 # Example:
3914 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3915 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3916 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3917 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3918 # This field allows you to control which load balancers get this rule.
3919 # For example, the following are valid values:
3920 #
3921 #
3922 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3923 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3924 # - projects/project/global/
3925 # forwardingRules/forwardingRule
3926 # - projects/project/regions/region/forwardingRules/
3927 # forwardingRule
3928 &quot;A String&quot;,
3929 ],
3930 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3931 # allows you to control which network&#x27;s VMs get this rule. If this field
3932 # is left blank, all VMs within the organization will receive the rule.
3933 &quot;A String&quot;,
3934 ],
3935 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3936 # applies to. If targetSecureTag are specified, then the
3937 # firewall rule applies only to instances in the VPC network that have one
3938 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3939 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3940 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3941 # to all instances on the specified network.
3942 # Maximum number of target label tags allowed is 256.
3943 {
3944 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3945 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3946 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3947 # or its network is deleted.
3948 },
3949 ],
3950 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3951 # applied with this rule.
3952 &quot;A String&quot;,
3953 ],
3954 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3955 # Default value is INSTANCES.
3956 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3957 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3958 # be set for other actions.
3959 }</pre>
3960 </div>
3961
3962 <div class="method">
3963 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
3964 <pre>Creates a new policy in the specified project using the data included in
3965 the request.
3966
3967 Args:
3968 project: string, Project ID for this request. (required)
3969 body: object, The request body.
3970 The object takes the form of:
3971
3972 { # Represents a Firewall Policy resource.
3973 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
3974 {
3975 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
3976 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
3977 # of the firewall policy of the association.
3978 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
3979 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
3980 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
3981 # must be a positive value between 1 and 2147483647.
3982 # Firewall Policies are evaluated from highest to lowest priority where 1
3983 # is the highest priority and 2147483647 is the lowest priority.
3984 # The default value is `1000`. If two associations have the same priority
3985 # then lexicographical order on association names is applied.
3986 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
3987 },
3988 ],
3989 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3990 # text format.
3991 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3992 # create the resource.
3993 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
3994 # Organization firewall policy. The name should be unique in the organization
3995 # in which the firewall policy is created.
3996 # This field is not applicable to network firewall policies.
3997 # This name must be set on creation and cannot be changed.
3998 # The name must be 1-63 characters long, and comply
3999 # with RFC1035. Specifically, the name must be 1-63 characters
4000 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
4001 # means the first character must be a lowercase letter, and all following
4002 # characters must be a dash, lowercase letter, or digit, except the last
4003 # character, which cannot be a dash.
4004 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
4005 # the metadata&#x27;s contents and used for optimistic locking. The
4006 # fingerprint is initially generated by Compute Engine and changes after
4007 # every request to modify or update metadata. You must always provide an
4008 # up-to-date fingerprint hash in order to update or change metadata,
4009 # otherwise the request will fail with error412 conditionNotMet.
4010 #
4011 # To see the latest fingerprint, make get() request to the
4012 # firewall policy.
4013 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4014 # defined by the server.
4015 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
4016 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
4017 # [Output Only] numeric ID allocated by Google Cloud which uniquely
4018 # identifies the Organization Firewall Policy.
4019 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
4020 { # Represents a rule that describes one or more match conditions along with
4021 # the action to be taken when traffic matches this condition (allow or deny).
4022 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
4023 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
4024 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
4025 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
4026 # and &quot;goto_next&quot;.
4027 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
4028 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
4029 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
4030 # the firewall policy rule is not enforced and traffic behaves as if it did
4031 # not exist. If this is unspecified, the firewall policy rule will be
4032 # enabled.
4033 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4034 # enabled, logs will be exported to the configured export destination in
4035 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4036 # cannot enable logging on &quot;goto_next&quot; rules.
4037 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
4038 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4039 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4040 # Exactly one field must be specified.
4041 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
4042 # Maximum number of destination address groups is 10.
4043 &quot;A String&quot;,
4044 ],
4045 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4046 # traffic destination.
4047 # Maximum number of destination fqdn allowed is 100.
4048 &quot;A String&quot;,
4049 ],
4050 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4051 # Maximum number of destination CIDR IP ranges allowed is 5000.
4052 &quot;A String&quot;,
4053 ],
4054 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
4055 #
4056 #
4057 # - UNSPECIFIED
4058 # - INTERNET
4059 # - NON_INTERNET
4060 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
4061 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
4062 #
4063 #
4064 # - UNSPECIFIED
4065 # - INTERNET
4066 # - NON_INTERNET
4067 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
4068 # of traffic. Should be specified as 2 letter country code defined as per
4069 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4070 # Maximum number of dest region codes allowed is 5000.
4071 &quot;A String&quot;,
4072 ],
4073 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4074 # The IPs in these lists will be matched against traffic destination.
4075 &quot;A String&quot;,
4076 ],
4077 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4078 {
4079 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4080 # required when creating a firewall rule. This value can either be
4081 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4082 # protocol number.
4083 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4084 # only applicable for UDP or TCP protocol. Each entry must be either
4085 # an integer or a range. If not specified, this rule applies to
4086 # connections through any port.
4087 #
4088 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4089 &quot;A String&quot;,
4090 ],
4091 },
4092 ],
4093 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4094 # Maximum number of source address groups is 10.
4095 &quot;A String&quot;,
4096 ],
4097 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4098 # traffic source.
4099 # Maximum number of source fqdn allowed is 100.
4100 &quot;A String&quot;,
4101 ],
4102 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4103 # Maximum number of source CIDR IP ranges allowed is 5000.
4104 &quot;A String&quot;,
4105 ],
4106 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4107 #
4108 #
4109 # - UNSPECIFIED
4110 # - INTERNET
4111 # - INTRA_VPC
4112 # - NON_INTERNET
4113 # - VPC_NETWORKS
4114 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4115 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4116 #
4117 #
4118 # - UNSPECIFIED
4119 # - INTERNET
4120 # - INTRA_VPC
4121 # - NON_INTERNET
4122 # - VPC_NETWORKS
4123 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4124 &quot;A String&quot;,
4125 ],
4126 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4127 # of traffic. Should be specified as 2 letter country code defined as per
4128 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4129 # Maximum number of source region codes allowed is 5000.
4130 &quot;A String&quot;,
4131 ],
4132 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4133 # of the traffic.
4134 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4135 # and there is no srcIpRange, this rule will be ignored.
4136 # Maximum number of source tag values allowed is 256.
4137 {
4138 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4139 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4140 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4141 # or its network is deleted.
4142 },
4143 ],
4144 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4145 # The IPs in these lists will be matched against traffic source.
4146 &quot;A String&quot;,
4147 ],
4148 },
4149 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4150 # must be a positive value between 0 and 2147483647.
4151 # Rules are evaluated from highest to lowest priority where 0 is the
4152 # highest priority and 2147483647 is the lowest priority.
4153 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4154 # and can be updated.
4155 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4156 # rule.
4157 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4158 # Example:
4159 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4160 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4161 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4162 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4163 # This field allows you to control which load balancers get this rule.
4164 # For example, the following are valid values:
4165 #
4166 #
4167 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4168 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4169 # - projects/project/global/
4170 # forwardingRules/forwardingRule
4171 # - projects/project/regions/region/forwardingRules/
4172 # forwardingRule
4173 &quot;A String&quot;,
4174 ],
4175 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4176 # allows you to control which network&#x27;s VMs get this rule. If this field
4177 # is left blank, all VMs within the organization will receive the rule.
4178 &quot;A String&quot;,
4179 ],
4180 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4181 # applies to. If targetSecureTag are specified, then the
4182 # firewall rule applies only to instances in the VPC network that have one
4183 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4184 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
4185 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
4186 # to all instances on the specified network.
4187 # Maximum number of target label tags allowed is 256.
4188 {
4189 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4190 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4191 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4192 # or its network is deleted.
4193 },
4194 ],
4195 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4196 # applied with this rule.
4197 &quot;A String&quot;,
4198 ],
4199 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
4200 # Default value is INSTANCES.
4201 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
4202 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
4203 # be set for other actions.
4204 },
4205 ],
4206 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
4207 # This field is not applicable to network firewall policies.
4208 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
4209 # creation and defaults to USER_DEFINED.
4210 #
4211 # The USER_DEFINED value indicates a regular firewall policy.
4212 #
4213 # The SYSTEM value indicates a system-level policy managed by an
4214 # internal service like GKE. This SYSTEM value is reserved for
4215 # internal services and cannot be set by users during policy creation.
4216 # Policies with a SYSTEM source cannot be modified or deleted by
4217 # users.
4218 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
4219 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
4220 #
4221 # Note: if not specified then VPC_POLICY will be used.
4222 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
4223 # This field is not applicable to global firewall policies.
4224 # You must specify this field as part of the HTTP request URL. It is
4225 # not settable as a field in the request body.
4226 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
4227 # policy can not exceed a set number of tuples.
4228 &quot;rules&quot;: [ # A list of rules that belong to this policy.
4229 # There must always be a default rule (rule with priority 2147483647 and
4230 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
4231 # default rule with action &quot;allow&quot; will be added.
4232 { # Represents a rule that describes one or more match conditions along with
4233 # the action to be taken when traffic matches this condition (allow or deny).
4234 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
4235 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
4236 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
4237 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
4238 # and &quot;goto_next&quot;.
4239 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
4240 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
4241 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
4242 # the firewall policy rule is not enforced and traffic behaves as if it did
4243 # not exist. If this is unspecified, the firewall policy rule will be
4244 # enabled.
4245 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4246 # enabled, logs will be exported to the configured export destination in
4247 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4248 # cannot enable logging on &quot;goto_next&quot; rules.
4249 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
4250 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4251 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4252 # Exactly one field must be specified.
4253 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
4254 # Maximum number of destination address groups is 10.
4255 &quot;A String&quot;,
4256 ],
4257 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4258 # traffic destination.
4259 # Maximum number of destination fqdn allowed is 100.
4260 &quot;A String&quot;,
4261 ],
4262 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4263 # Maximum number of destination CIDR IP ranges allowed is 5000.
4264 &quot;A String&quot;,
4265 ],
4266 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
4267 #
4268 #
4269 # - UNSPECIFIED
4270 # - INTERNET
4271 # - NON_INTERNET
4272 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
4273 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
4274 #
4275 #
4276 # - UNSPECIFIED
4277 # - INTERNET
4278 # - NON_INTERNET
4279 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
4280 # of traffic. Should be specified as 2 letter country code defined as per
4281 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4282 # Maximum number of dest region codes allowed is 5000.
4283 &quot;A String&quot;,
4284 ],
4285 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4286 # The IPs in these lists will be matched against traffic destination.
4287 &quot;A String&quot;,
4288 ],
4289 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4290 {
4291 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4292 # required when creating a firewall rule. This value can either be
4293 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4294 # protocol number.
4295 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4296 # only applicable for UDP or TCP protocol. Each entry must be either
4297 # an integer or a range. If not specified, this rule applies to
4298 # connections through any port.
4299 #
4300 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4301 &quot;A String&quot;,
4302 ],
4303 },
4304 ],
4305 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4306 # Maximum number of source address groups is 10.
4307 &quot;A String&quot;,
4308 ],
4309 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4310 # traffic source.
4311 # Maximum number of source fqdn allowed is 100.
4312 &quot;A String&quot;,
4313 ],
4314 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4315 # Maximum number of source CIDR IP ranges allowed is 5000.
4316 &quot;A String&quot;,
4317 ],
4318 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4319 #
4320 #
4321 # - UNSPECIFIED
4322 # - INTERNET
4323 # - INTRA_VPC
4324 # - NON_INTERNET
4325 # - VPC_NETWORKS
4326 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4327 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4328 #
4329 #
4330 # - UNSPECIFIED
4331 # - INTERNET
4332 # - INTRA_VPC
4333 # - NON_INTERNET
4334 # - VPC_NETWORKS
4335 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4336 &quot;A String&quot;,
4337 ],
4338 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4339 # of traffic. Should be specified as 2 letter country code defined as per
4340 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4341 # Maximum number of source region codes allowed is 5000.
4342 &quot;A String&quot;,
4343 ],
4344 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4345 # of the traffic.
4346 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4347 # and there is no srcIpRange, this rule will be ignored.
4348 # Maximum number of source tag values allowed is 256.
4349 {
4350 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4351 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4352 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4353 # or its network is deleted.
4354 },
4355 ],
4356 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4357 # The IPs in these lists will be matched against traffic source.
4358 &quot;A String&quot;,
4359 ],
4360 },
4361 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4362 # must be a positive value between 0 and 2147483647.
4363 # Rules are evaluated from highest to lowest priority where 0 is the
4364 # highest priority and 2147483647 is the lowest priority.
4365 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4366 # and can be updated.
4367 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4368 # rule.
4369 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4370 # Example:
4371 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4372 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4373 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4374 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4375 # This field allows you to control which load balancers get this rule.
4376 # For example, the following are valid values:
4377 #
4378 #
4379 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4380 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4381 # - projects/project/global/
4382 # forwardingRules/forwardingRule
4383 # - projects/project/regions/region/forwardingRules/
4384 # forwardingRule
4385 &quot;A String&quot;,
4386 ],
4387 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4388 # allows you to control which network&#x27;s VMs get this rule. If this field
4389 # is left blank, all VMs within the organization will receive the rule.
4390 &quot;A String&quot;,
4391 ],
4392 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4393 # applies to. If targetSecureTag are specified, then the
4394 # firewall rule applies only to instances in the VPC network that have one
4395 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4396 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
4397 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
4398 # to all instances on the specified network.
4399 # Maximum number of target label tags allowed is 256.
4400 {
4401 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4402 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4403 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4404 # or its network is deleted.
4405 },
4406 ],
4407 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4408 # applied with this rule.
4409 &quot;A String&quot;,
4410 ],
4411 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
4412 # Default value is INSTANCES.
4413 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
4414 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
4415 # be set for other actions.
4416 },
4417 ],
4418 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4419 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4420 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
4421 # unique in the organization in which the firewall policy is created.
4422 # This field is not applicable to network firewall policies.
4423 # This name must be set on creation and cannot be changed. The name must be
4424 # 1-63 characters long, and comply with RFC1035.
4425 # Specifically, the name must be 1-63 characters long and match the regular
4426 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4427 # character must be a lowercase letter, and all following characters must
4428 # be a dash, lowercase letter, or digit, except the last character, which
4429 # cannot be a dash.
4430 }
4431
4432 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4433 that if you must retry your request, the server will know to ignore the
4434 request if it has already been completed.
4435
4436 For example, consider a situation where you make an initial request and
4437 the request times out. If you make the request again with the same
4438 request ID, the server can check if original operation with the same
4439 request ID was received, and if so, will ignore the second request. This
4440 prevents clients from accidentally creating duplicate commitments.
4441
4442 The request ID must be
4443 a valid UUID with the exception that zero UUID is not supported
4444 (00000000-0000-0000-0000-000000000000).
4445 x__xgafv: string, V1 error format.
4446 Allowed values
4447 1 - v1 error format
4448 2 - v2 error format
4449
4450 Returns:
4451 An object of the form:
4452
4453 { # Represents an Operation resource.
4454 #
4455 # Google Compute Engine has three Operation resources:
4456 #
4457 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
4458 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
4459 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
4460 #
4461 # You can use an operation resource to manage asynchronous API requests.
4462 # For more information, readHandling
4463 # API responses.
4464 #
4465 # Operations can be global, regional or zonal.
4466 #
4467 # - For global operations, use the `globalOperations`
4468 # resource.
4469 # - For regional operations, use the
4470 # `regionOperations` resource.
4471 # - For zonal operations, use
4472 # the `zoneOperations` resource.
4473 #
4474 #
4475 #
4476 # For more information, read
4477 # Global, Regional, and Zonal Resources.
4478 #
4479 # Note that completed Operation resources have a limited
4480 # retention period.
4481 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4482 # Not present otherwise.
4483 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4484 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4485 # set when the operation is created.
4486 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4487 # text format.
4488 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4489 # this field will be populated.
4490 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4491 # operation.
4492 {
4493 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4494 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4495 # details. There is a set of defined message types to use for providing
4496 # details.The syntax depends on the error code. For example,
4497 # QuotaExceededInfo will have details when the error code is
4498 # QUOTA_EXCEEDED.
4499 {
4500 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4501 #
4502 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4503 # is not enabled:
4504 #
4505 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4506 # &quot;domain&quot;: &quot;googleapis.com&quot;
4507 # &quot;metadata&quot;: {
4508 # &quot;resource&quot;: &quot;projects/123&quot;,
4509 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4510 # }
4511 # }
4512 #
4513 # This response indicates that the pubsub.googleapis.com API is not enabled.
4514 #
4515 # Example of an error that is returned when attempting to create a Spanner
4516 # instance in a region that is out of stock:
4517 #
4518 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4519 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4520 # &quot;metadata&quot;: {
4521 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4522 # }
4523 # }
4524 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4525 # is typically the registered service name of the tool or product that
4526 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4527 # generated by some common infrastructure, the error domain must be a
4528 # globally unique value that identifies the infrastructure. For Google API
4529 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4530 &quot;metadatas&quot;: { # Additional structured details about this error.
4531 #
4532 # Keys must match a regular expression of `a-z+` but should
4533 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4534 # length. When identifying the current value of an exceeded limit, the units
4535 # should be contained in the key, not the value. For example, rather than
4536 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4537 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4538 # instances that can be created in a single (batch) request.
4539 &quot;a_key&quot;: &quot;A String&quot;,
4540 },
4541 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4542 # proximate cause of the error. Error reasons are unique within a particular
4543 # domain of errors. This should be at most 63 characters and match a
4544 # regular expression of `A-Z+[A-Z0-9]`, which represents
4545 # UPPER_SNAKE_CASE.
4546 },
4547 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4548 #
4549 # For example, if a quota check failed with an error indicating the calling
4550 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4551 # directly to the right place in the developer console to flip the bit.
4552 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4553 { # Describes a URL link.
4554 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4555 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4556 },
4557 ],
4558 },
4559 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4560 # which can be attached to an RPC error.
4561 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4562 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4563 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4564 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4565 },
4566 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4567 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4568 &quot;a_key&quot;: &quot;A String&quot;,
4569 },
4570 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4571 # type or metric.
4572 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4573 # or metric.
4574 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4575 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4576 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4577 },
4578 },
4579 ],
4580 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4581 # This property is optional.
4582 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4583 },
4584 ],
4585 },
4586 &quot;getVersionOperationMetadata&quot;: {
4587 &quot;inlineSbomInfo&quot;: {
4588 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4589 # appropriate identifiers.
4590 &quot;a_key&quot;: &quot;A String&quot;,
4591 },
4592 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4593 # identifiers.
4594 &quot;a_key&quot;: &quot;A String&quot;,
4595 },
4596 },
4597 },
4598 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4599 # message that was returned, such as `NOT FOUND`.
4600 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4601 # status code that was returned. For example, a `404` means the
4602 # resource was not found.
4603 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4604 # defined by the server.
4605 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4606 # This value is inRFC3339
4607 # text format.
4608 &quot;instancesBulkInsertOperationMetadata&quot;: {
4609 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4610 # Example key: zones/us-central1-a
4611 &quot;a_key&quot;: {
4612 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4613 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4614 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4615 # error.
4616 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4617 # if the flow is rolling forward or rolling back.
4618 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4619 },
4620 },
4621 },
4622 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4623 # Operation resources.
4624 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4625 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4626 # group of operations results from a `bulkInsert` API request.
4627 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4628 # `update`, or `delete`, and so on.
4629 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4630 # There is no requirement that this be linear or support any granularity of
4631 # operations. This should not be used to guess when the operation will be
4632 # complete. This number should monotonically increase as the operation
4633 # progresses.
4634 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4635 # applicable when performing regional operations.
4636 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4637 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4638 # this field will contain information on all underlying zonal actions and
4639 # their state.
4640 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4641 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4642 # Example key: zones/us-central1-a
4643 &quot;a_key&quot;: {
4644 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
4645 # populated.
4646 # different programming environments, including REST APIs and RPC APIs. It is
4647 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4648 # three pieces of data: error code, error message, and error details.
4649 #
4650 # You can find out more about this error model and how to work with it in the
4651 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4652 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4653 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4654 # message types for APIs to use.
4655 {
4656 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4657 },
4658 ],
4659 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4660 # user-facing error message should be localized and sent in the
4661 # google.rpc.Status.details field, or localized by the client.
4662 },
4663 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4664 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4665 },
4666 },
4667 },
4668 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4669 # This value is inRFC3339
4670 # text format.
4671 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4672 # following:
4673 # `PENDING`, `RUNNING`, or `DONE`.
4674 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4675 # operation.
4676 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4677 # of the target resource.
4678 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4679 # operations related to creating a snapshot, this points to the disk
4680 # that the snapshot was created from.
4681 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4682 # `[email protected]` or
4683 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4684 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4685 # operation, this field will be populated.
4686 {
4687 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4688 # Engine returns NO_RESULTS_ON_PAGE if there
4689 # are no results in the response.
4690 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4691 # value format. For example:
4692 #
4693 # &quot;data&quot;: [
4694 # {
4695 # &quot;key&quot;: &quot;scope&quot;,
4696 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4697 # }
4698 {
4699 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4700 # returned. For example, for warnings where there are no results in a list
4701 # request for a particular zone, this key might be scope and
4702 # the key value might be the zone name. Other examples might be a key
4703 # indicating a deprecated resource and a suggested replacement, or a
4704 # warning about invalid network settings (for example, if an instance
4705 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4706 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4707 },
4708 ],
4709 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4710 },
4711 ],
4712 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4713 # applicable when performing per-zone operations.
4714 }</pre>
4715 </div>
4716
4717 <div class="method">
4718 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4719 <pre>Lists all the policies that have been configured for the specified project.
4720
4721 Args:
4722 project: string, Project ID for this request. (required)
4723 filter: string, A filter expression that filters resources listed in the response. Most
4724 Compute resources support two types of filter expressions:
4725 expressions that support regular expressions and expressions that follow
4726 API improvement proposal AIP-160.
4727 These two types of filter expressions cannot be mixed in one request.
4728
4729 If you want to use AIP-160, your expression must specify the field name, an
4730 operator, and the value that you want to use for filtering. The value
4731 must be a string, a number, or a boolean. The operator
4732 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4733
4734 For example, if you are filtering Compute Engine instances, you can
4735 exclude instances named `example-instance` by specifying
4736 `name != example-instance`.
4737
4738 The `:*` comparison can be used to test whether a key has been defined.
4739 For example, to find all objects with `owner` label use:
4740 ```
4741 labels.owner:*
4742 ```
4743
4744 You can also filter nested fields. For example, you could specify
4745 `scheduling.automaticRestart = false` to include instances only
4746 if they are not scheduled for automatic restarts. You can use filtering
4747 on nested fields to filter based onresource labels.
4748
4749 To filter on multiple expressions, provide each separate expression within
4750 parentheses. For example:
4751 ```
4752 (scheduling.automaticRestart = true)
4753 (cpuPlatform = &quot;Intel Skylake&quot;)
4754 ```
4755 By default, each expression is an `AND` expression. However, you
4756 can include `AND` and `OR` expressions explicitly.
4757 For example:
4758 ```
4759 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4760 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4761 (scheduling.automaticRestart = true)
4762 ```
4763
4764 If you want to use a regular expression, use the `eq` (equal) or `ne`
4765 (not equal) operator against a single un-parenthesized expression with or
4766 without quotes or against multiple parenthesized expressions. Examples:
4767
4768 `fieldname eq unquoted literal`
4769 `fieldname eq &#x27;single quoted literal&#x27;`
4770 `fieldname eq &quot;double quoted literal&quot;`
4771 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4772
4773 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4774 The literal value must match the entire field.
4775
4776 For example, to filter for instances that do not end with name &quot;instance&quot;,
4777 you would use `name ne .*instance`.
4778
4779 You cannot combine constraints on multiple fields using regular
4780 expressions.
4781 maxResults: integer, The maximum number of results per page that should be returned.
4782 If the number of available results is larger than `maxResults`,
4783 Compute Engine returns a `nextPageToken` that can be used to get
4784 the next page of results in subsequent list requests. Acceptable values are
4785 `0` to `500`, inclusive. (Default: `500`)
4786 orderBy: string, Sorts list results by a certain order. By default, results
4787 are returned in alphanumerical order based on the resource name.
4788
4789 You can also sort results in descending order based on the creation
4790 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4791 results based on the `creationTimestamp` field in
4792 reverse chronological order (newest result first). Use this to sort
4793 resources like operations so that the newest operation is returned first.
4794
4795 Currently, only sorting by `name` or
4796 `creationTimestamp desc` is supported.
4797 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4798 `nextPageToken` returned by a previous list request to get
4799 the next page of results.
4800 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4801 of failure. The default value is false.
4802
4803 For example, when partial success behavior is enabled, aggregatedList for a
4804 single zone scope either returns all resources in the zone or no resources,
4805 with an error code.
4806 x__xgafv: string, V1 error format.
4807 Allowed values
4808 1 - v1 error format
4809 2 - v2 error format
4810
4811 Returns:
4812 An object of the form:
4813
4814 {
4815 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4816 &quot;items&quot;: [ # A list of FirewallPolicy resources.
4817 { # Represents a Firewall Policy resource.
4818 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
4819 {
4820 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
4821 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
4822 # of the firewall policy of the association.
4823 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
4824 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
4825 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
4826 # must be a positive value between 1 and 2147483647.
4827 # Firewall Policies are evaluated from highest to lowest priority where 1
4828 # is the highest priority and 2147483647 is the lowest priority.
4829 # The default value is `1000`. If two associations have the same priority
4830 # then lexicographical order on association names is applied.
4831 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
4832 },
4833 ],
4834 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4835 # text format.
4836 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4837 # create the resource.
4838 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
4839 # Organization firewall policy. The name should be unique in the organization
4840 # in which the firewall policy is created.
4841 # This field is not applicable to network firewall policies.
4842 # This name must be set on creation and cannot be changed.
4843 # The name must be 1-63 characters long, and comply
4844 # with RFC1035. Specifically, the name must be 1-63 characters
4845 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
4846 # means the first character must be a lowercase letter, and all following
4847 # characters must be a dash, lowercase letter, or digit, except the last
4848 # character, which cannot be a dash.
4849 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
4850 # the metadata&#x27;s contents and used for optimistic locking. The
4851 # fingerprint is initially generated by Compute Engine and changes after
4852 # every request to modify or update metadata. You must always provide an
4853 # up-to-date fingerprint hash in order to update or change metadata,
4854 # otherwise the request will fail with error412 conditionNotMet.
4855 #
4856 # To see the latest fingerprint, make get() request to the
4857 # firewall policy.
4858 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4859 # defined by the server.
4860 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
4861 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
4862 # [Output Only] numeric ID allocated by Google Cloud which uniquely
4863 # identifies the Organization Firewall Policy.
4864 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
4865 { # Represents a rule that describes one or more match conditions along with
4866 # the action to be taken when traffic matches this condition (allow or deny).
4867 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
4868 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
4869 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
4870 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
4871 # and &quot;goto_next&quot;.
4872 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
4873 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
4874 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
4875 # the firewall policy rule is not enforced and traffic behaves as if it did
4876 # not exist. If this is unspecified, the firewall policy rule will be
4877 # enabled.
4878 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4879 # enabled, logs will be exported to the configured export destination in
4880 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4881 # cannot enable logging on &quot;goto_next&quot; rules.
4882 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
4883 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4884 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4885 # Exactly one field must be specified.
4886 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
4887 # Maximum number of destination address groups is 10.
4888 &quot;A String&quot;,
4889 ],
4890 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4891 # traffic destination.
4892 # Maximum number of destination fqdn allowed is 100.
4893 &quot;A String&quot;,
4894 ],
4895 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4896 # Maximum number of destination CIDR IP ranges allowed is 5000.
4897 &quot;A String&quot;,
4898 ],
4899 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
4900 #
4901 #
4902 # - UNSPECIFIED
4903 # - INTERNET
4904 # - NON_INTERNET
4905 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
4906 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
4907 #
4908 #
4909 # - UNSPECIFIED
4910 # - INTERNET
4911 # - NON_INTERNET
4912 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
4913 # of traffic. Should be specified as 2 letter country code defined as per
4914 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4915 # Maximum number of dest region codes allowed is 5000.
4916 &quot;A String&quot;,
4917 ],
4918 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4919 # The IPs in these lists will be matched against traffic destination.
4920 &quot;A String&quot;,
4921 ],
4922 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4923 {
4924 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4925 # required when creating a firewall rule. This value can either be
4926 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4927 # protocol number.
4928 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4929 # only applicable for UDP or TCP protocol. Each entry must be either
4930 # an integer or a range. If not specified, this rule applies to
4931 # connections through any port.
4932 #
4933 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4934 &quot;A String&quot;,
4935 ],
4936 },
4937 ],
4938 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4939 # Maximum number of source address groups is 10.
4940 &quot;A String&quot;,
4941 ],
4942 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4943 # traffic source.
4944 # Maximum number of source fqdn allowed is 100.
4945 &quot;A String&quot;,
4946 ],
4947 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4948 # Maximum number of source CIDR IP ranges allowed is 5000.
4949 &quot;A String&quot;,
4950 ],
4951 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4952 #
4953 #
4954 # - UNSPECIFIED
4955 # - INTERNET
4956 # - INTRA_VPC
4957 # - NON_INTERNET
4958 # - VPC_NETWORKS
4959 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4960 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4961 #
4962 #
4963 # - UNSPECIFIED
4964 # - INTERNET
4965 # - INTRA_VPC
4966 # - NON_INTERNET
4967 # - VPC_NETWORKS
4968 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4969 &quot;A String&quot;,
4970 ],
4971 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4972 # of traffic. Should be specified as 2 letter country code defined as per
4973 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4974 # Maximum number of source region codes allowed is 5000.
4975 &quot;A String&quot;,
4976 ],
4977 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4978 # of the traffic.
4979 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4980 # and there is no srcIpRange, this rule will be ignored.
4981 # Maximum number of source tag values allowed is 256.
4982 {
4983 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4984 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4985 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4986 # or its network is deleted.
4987 },
4988 ],
4989 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4990 # The IPs in these lists will be matched against traffic source.
4991 &quot;A String&quot;,
4992 ],
4993 },
4994 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4995 # must be a positive value between 0 and 2147483647.
4996 # Rules are evaluated from highest to lowest priority where 0 is the
4997 # highest priority and 2147483647 is the lowest priority.
4998 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4999 # and can be updated.
5000 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5001 # rule.
5002 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5003 # Example:
5004 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5005 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5006 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5007 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5008 # This field allows you to control which load balancers get this rule.
5009 # For example, the following are valid values:
5010 #
5011 #
5012 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5013 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5014 # - projects/project/global/
5015 # forwardingRules/forwardingRule
5016 # - projects/project/regions/region/forwardingRules/
5017 # forwardingRule
5018 &quot;A String&quot;,
5019 ],
5020 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5021 # allows you to control which network&#x27;s VMs get this rule. If this field
5022 # is left blank, all VMs within the organization will receive the rule.
5023 &quot;A String&quot;,
5024 ],
5025 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5026 # applies to. If targetSecureTag are specified, then the
5027 # firewall rule applies only to instances in the VPC network that have one
5028 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5029 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5030 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5031 # to all instances on the specified network.
5032 # Maximum number of target label tags allowed is 256.
5033 {
5034 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5035 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5036 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5037 # or its network is deleted.
5038 },
5039 ],
5040 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5041 # applied with this rule.
5042 &quot;A String&quot;,
5043 ],
5044 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5045 # Default value is INSTANCES.
5046 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5047 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5048 # be set for other actions.
5049 },
5050 ],
5051 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
5052 # This field is not applicable to network firewall policies.
5053 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
5054 # creation and defaults to USER_DEFINED.
5055 #
5056 # The USER_DEFINED value indicates a regular firewall policy.
5057 #
5058 # The SYSTEM value indicates a system-level policy managed by an
5059 # internal service like GKE. This SYSTEM value is reserved for
5060 # internal services and cannot be set by users during policy creation.
5061 # Policies with a SYSTEM source cannot be modified or deleted by
5062 # users.
5063 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
5064 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
5065 #
5066 # Note: if not specified then VPC_POLICY will be used.
5067 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
5068 # This field is not applicable to global firewall policies.
5069 # You must specify this field as part of the HTTP request URL. It is
5070 # not settable as a field in the request body.
5071 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
5072 # policy can not exceed a set number of tuples.
5073 &quot;rules&quot;: [ # A list of rules that belong to this policy.
5074 # There must always be a default rule (rule with priority 2147483647 and
5075 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
5076 # default rule with action &quot;allow&quot; will be added.
5077 { # Represents a rule that describes one or more match conditions along with
5078 # the action to be taken when traffic matches this condition (allow or deny).
5079 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5080 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5081 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5082 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5083 # and &quot;goto_next&quot;.
5084 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5085 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5086 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5087 # the firewall policy rule is not enforced and traffic behaves as if it did
5088 # not exist. If this is unspecified, the firewall policy rule will be
5089 # enabled.
5090 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5091 # enabled, logs will be exported to the configured export destination in
5092 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5093 # cannot enable logging on &quot;goto_next&quot; rules.
5094 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
5095 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5096 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5097 # Exactly one field must be specified.
5098 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5099 # Maximum number of destination address groups is 10.
5100 &quot;A String&quot;,
5101 ],
5102 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5103 # traffic destination.
5104 # Maximum number of destination fqdn allowed is 100.
5105 &quot;A String&quot;,
5106 ],
5107 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5108 # Maximum number of destination CIDR IP ranges allowed is 5000.
5109 &quot;A String&quot;,
5110 ],
5111 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5112 #
5113 #
5114 # - UNSPECIFIED
5115 # - INTERNET
5116 # - NON_INTERNET
5117 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5118 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5119 #
5120 #
5121 # - UNSPECIFIED
5122 # - INTERNET
5123 # - NON_INTERNET
5124 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5125 # of traffic. Should be specified as 2 letter country code defined as per
5126 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5127 # Maximum number of dest region codes allowed is 5000.
5128 &quot;A String&quot;,
5129 ],
5130 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5131 # The IPs in these lists will be matched against traffic destination.
5132 &quot;A String&quot;,
5133 ],
5134 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5135 {
5136 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5137 # required when creating a firewall rule. This value can either be
5138 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5139 # protocol number.
5140 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5141 # only applicable for UDP or TCP protocol. Each entry must be either
5142 # an integer or a range. If not specified, this rule applies to
5143 # connections through any port.
5144 #
5145 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5146 &quot;A String&quot;,
5147 ],
5148 },
5149 ],
5150 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5151 # Maximum number of source address groups is 10.
5152 &quot;A String&quot;,
5153 ],
5154 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5155 # traffic source.
5156 # Maximum number of source fqdn allowed is 100.
5157 &quot;A String&quot;,
5158 ],
5159 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5160 # Maximum number of source CIDR IP ranges allowed is 5000.
5161 &quot;A String&quot;,
5162 ],
5163 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5164 #
5165 #
5166 # - UNSPECIFIED
5167 # - INTERNET
5168 # - INTRA_VPC
5169 # - NON_INTERNET
5170 # - VPC_NETWORKS
5171 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5172 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5173 #
5174 #
5175 # - UNSPECIFIED
5176 # - INTERNET
5177 # - INTRA_VPC
5178 # - NON_INTERNET
5179 # - VPC_NETWORKS
5180 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5181 &quot;A String&quot;,
5182 ],
5183 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5184 # of traffic. Should be specified as 2 letter country code defined as per
5185 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5186 # Maximum number of source region codes allowed is 5000.
5187 &quot;A String&quot;,
5188 ],
5189 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5190 # of the traffic.
5191 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5192 # and there is no srcIpRange, this rule will be ignored.
5193 # Maximum number of source tag values allowed is 256.
5194 {
5195 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5196 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5197 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5198 # or its network is deleted.
5199 },
5200 ],
5201 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5202 # The IPs in these lists will be matched against traffic source.
5203 &quot;A String&quot;,
5204 ],
5205 },
5206 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5207 # must be a positive value between 0 and 2147483647.
5208 # Rules are evaluated from highest to lowest priority where 0 is the
5209 # highest priority and 2147483647 is the lowest priority.
5210 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5211 # and can be updated.
5212 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5213 # rule.
5214 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5215 # Example:
5216 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5217 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5218 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5219 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5220 # This field allows you to control which load balancers get this rule.
5221 # For example, the following are valid values:
5222 #
5223 #
5224 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5225 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5226 # - projects/project/global/
5227 # forwardingRules/forwardingRule
5228 # - projects/project/regions/region/forwardingRules/
5229 # forwardingRule
5230 &quot;A String&quot;,
5231 ],
5232 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5233 # allows you to control which network&#x27;s VMs get this rule. If this field
5234 # is left blank, all VMs within the organization will receive the rule.
5235 &quot;A String&quot;,
5236 ],
5237 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5238 # applies to. If targetSecureTag are specified, then the
5239 # firewall rule applies only to instances in the VPC network that have one
5240 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5241 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5242 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5243 # to all instances on the specified network.
5244 # Maximum number of target label tags allowed is 256.
5245 {
5246 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5247 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5248 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5249 # or its network is deleted.
5250 },
5251 ],
5252 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5253 # applied with this rule.
5254 &quot;A String&quot;,
5255 ],
5256 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5257 # Default value is INSTANCES.
5258 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5259 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5260 # be set for other actions.
5261 },
5262 ],
5263 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5264 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5265 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
5266 # unique in the organization in which the firewall policy is created.
5267 # This field is not applicable to network firewall policies.
5268 # This name must be set on creation and cannot be changed. The name must be
5269 # 1-63 characters long, and comply with RFC1035.
5270 # Specifically, the name must be 1-63 characters long and match the regular
5271 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5272 # character must be a lowercase letter, and all following characters must
5273 # be a dash, lowercase letter, or digit, except the last character, which
5274 # cannot be a dash.
5275 },
5276 ],
5277 &quot;kind&quot;: &quot;compute#firewallPolicyList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#firewallPolicyList for listsof FirewallPolicies
5278 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5279 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5280 # the query parameter pageToken in the next list request.
5281 # Subsequent list requests will have their own nextPageToken to
5282 # continue paging through the results.
5283 &quot;warning&quot;: { # [Output Only] Informational warning message.
5284 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5285 # Engine returns NO_RESULTS_ON_PAGE if there
5286 # are no results in the response.
5287 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5288 # value format. For example:
5289 #
5290 # &quot;data&quot;: [
5291 # {
5292 # &quot;key&quot;: &quot;scope&quot;,
5293 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5294 # }
5295 {
5296 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5297 # returned. For example, for warnings where there are no results in a list
5298 # request for a particular zone, this key might be scope and
5299 # the key value might be the zone name. Other examples might be a key
5300 # indicating a deprecated resource and a suggested replacement, or a
5301 # warning about invalid network settings (for example, if an instance
5302 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5303 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5304 },
5305 ],
5306 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5307 },
5308 }</pre>
5309 </div>
5310
5311 <div class="method">
5312 <code class="details" id="list_next">list_next()</code>
5313 <pre>Retrieves the next page of results.
5314
5315 Args:
5316 previous_request: The request for the previous page. (required)
5317 previous_response: The response from the request for the previous page. (required)
5318
5319 Returns:
5320 A request object that you can call &#x27;execute()&#x27; on to request the next
5321 page. Returns None if there are no more items in the collection.
5322 </pre>
5323 </div>
5324
5325 <div class="method">
5326 <code class="details" id="patch">patch(project, firewallPolicy, body=None, requestId=None, x__xgafv=None)</code>
5327 <pre>Patches the specified policy with the data included in the request.
5328
5329 Args:
5330 project: string, Project ID for this request. (required)
5331 firewallPolicy: string, Name of the firewall policy to update. (required)
5332 body: object, The request body.
5333 The object takes the form of:
5334
5335 { # Represents a Firewall Policy resource.
5336 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
5337 {
5338 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
5339 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
5340 # of the firewall policy of the association.
5341 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
5342 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
5343 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
5344 # must be a positive value between 1 and 2147483647.
5345 # Firewall Policies are evaluated from highest to lowest priority where 1
5346 # is the highest priority and 2147483647 is the lowest priority.
5347 # The default value is `1000`. If two associations have the same priority
5348 # then lexicographical order on association names is applied.
5349 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
5350 },
5351 ],
5352 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5353 # text format.
5354 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5355 # create the resource.
5356 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
5357 # Organization firewall policy. The name should be unique in the organization
5358 # in which the firewall policy is created.
5359 # This field is not applicable to network firewall policies.
5360 # This name must be set on creation and cannot be changed.
5361 # The name must be 1-63 characters long, and comply
5362 # with RFC1035. Specifically, the name must be 1-63 characters
5363 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
5364 # means the first character must be a lowercase letter, and all following
5365 # characters must be a dash, lowercase letter, or digit, except the last
5366 # character, which cannot be a dash.
5367 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
5368 # the metadata&#x27;s contents and used for optimistic locking. The
5369 # fingerprint is initially generated by Compute Engine and changes after
5370 # every request to modify or update metadata. You must always provide an
5371 # up-to-date fingerprint hash in order to update or change metadata,
5372 # otherwise the request will fail with error412 conditionNotMet.
5373 #
5374 # To see the latest fingerprint, make get() request to the
5375 # firewall policy.
5376 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5377 # defined by the server.
5378 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
5379 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
5380 # [Output Only] numeric ID allocated by Google Cloud which uniquely
5381 # identifies the Organization Firewall Policy.
5382 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
5383 { # Represents a rule that describes one or more match conditions along with
5384 # the action to be taken when traffic matches this condition (allow or deny).
5385 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5386 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5387 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5388 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5389 # and &quot;goto_next&quot;.
5390 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5391 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5392 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5393 # the firewall policy rule is not enforced and traffic behaves as if it did
5394 # not exist. If this is unspecified, the firewall policy rule will be
5395 # enabled.
5396 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5397 # enabled, logs will be exported to the configured export destination in
5398 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5399 # cannot enable logging on &quot;goto_next&quot; rules.
5400 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
5401 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5402 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5403 # Exactly one field must be specified.
5404 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5405 # Maximum number of destination address groups is 10.
5406 &quot;A String&quot;,
5407 ],
5408 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5409 # traffic destination.
5410 # Maximum number of destination fqdn allowed is 100.
5411 &quot;A String&quot;,
5412 ],
5413 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5414 # Maximum number of destination CIDR IP ranges allowed is 5000.
5415 &quot;A String&quot;,
5416 ],
5417 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5418 #
5419 #
5420 # - UNSPECIFIED
5421 # - INTERNET
5422 # - NON_INTERNET
5423 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5424 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5425 #
5426 #
5427 # - UNSPECIFIED
5428 # - INTERNET
5429 # - NON_INTERNET
5430 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5431 # of traffic. Should be specified as 2 letter country code defined as per
5432 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5433 # Maximum number of dest region codes allowed is 5000.
5434 &quot;A String&quot;,
5435 ],
5436 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5437 # The IPs in these lists will be matched against traffic destination.
5438 &quot;A String&quot;,
5439 ],
5440 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5441 {
5442 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5443 # required when creating a firewall rule. This value can either be
5444 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5445 # protocol number.
5446 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5447 # only applicable for UDP or TCP protocol. Each entry must be either
5448 # an integer or a range. If not specified, this rule applies to
5449 # connections through any port.
5450 #
5451 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5452 &quot;A String&quot;,
5453 ],
5454 },
5455 ],
5456 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5457 # Maximum number of source address groups is 10.
5458 &quot;A String&quot;,
5459 ],
5460 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5461 # traffic source.
5462 # Maximum number of source fqdn allowed is 100.
5463 &quot;A String&quot;,
5464 ],
5465 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5466 # Maximum number of source CIDR IP ranges allowed is 5000.
5467 &quot;A String&quot;,
5468 ],
5469 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5470 #
5471 #
5472 # - UNSPECIFIED
5473 # - INTERNET
5474 # - INTRA_VPC
5475 # - NON_INTERNET
5476 # - VPC_NETWORKS
5477 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5478 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5479 #
5480 #
5481 # - UNSPECIFIED
5482 # - INTERNET
5483 # - INTRA_VPC
5484 # - NON_INTERNET
5485 # - VPC_NETWORKS
5486 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5487 &quot;A String&quot;,
5488 ],
5489 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5490 # of traffic. Should be specified as 2 letter country code defined as per
5491 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5492 # Maximum number of source region codes allowed is 5000.
5493 &quot;A String&quot;,
5494 ],
5495 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5496 # of the traffic.
5497 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5498 # and there is no srcIpRange, this rule will be ignored.
5499 # Maximum number of source tag values allowed is 256.
5500 {
5501 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5502 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5503 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5504 # or its network is deleted.
5505 },
5506 ],
5507 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5508 # The IPs in these lists will be matched against traffic source.
5509 &quot;A String&quot;,
5510 ],
5511 },
5512 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5513 # must be a positive value between 0 and 2147483647.
5514 # Rules are evaluated from highest to lowest priority where 0 is the
5515 # highest priority and 2147483647 is the lowest priority.
5516 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5517 # and can be updated.
5518 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5519 # rule.
5520 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5521 # Example:
5522 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5523 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5524 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5525 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5526 # This field allows you to control which load balancers get this rule.
5527 # For example, the following are valid values:
5528 #
5529 #
5530 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5531 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5532 # - projects/project/global/
5533 # forwardingRules/forwardingRule
5534 # - projects/project/regions/region/forwardingRules/
5535 # forwardingRule
5536 &quot;A String&quot;,
5537 ],
5538 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5539 # allows you to control which network&#x27;s VMs get this rule. If this field
5540 # is left blank, all VMs within the organization will receive the rule.
5541 &quot;A String&quot;,
5542 ],
5543 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5544 # applies to. If targetSecureTag are specified, then the
5545 # firewall rule applies only to instances in the VPC network that have one
5546 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5547 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5548 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5549 # to all instances on the specified network.
5550 # Maximum number of target label tags allowed is 256.
5551 {
5552 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5553 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5554 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5555 # or its network is deleted.
5556 },
5557 ],
5558 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5559 # applied with this rule.
5560 &quot;A String&quot;,
5561 ],
5562 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5563 # Default value is INSTANCES.
5564 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5565 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5566 # be set for other actions.
5567 },
5568 ],
5569 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
5570 # This field is not applicable to network firewall policies.
5571 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
5572 # creation and defaults to USER_DEFINED.
5573 #
5574 # The USER_DEFINED value indicates a regular firewall policy.
5575 #
5576 # The SYSTEM value indicates a system-level policy managed by an
5577 # internal service like GKE. This SYSTEM value is reserved for
5578 # internal services and cannot be set by users during policy creation.
5579 # Policies with a SYSTEM source cannot be modified or deleted by
5580 # users.
5581 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
5582 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
5583 #
5584 # Note: if not specified then VPC_POLICY will be used.
5585 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
5586 # This field is not applicable to global firewall policies.
5587 # You must specify this field as part of the HTTP request URL. It is
5588 # not settable as a field in the request body.
5589 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
5590 # policy can not exceed a set number of tuples.
5591 &quot;rules&quot;: [ # A list of rules that belong to this policy.
5592 # There must always be a default rule (rule with priority 2147483647 and
5593 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
5594 # default rule with action &quot;allow&quot; will be added.
5595 { # Represents a rule that describes one or more match conditions along with
5596 # the action to be taken when traffic matches this condition (allow or deny).
5597 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5598 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5599 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5600 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5601 # and &quot;goto_next&quot;.
5602 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5603 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5604 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5605 # the firewall policy rule is not enforced and traffic behaves as if it did
5606 # not exist. If this is unspecified, the firewall policy rule will be
5607 # enabled.
5608 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5609 # enabled, logs will be exported to the configured export destination in
5610 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5611 # cannot enable logging on &quot;goto_next&quot; rules.
5612 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
5613 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5614 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5615 # Exactly one field must be specified.
5616 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5617 # Maximum number of destination address groups is 10.
5618 &quot;A String&quot;,
5619 ],
5620 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5621 # traffic destination.
5622 # Maximum number of destination fqdn allowed is 100.
5623 &quot;A String&quot;,
5624 ],
5625 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5626 # Maximum number of destination CIDR IP ranges allowed is 5000.
5627 &quot;A String&quot;,
5628 ],
5629 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5630 #
5631 #
5632 # - UNSPECIFIED
5633 # - INTERNET
5634 # - NON_INTERNET
5635 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5636 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5637 #
5638 #
5639 # - UNSPECIFIED
5640 # - INTERNET
5641 # - NON_INTERNET
5642 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5643 # of traffic. Should be specified as 2 letter country code defined as per
5644 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5645 # Maximum number of dest region codes allowed is 5000.
5646 &quot;A String&quot;,
5647 ],
5648 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5649 # The IPs in these lists will be matched against traffic destination.
5650 &quot;A String&quot;,
5651 ],
5652 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5653 {
5654 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5655 # required when creating a firewall rule. This value can either be
5656 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5657 # protocol number.
5658 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5659 # only applicable for UDP or TCP protocol. Each entry must be either
5660 # an integer or a range. If not specified, this rule applies to
5661 # connections through any port.
5662 #
5663 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5664 &quot;A String&quot;,
5665 ],
5666 },
5667 ],
5668 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5669 # Maximum number of source address groups is 10.
5670 &quot;A String&quot;,
5671 ],
5672 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5673 # traffic source.
5674 # Maximum number of source fqdn allowed is 100.
5675 &quot;A String&quot;,
5676 ],
5677 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5678 # Maximum number of source CIDR IP ranges allowed is 5000.
5679 &quot;A String&quot;,
5680 ],
5681 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5682 #
5683 #
5684 # - UNSPECIFIED
5685 # - INTERNET
5686 # - INTRA_VPC
5687 # - NON_INTERNET
5688 # - VPC_NETWORKS
5689 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5690 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5691 #
5692 #
5693 # - UNSPECIFIED
5694 # - INTERNET
5695 # - INTRA_VPC
5696 # - NON_INTERNET
5697 # - VPC_NETWORKS
5698 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5699 &quot;A String&quot;,
5700 ],
5701 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5702 # of traffic. Should be specified as 2 letter country code defined as per
5703 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5704 # Maximum number of source region codes allowed is 5000.
5705 &quot;A String&quot;,
5706 ],
5707 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5708 # of the traffic.
5709 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5710 # and there is no srcIpRange, this rule will be ignored.
5711 # Maximum number of source tag values allowed is 256.
5712 {
5713 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5714 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5715 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5716 # or its network is deleted.
5717 },
5718 ],
5719 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5720 # The IPs in these lists will be matched against traffic source.
5721 &quot;A String&quot;,
5722 ],
5723 },
5724 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5725 # must be a positive value between 0 and 2147483647.
5726 # Rules are evaluated from highest to lowest priority where 0 is the
5727 # highest priority and 2147483647 is the lowest priority.
5728 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5729 # and can be updated.
5730 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5731 # rule.
5732 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5733 # Example:
5734 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5735 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5736 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5737 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5738 # This field allows you to control which load balancers get this rule.
5739 # For example, the following are valid values:
5740 #
5741 #
5742 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5743 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5744 # - projects/project/global/
5745 # forwardingRules/forwardingRule
5746 # - projects/project/regions/region/forwardingRules/
5747 # forwardingRule
5748 &quot;A String&quot;,
5749 ],
5750 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5751 # allows you to control which network&#x27;s VMs get this rule. If this field
5752 # is left blank, all VMs within the organization will receive the rule.
5753 &quot;A String&quot;,
5754 ],
5755 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5756 # applies to. If targetSecureTag are specified, then the
5757 # firewall rule applies only to instances in the VPC network that have one
5758 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5759 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5760 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5761 # to all instances on the specified network.
5762 # Maximum number of target label tags allowed is 256.
5763 {
5764 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5765 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5766 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5767 # or its network is deleted.
5768 },
5769 ],
5770 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5771 # applied with this rule.
5772 &quot;A String&quot;,
5773 ],
5774 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5775 # Default value is INSTANCES.
5776 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5777 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5778 # be set for other actions.
5779 },
5780 ],
5781 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5782 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5783 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
5784 # unique in the organization in which the firewall policy is created.
5785 # This field is not applicable to network firewall policies.
5786 # This name must be set on creation and cannot be changed. The name must be
5787 # 1-63 characters long, and comply with RFC1035.
5788 # Specifically, the name must be 1-63 characters long and match the regular
5789 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5790 # character must be a lowercase letter, and all following characters must
5791 # be a dash, lowercase letter, or digit, except the last character, which
5792 # cannot be a dash.
5793 }
5794
5795 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5796 that if you must retry your request, the server will know to ignore the
5797 request if it has already been completed.
5798
5799 For example, consider a situation where you make an initial request and
5800 the request times out. If you make the request again with the same
5801 request ID, the server can check if original operation with the same
5802 request ID was received, and if so, will ignore the second request. This
5803 prevents clients from accidentally creating duplicate commitments.
5804
5805 The request ID must be
5806 a valid UUID with the exception that zero UUID is not supported
5807 (00000000-0000-0000-0000-000000000000).
5808 x__xgafv: string, V1 error format.
5809 Allowed values
5810 1 - v1 error format
5811 2 - v2 error format
5812
5813 Returns:
5814 An object of the form:
5815
5816 { # Represents an Operation resource.
5817 #
5818 # Google Compute Engine has three Operation resources:
5819 #
5820 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
5821 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
5822 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
5823 #
5824 # You can use an operation resource to manage asynchronous API requests.
5825 # For more information, readHandling
5826 # API responses.
5827 #
5828 # Operations can be global, regional or zonal.
5829 #
5830 # - For global operations, use the `globalOperations`
5831 # resource.
5832 # - For regional operations, use the
5833 # `regionOperations` resource.
5834 # - For zonal operations, use
5835 # the `zoneOperations` resource.
5836 #
5837 #
5838 #
5839 # For more information, read
5840 # Global, Regional, and Zonal Resources.
5841 #
5842 # Note that completed Operation resources have a limited
5843 # retention period.
5844 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5845 # Not present otherwise.
5846 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5847 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5848 # set when the operation is created.
5849 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5850 # text format.
5851 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5852 # this field will be populated.
5853 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5854 # operation.
5855 {
5856 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5857 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5858 # details. There is a set of defined message types to use for providing
5859 # details.The syntax depends on the error code. For example,
5860 # QuotaExceededInfo will have details when the error code is
5861 # QUOTA_EXCEEDED.
5862 {
5863 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5864 #
5865 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5866 # is not enabled:
5867 #
5868 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5869 # &quot;domain&quot;: &quot;googleapis.com&quot;
5870 # &quot;metadata&quot;: {
5871 # &quot;resource&quot;: &quot;projects/123&quot;,
5872 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5873 # }
5874 # }
5875 #
5876 # This response indicates that the pubsub.googleapis.com API is not enabled.
5877 #
5878 # Example of an error that is returned when attempting to create a Spanner
5879 # instance in a region that is out of stock:
5880 #
5881 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5882 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5883 # &quot;metadata&quot;: {
5884 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5885 # }
5886 # }
5887 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5888 # is typically the registered service name of the tool or product that
5889 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5890 # generated by some common infrastructure, the error domain must be a
5891 # globally unique value that identifies the infrastructure. For Google API
5892 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5893 &quot;metadatas&quot;: { # Additional structured details about this error.
5894 #
5895 # Keys must match a regular expression of `a-z+` but should
5896 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5897 # length. When identifying the current value of an exceeded limit, the units
5898 # should be contained in the key, not the value. For example, rather than
5899 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5900 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5901 # instances that can be created in a single (batch) request.
5902 &quot;a_key&quot;: &quot;A String&quot;,
5903 },
5904 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5905 # proximate cause of the error. Error reasons are unique within a particular
5906 # domain of errors. This should be at most 63 characters and match a
5907 # regular expression of `A-Z+[A-Z0-9]`, which represents
5908 # UPPER_SNAKE_CASE.
5909 },
5910 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5911 #
5912 # For example, if a quota check failed with an error indicating the calling
5913 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5914 # directly to the right place in the developer console to flip the bit.
5915 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5916 { # Describes a URL link.
5917 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5918 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5919 },
5920 ],
5921 },
5922 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5923 # which can be attached to an RPC error.
5924 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5925 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5926 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5927 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5928 },
5929 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5930 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5931 &quot;a_key&quot;: &quot;A String&quot;,
5932 },
5933 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5934 # type or metric.
5935 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5936 # or metric.
5937 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5938 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5939 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5940 },
5941 },
5942 ],
5943 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5944 # This property is optional.
5945 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5946 },
5947 ],
5948 },
5949 &quot;getVersionOperationMetadata&quot;: {
5950 &quot;inlineSbomInfo&quot;: {
5951 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5952 # appropriate identifiers.
5953 &quot;a_key&quot;: &quot;A String&quot;,
5954 },
5955 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5956 # identifiers.
5957 &quot;a_key&quot;: &quot;A String&quot;,
5958 },
5959 },
5960 },
5961 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5962 # message that was returned, such as `NOT FOUND`.
5963 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5964 # status code that was returned. For example, a `404` means the
5965 # resource was not found.
5966 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5967 # defined by the server.
5968 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5969 # This value is inRFC3339
5970 # text format.
5971 &quot;instancesBulkInsertOperationMetadata&quot;: {
5972 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5973 # Example key: zones/us-central1-a
5974 &quot;a_key&quot;: {
5975 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5976 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5977 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5978 # error.
5979 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5980 # if the flow is rolling forward or rolling back.
5981 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5982 },
5983 },
5984 },
5985 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5986 # Operation resources.
5987 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5988 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5989 # group of operations results from a `bulkInsert` API request.
5990 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5991 # `update`, or `delete`, and so on.
5992 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5993 # There is no requirement that this be linear or support any granularity of
5994 # operations. This should not be used to guess when the operation will be
5995 # complete. This number should monotonically increase as the operation
5996 # progresses.
5997 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5998 # applicable when performing regional operations.
5999 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6000 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6001 # this field will contain information on all underlying zonal actions and
6002 # their state.
6003 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6004 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6005 # Example key: zones/us-central1-a
6006 &quot;a_key&quot;: {
6007 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
6008 # populated.
6009 # different programming environments, including REST APIs and RPC APIs. It is
6010 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6011 # three pieces of data: error code, error message, and error details.
6012 #
6013 # You can find out more about this error model and how to work with it in the
6014 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6015 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6016 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6017 # message types for APIs to use.
6018 {
6019 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6020 },
6021 ],
6022 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6023 # user-facing error message should be localized and sent in the
6024 # google.rpc.Status.details field, or localized by the client.
6025 },
6026 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6027 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6028 },
6029 },
6030 },
6031 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6032 # This value is inRFC3339
6033 # text format.
6034 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6035 # following:
6036 # `PENDING`, `RUNNING`, or `DONE`.
6037 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6038 # operation.
6039 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6040 # of the target resource.
6041 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6042 # operations related to creating a snapshot, this points to the disk
6043 # that the snapshot was created from.
6044 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6045 # `[email protected]` or
6046 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6047 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6048 # operation, this field will be populated.
6049 {
6050 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6051 # Engine returns NO_RESULTS_ON_PAGE if there
6052 # are no results in the response.
6053 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6054 # value format. For example:
6055 #
6056 # &quot;data&quot;: [
6057 # {
6058 # &quot;key&quot;: &quot;scope&quot;,
6059 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6060 # }
6061 {
6062 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6063 # returned. For example, for warnings where there are no results in a list
6064 # request for a particular zone, this key might be scope and
6065 # the key value might be the zone name. Other examples might be a key
6066 # indicating a deprecated resource and a suggested replacement, or a
6067 # warning about invalid network settings (for example, if an instance
6068 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6069 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6070 },
6071 ],
6072 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6073 },
6074 ],
6075 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6076 # applicable when performing per-zone operations.
6077 }</pre>
6078 </div>
6079
6080 <div class="method">
6081 <code class="details" id="patchPacketMirroringRule">patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code>
6082 <pre>Patches a packet mirroring rule of the specified priority.
6083
6084 Args:
6085 project: string, Project ID for this request. (required)
6086 firewallPolicy: string, Name of the firewall policy to update. (required)
6087 body: object, The request body.
6088 The object takes the form of:
6089
6090 { # Represents a rule that describes one or more match conditions along with
6091 # the action to be taken when traffic matches this condition (allow or deny).
6092 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
6093 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
6094 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
6095 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
6096 # and &quot;goto_next&quot;.
6097 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
6098 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
6099 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
6100 # the firewall policy rule is not enforced and traffic behaves as if it did
6101 # not exist. If this is unspecified, the firewall policy rule will be
6102 # enabled.
6103 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
6104 # enabled, logs will be exported to the configured export destination in
6105 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
6106 # cannot enable logging on &quot;goto_next&quot; rules.
6107 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
6108 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
6109 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
6110 # Exactly one field must be specified.
6111 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
6112 # Maximum number of destination address groups is 10.
6113 &quot;A String&quot;,
6114 ],
6115 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6116 # traffic destination.
6117 # Maximum number of destination fqdn allowed is 100.
6118 &quot;A String&quot;,
6119 ],
6120 &quot;destIpRanges&quot;: [ # CIDR IP address range.
6121 # Maximum number of destination CIDR IP ranges allowed is 5000.
6122 &quot;A String&quot;,
6123 ],
6124 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
6125 #
6126 #
6127 # - UNSPECIFIED
6128 # - INTERNET
6129 # - NON_INTERNET
6130 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
6131 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
6132 #
6133 #
6134 # - UNSPECIFIED
6135 # - INTERNET
6136 # - NON_INTERNET
6137 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
6138 # of traffic. Should be specified as 2 letter country code defined as per
6139 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6140 # Maximum number of dest region codes allowed is 5000.
6141 &quot;A String&quot;,
6142 ],
6143 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6144 # The IPs in these lists will be matched against traffic destination.
6145 &quot;A String&quot;,
6146 ],
6147 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
6148 {
6149 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
6150 # required when creating a firewall rule. This value can either be
6151 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
6152 # protocol number.
6153 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
6154 # only applicable for UDP or TCP protocol. Each entry must be either
6155 # an integer or a range. If not specified, this rule applies to
6156 # connections through any port.
6157 #
6158 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
6159 &quot;A String&quot;,
6160 ],
6161 },
6162 ],
6163 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
6164 # Maximum number of source address groups is 10.
6165 &quot;A String&quot;,
6166 ],
6167 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6168 # traffic source.
6169 # Maximum number of source fqdn allowed is 100.
6170 &quot;A String&quot;,
6171 ],
6172 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
6173 # Maximum number of source CIDR IP ranges allowed is 5000.
6174 &quot;A String&quot;,
6175 ],
6176 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
6177 #
6178 #
6179 # - UNSPECIFIED
6180 # - INTERNET
6181 # - INTRA_VPC
6182 # - NON_INTERNET
6183 # - VPC_NETWORKS
6184 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
6185 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
6186 #
6187 #
6188 # - UNSPECIFIED
6189 # - INTERNET
6190 # - INTRA_VPC
6191 # - NON_INTERNET
6192 # - VPC_NETWORKS
6193 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
6194 &quot;A String&quot;,
6195 ],
6196 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
6197 # of traffic. Should be specified as 2 letter country code defined as per
6198 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6199 # Maximum number of source region codes allowed is 5000.
6200 &quot;A String&quot;,
6201 ],
6202 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
6203 # of the traffic.
6204 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
6205 # and there is no srcIpRange, this rule will be ignored.
6206 # Maximum number of source tag values allowed is 256.
6207 {
6208 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6209 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6210 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6211 # or its network is deleted.
6212 },
6213 ],
6214 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6215 # The IPs in these lists will be matched against traffic source.
6216 &quot;A String&quot;,
6217 ],
6218 },
6219 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
6220 # must be a positive value between 0 and 2147483647.
6221 # Rules are evaluated from highest to lowest priority where 0 is the
6222 # highest priority and 2147483647 is the lowest priority.
6223 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
6224 # and can be updated.
6225 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
6226 # rule.
6227 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
6228 # Example:
6229 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
6230 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
6231 # &#x27;mirror&#x27;. Cannot be specified for other actions.
6232 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
6233 # This field allows you to control which load balancers get this rule.
6234 # For example, the following are valid values:
6235 #
6236 #
6237 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
6238 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
6239 # - projects/project/global/
6240 # forwardingRules/forwardingRule
6241 # - projects/project/regions/region/forwardingRules/
6242 # forwardingRule
6243 &quot;A String&quot;,
6244 ],
6245 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
6246 # allows you to control which network&#x27;s VMs get this rule. If this field
6247 # is left blank, all VMs within the organization will receive the rule.
6248 &quot;A String&quot;,
6249 ],
6250 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
6251 # applies to. If targetSecureTag are specified, then the
6252 # firewall rule applies only to instances in the VPC network that have one
6253 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
6254 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
6255 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
6256 # to all instances on the specified network.
6257 # Maximum number of target label tags allowed is 256.
6258 {
6259 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6260 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6261 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6262 # or its network is deleted.
6263 },
6264 ],
6265 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
6266 # applied with this rule.
6267 &quot;A String&quot;,
6268 ],
6269 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
6270 # Default value is INSTANCES.
6271 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
6272 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
6273 # be set for other actions.
6274 }
6275
6276 priority: integer, The priority of the rule to patch.
6277 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6278 that if you must retry your request, the server will know to ignore the
6279 request if it has already been completed.
6280
6281 For example, consider a situation where you make an initial request and
6282 the request times out. If you make the request again with the same
6283 request ID, the server can check if original operation with the same
6284 request ID was received, and if so, will ignore the second request. This
6285 prevents clients from accidentally creating duplicate commitments.
6286
6287 The request ID must be
6288 a valid UUID with the exception that zero UUID is not supported
6289 (00000000-0000-0000-0000-000000000000).
6290 x__xgafv: string, V1 error format.
6291 Allowed values
6292 1 - v1 error format
6293 2 - v2 error format
6294
6295 Returns:
6296 An object of the form:
6297
6298 { # Represents an Operation resource.
6299 #
6300 # Google Compute Engine has three Operation resources:
6301 #
6302 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6303 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6304 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6305 #
6306 # You can use an operation resource to manage asynchronous API requests.
6307 # For more information, readHandling
6308 # API responses.
6309 #
6310 # Operations can be global, regional or zonal.
6311 #
6312 # - For global operations, use the `globalOperations`
6313 # resource.
6314 # - For regional operations, use the
6315 # `regionOperations` resource.
6316 # - For zonal operations, use
6317 # the `zoneOperations` resource.
6318 #
6319 #
6320 #
6321 # For more information, read
6322 # Global, Regional, and Zonal Resources.
6323 #
6324 # Note that completed Operation resources have a limited
6325 # retention period.
6326 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6327 # Not present otherwise.
6328 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6329 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6330 # set when the operation is created.
6331 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6332 # text format.
6333 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6334 # this field will be populated.
6335 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6336 # operation.
6337 {
6338 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6339 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6340 # details. There is a set of defined message types to use for providing
6341 # details.The syntax depends on the error code. For example,
6342 # QuotaExceededInfo will have details when the error code is
6343 # QUOTA_EXCEEDED.
6344 {
6345 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6346 #
6347 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6348 # is not enabled:
6349 #
6350 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6351 # &quot;domain&quot;: &quot;googleapis.com&quot;
6352 # &quot;metadata&quot;: {
6353 # &quot;resource&quot;: &quot;projects/123&quot;,
6354 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6355 # }
6356 # }
6357 #
6358 # This response indicates that the pubsub.googleapis.com API is not enabled.
6359 #
6360 # Example of an error that is returned when attempting to create a Spanner
6361 # instance in a region that is out of stock:
6362 #
6363 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6364 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6365 # &quot;metadata&quot;: {
6366 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6367 # }
6368 # }
6369 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6370 # is typically the registered service name of the tool or product that
6371 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6372 # generated by some common infrastructure, the error domain must be a
6373 # globally unique value that identifies the infrastructure. For Google API
6374 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6375 &quot;metadatas&quot;: { # Additional structured details about this error.
6376 #
6377 # Keys must match a regular expression of `a-z+` but should
6378 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6379 # length. When identifying the current value of an exceeded limit, the units
6380 # should be contained in the key, not the value. For example, rather than
6381 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6382 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6383 # instances that can be created in a single (batch) request.
6384 &quot;a_key&quot;: &quot;A String&quot;,
6385 },
6386 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6387 # proximate cause of the error. Error reasons are unique within a particular
6388 # domain of errors. This should be at most 63 characters and match a
6389 # regular expression of `A-Z+[A-Z0-9]`, which represents
6390 # UPPER_SNAKE_CASE.
6391 },
6392 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6393 #
6394 # For example, if a quota check failed with an error indicating the calling
6395 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6396 # directly to the right place in the developer console to flip the bit.
6397 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6398 { # Describes a URL link.
6399 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6400 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6401 },
6402 ],
6403 },
6404 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6405 # which can be attached to an RPC error.
6406 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6407 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6408 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6409 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6410 },
6411 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6412 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6413 &quot;a_key&quot;: &quot;A String&quot;,
6414 },
6415 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6416 # type or metric.
6417 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6418 # or metric.
6419 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6420 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6421 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6422 },
6423 },
6424 ],
6425 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6426 # This property is optional.
6427 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6428 },
6429 ],
6430 },
6431 &quot;getVersionOperationMetadata&quot;: {
6432 &quot;inlineSbomInfo&quot;: {
6433 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6434 # appropriate identifiers.
6435 &quot;a_key&quot;: &quot;A String&quot;,
6436 },
6437 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6438 # identifiers.
6439 &quot;a_key&quot;: &quot;A String&quot;,
6440 },
6441 },
6442 },
6443 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6444 # message that was returned, such as `NOT FOUND`.
6445 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6446 # status code that was returned. For example, a `404` means the
6447 # resource was not found.
6448 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6449 # defined by the server.
6450 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6451 # This value is inRFC3339
6452 # text format.
6453 &quot;instancesBulkInsertOperationMetadata&quot;: {
6454 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6455 # Example key: zones/us-central1-a
6456 &quot;a_key&quot;: {
6457 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6458 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6459 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6460 # error.
6461 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6462 # if the flow is rolling forward or rolling back.
6463 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6464 },
6465 },
6466 },
6467 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6468 # Operation resources.
6469 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6470 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6471 # group of operations results from a `bulkInsert` API request.
6472 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6473 # `update`, or `delete`, and so on.
6474 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6475 # There is no requirement that this be linear or support any granularity of
6476 # operations. This should not be used to guess when the operation will be
6477 # complete. This number should monotonically increase as the operation
6478 # progresses.
6479 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6480 # applicable when performing regional operations.
6481 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6482 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6483 # this field will contain information on all underlying zonal actions and
6484 # their state.
6485 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6486 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6487 # Example key: zones/us-central1-a
6488 &quot;a_key&quot;: {
6489 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
6490 # populated.
6491 # different programming environments, including REST APIs and RPC APIs. It is
6492 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6493 # three pieces of data: error code, error message, and error details.
6494 #
6495 # You can find out more about this error model and how to work with it in the
6496 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6497 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6498 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6499 # message types for APIs to use.
6500 {
6501 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6502 },
6503 ],
6504 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6505 # user-facing error message should be localized and sent in the
6506 # google.rpc.Status.details field, or localized by the client.
6507 },
6508 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6509 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6510 },
6511 },
6512 },
6513 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6514 # This value is inRFC3339
6515 # text format.
6516 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6517 # following:
6518 # `PENDING`, `RUNNING`, or `DONE`.
6519 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6520 # operation.
6521 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6522 # of the target resource.
6523 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6524 # operations related to creating a snapshot, this points to the disk
6525 # that the snapshot was created from.
6526 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6527 # `[email protected]` or
6528 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6529 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6530 # operation, this field will be populated.
6531 {
6532 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6533 # Engine returns NO_RESULTS_ON_PAGE if there
6534 # are no results in the response.
6535 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6536 # value format. For example:
6537 #
6538 # &quot;data&quot;: [
6539 # {
6540 # &quot;key&quot;: &quot;scope&quot;,
6541 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6542 # }
6543 {
6544 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6545 # returned. For example, for warnings where there are no results in a list
6546 # request for a particular zone, this key might be scope and
6547 # the key value might be the zone name. Other examples might be a key
6548 # indicating a deprecated resource and a suggested replacement, or a
6549 # warning about invalid network settings (for example, if an instance
6550 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6551 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6552 },
6553 ],
6554 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6555 },
6556 ],
6557 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6558 # applicable when performing per-zone operations.
6559 }</pre>
6560 </div>
6561
6562 <div class="method">
6563 <code class="details" id="patchRule">patchRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code>
6564 <pre>Patches a rule of the specified priority.
6565
6566 Args:
6567 project: string, Project ID for this request. (required)
6568 firewallPolicy: string, Name of the firewall policy to update. (required)
6569 body: object, The request body.
6570 The object takes the form of:
6571
6572 { # Represents a rule that describes one or more match conditions along with
6573 # the action to be taken when traffic matches this condition (allow or deny).
6574 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
6575 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
6576 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
6577 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
6578 # and &quot;goto_next&quot;.
6579 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
6580 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
6581 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
6582 # the firewall policy rule is not enforced and traffic behaves as if it did
6583 # not exist. If this is unspecified, the firewall policy rule will be
6584 # enabled.
6585 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
6586 # enabled, logs will be exported to the configured export destination in
6587 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
6588 # cannot enable logging on &quot;goto_next&quot; rules.
6589 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
6590 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
6591 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
6592 # Exactly one field must be specified.
6593 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
6594 # Maximum number of destination address groups is 10.
6595 &quot;A String&quot;,
6596 ],
6597 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6598 # traffic destination.
6599 # Maximum number of destination fqdn allowed is 100.
6600 &quot;A String&quot;,
6601 ],
6602 &quot;destIpRanges&quot;: [ # CIDR IP address range.
6603 # Maximum number of destination CIDR IP ranges allowed is 5000.
6604 &quot;A String&quot;,
6605 ],
6606 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
6607 #
6608 #
6609 # - UNSPECIFIED
6610 # - INTERNET
6611 # - NON_INTERNET
6612 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
6613 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
6614 #
6615 #
6616 # - UNSPECIFIED
6617 # - INTERNET
6618 # - NON_INTERNET
6619 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
6620 # of traffic. Should be specified as 2 letter country code defined as per
6621 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6622 # Maximum number of dest region codes allowed is 5000.
6623 &quot;A String&quot;,
6624 ],
6625 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6626 # The IPs in these lists will be matched against traffic destination.
6627 &quot;A String&quot;,
6628 ],
6629 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
6630 {
6631 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
6632 # required when creating a firewall rule. This value can either be
6633 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
6634 # protocol number.
6635 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
6636 # only applicable for UDP or TCP protocol. Each entry must be either
6637 # an integer or a range. If not specified, this rule applies to
6638 # connections through any port.
6639 #
6640 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
6641 &quot;A String&quot;,
6642 ],
6643 },
6644 ],
6645 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
6646 # Maximum number of source address groups is 10.
6647 &quot;A String&quot;,
6648 ],
6649 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6650 # traffic source.
6651 # Maximum number of source fqdn allowed is 100.
6652 &quot;A String&quot;,
6653 ],
6654 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
6655 # Maximum number of source CIDR IP ranges allowed is 5000.
6656 &quot;A String&quot;,
6657 ],
6658 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
6659 #
6660 #
6661 # - UNSPECIFIED
6662 # - INTERNET
6663 # - INTRA_VPC
6664 # - NON_INTERNET
6665 # - VPC_NETWORKS
6666 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
6667 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
6668 #
6669 #
6670 # - UNSPECIFIED
6671 # - INTERNET
6672 # - INTRA_VPC
6673 # - NON_INTERNET
6674 # - VPC_NETWORKS
6675 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
6676 &quot;A String&quot;,
6677 ],
6678 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
6679 # of traffic. Should be specified as 2 letter country code defined as per
6680 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6681 # Maximum number of source region codes allowed is 5000.
6682 &quot;A String&quot;,
6683 ],
6684 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
6685 # of the traffic.
6686 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
6687 # and there is no srcIpRange, this rule will be ignored.
6688 # Maximum number of source tag values allowed is 256.
6689 {
6690 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6691 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6692 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6693 # or its network is deleted.
6694 },
6695 ],
6696 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6697 # The IPs in these lists will be matched against traffic source.
6698 &quot;A String&quot;,
6699 ],
6700 },
6701 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
6702 # must be a positive value between 0 and 2147483647.
6703 # Rules are evaluated from highest to lowest priority where 0 is the
6704 # highest priority and 2147483647 is the lowest priority.
6705 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
6706 # and can be updated.
6707 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
6708 # rule.
6709 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
6710 # Example:
6711 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
6712 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
6713 # &#x27;mirror&#x27;. Cannot be specified for other actions.
6714 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
6715 # This field allows you to control which load balancers get this rule.
6716 # For example, the following are valid values:
6717 #
6718 #
6719 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
6720 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
6721 # - projects/project/global/
6722 # forwardingRules/forwardingRule
6723 # - projects/project/regions/region/forwardingRules/
6724 # forwardingRule
6725 &quot;A String&quot;,
6726 ],
6727 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
6728 # allows you to control which network&#x27;s VMs get this rule. If this field
6729 # is left blank, all VMs within the organization will receive the rule.
6730 &quot;A String&quot;,
6731 ],
6732 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
6733 # applies to. If targetSecureTag are specified, then the
6734 # firewall rule applies only to instances in the VPC network that have one
6735 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
6736 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
6737 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
6738 # to all instances on the specified network.
6739 # Maximum number of target label tags allowed is 256.
6740 {
6741 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6742 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6743 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6744 # or its network is deleted.
6745 },
6746 ],
6747 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
6748 # applied with this rule.
6749 &quot;A String&quot;,
6750 ],
6751 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
6752 # Default value is INSTANCES.
6753 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
6754 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
6755 # be set for other actions.
6756 }
6757
6758 priority: integer, The priority of the rule to patch.
6759 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6760 that if you must retry your request, the server will know to ignore the
6761 request if it has already been completed.
6762
6763 For example, consider a situation where you make an initial request and
6764 the request times out. If you make the request again with the same
6765 request ID, the server can check if original operation with the same
6766 request ID was received, and if so, will ignore the second request. This
6767 prevents clients from accidentally creating duplicate commitments.
6768
6769 The request ID must be
6770 a valid UUID with the exception that zero UUID is not supported
6771 (00000000-0000-0000-0000-000000000000).
6772 x__xgafv: string, V1 error format.
6773 Allowed values
6774 1 - v1 error format
6775 2 - v2 error format
6776
6777 Returns:
6778 An object of the form:
6779
6780 { # Represents an Operation resource.
6781 #
6782 # Google Compute Engine has three Operation resources:
6783 #
6784 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6785 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6786 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6787 #
6788 # You can use an operation resource to manage asynchronous API requests.
6789 # For more information, readHandling
6790 # API responses.
6791 #
6792 # Operations can be global, regional or zonal.
6793 #
6794 # - For global operations, use the `globalOperations`
6795 # resource.
6796 # - For regional operations, use the
6797 # `regionOperations` resource.
6798 # - For zonal operations, use
6799 # the `zoneOperations` resource.
6800 #
6801 #
6802 #
6803 # For more information, read
6804 # Global, Regional, and Zonal Resources.
6805 #
6806 # Note that completed Operation resources have a limited
6807 # retention period.
6808 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6809 # Not present otherwise.
6810 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6811 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6812 # set when the operation is created.
6813 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6814 # text format.
6815 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6816 # this field will be populated.
6817 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6818 # operation.
6819 {
6820 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6821 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6822 # details. There is a set of defined message types to use for providing
6823 # details.The syntax depends on the error code. For example,
6824 # QuotaExceededInfo will have details when the error code is
6825 # QUOTA_EXCEEDED.
6826 {
6827 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6828 #
6829 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6830 # is not enabled:
6831 #
6832 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6833 # &quot;domain&quot;: &quot;googleapis.com&quot;
6834 # &quot;metadata&quot;: {
6835 # &quot;resource&quot;: &quot;projects/123&quot;,
6836 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6837 # }
6838 # }
6839 #
6840 # This response indicates that the pubsub.googleapis.com API is not enabled.
6841 #
6842 # Example of an error that is returned when attempting to create a Spanner
6843 # instance in a region that is out of stock:
6844 #
6845 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6846 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6847 # &quot;metadata&quot;: {
6848 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6849 # }
6850 # }
6851 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6852 # is typically the registered service name of the tool or product that
6853 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6854 # generated by some common infrastructure, the error domain must be a
6855 # globally unique value that identifies the infrastructure. For Google API
6856 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6857 &quot;metadatas&quot;: { # Additional structured details about this error.
6858 #
6859 # Keys must match a regular expression of `a-z+` but should
6860 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6861 # length. When identifying the current value of an exceeded limit, the units
6862 # should be contained in the key, not the value. For example, rather than
6863 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6864 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6865 # instances that can be created in a single (batch) request.
6866 &quot;a_key&quot;: &quot;A String&quot;,
6867 },
6868 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6869 # proximate cause of the error. Error reasons are unique within a particular
6870 # domain of errors. This should be at most 63 characters and match a
6871 # regular expression of `A-Z+[A-Z0-9]`, which represents
6872 # UPPER_SNAKE_CASE.
6873 },
6874 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6875 #
6876 # For example, if a quota check failed with an error indicating the calling
6877 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6878 # directly to the right place in the developer console to flip the bit.
6879 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6880 { # Describes a URL link.
6881 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6882 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6883 },
6884 ],
6885 },
6886 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6887 # which can be attached to an RPC error.
6888 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6889 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6890 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6891 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6892 },
6893 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6894 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6895 &quot;a_key&quot;: &quot;A String&quot;,
6896 },
6897 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6898 # type or metric.
6899 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6900 # or metric.
6901 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6902 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6903 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6904 },
6905 },
6906 ],
6907 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6908 # This property is optional.
6909 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6910 },
6911 ],
6912 },
6913 &quot;getVersionOperationMetadata&quot;: {
6914 &quot;inlineSbomInfo&quot;: {
6915 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6916 # appropriate identifiers.
6917 &quot;a_key&quot;: &quot;A String&quot;,
6918 },
6919 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6920 # identifiers.
6921 &quot;a_key&quot;: &quot;A String&quot;,
6922 },
6923 },
6924 },
6925 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6926 # message that was returned, such as `NOT FOUND`.
6927 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6928 # status code that was returned. For example, a `404` means the
6929 # resource was not found.
6930 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6931 # defined by the server.
6932 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6933 # This value is inRFC3339
6934 # text format.
6935 &quot;instancesBulkInsertOperationMetadata&quot;: {
6936 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6937 # Example key: zones/us-central1-a
6938 &quot;a_key&quot;: {
6939 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6940 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6941 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6942 # error.
6943 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6944 # if the flow is rolling forward or rolling back.
6945 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6946 },
6947 },
6948 },
6949 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6950 # Operation resources.
6951 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6952 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6953 # group of operations results from a `bulkInsert` API request.
6954 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6955 # `update`, or `delete`, and so on.
6956 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6957 # There is no requirement that this be linear or support any granularity of
6958 # operations. This should not be used to guess when the operation will be
6959 # complete. This number should monotonically increase as the operation
6960 # progresses.
6961 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6962 # applicable when performing regional operations.
6963 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6964 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6965 # this field will contain information on all underlying zonal actions and
6966 # their state.
6967 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6968 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6969 # Example key: zones/us-central1-a
6970 &quot;a_key&quot;: {
6971 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
6972 # populated.
6973 # different programming environments, including REST APIs and RPC APIs. It is
6974 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6975 # three pieces of data: error code, error message, and error details.
6976 #
6977 # You can find out more about this error model and how to work with it in the
6978 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6979 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6980 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6981 # message types for APIs to use.
6982 {
6983 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6984 },
6985 ],
6986 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6987 # user-facing error message should be localized and sent in the
6988 # google.rpc.Status.details field, or localized by the client.
6989 },
6990 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6991 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6992 },
6993 },
6994 },
6995 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6996 # This value is inRFC3339
6997 # text format.
6998 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6999 # following:
7000 # `PENDING`, `RUNNING`, or `DONE`.
7001 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7002 # operation.
7003 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7004 # of the target resource.
7005 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7006 # operations related to creating a snapshot, this points to the disk
7007 # that the snapshot was created from.
7008 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7009 # `[email protected]` or
7010 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7011 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7012 # operation, this field will be populated.
7013 {
7014 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7015 # Engine returns NO_RESULTS_ON_PAGE if there
7016 # are no results in the response.
7017 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7018 # value format. For example:
7019 #
7020 # &quot;data&quot;: [
7021 # {
7022 # &quot;key&quot;: &quot;scope&quot;,
7023 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7024 # }
7025 {
7026 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7027 # returned. For example, for warnings where there are no results in a list
7028 # request for a particular zone, this key might be scope and
7029 # the key value might be the zone name. Other examples might be a key
7030 # indicating a deprecated resource and a suggested replacement, or a
7031 # warning about invalid network settings (for example, if an instance
7032 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7033 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7034 },
7035 ],
7036 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7037 },
7038 ],
7039 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7040 # applicable when performing per-zone operations.
7041 }</pre>
7042 </div>
7043
7044 <div class="method">
7045 <code class="details" id="removeAssociation">removeAssociation(project, firewallPolicy, name=None, requestId=None, x__xgafv=None)</code>
7046 <pre>Removes an association for the specified firewall policy.
7047
7048 Args:
7049 project: string, Project ID for this request. (required)
7050 firewallPolicy: string, Name of the firewall policy to update. (required)
7051 name: string, Name for the attachment that will be removed.
7052 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7053 that if you must retry your request, the server will know to ignore the
7054 request if it has already been completed.
7055
7056 For example, consider a situation where you make an initial request and
7057 the request times out. If you make the request again with the same
7058 request ID, the server can check if original operation with the same
7059 request ID was received, and if so, will ignore the second request. This
7060 prevents clients from accidentally creating duplicate commitments.
7061
7062 The request ID must be
7063 a valid UUID with the exception that zero UUID is not supported
7064 (00000000-0000-0000-0000-000000000000).
7065 x__xgafv: string, V1 error format.
7066 Allowed values
7067 1 - v1 error format
7068 2 - v2 error format
7069
7070 Returns:
7071 An object of the form:
7072
7073 { # Represents an Operation resource.
7074 #
7075 # Google Compute Engine has three Operation resources:
7076 #
7077 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
7078 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
7079 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
7080 #
7081 # You can use an operation resource to manage asynchronous API requests.
7082 # For more information, readHandling
7083 # API responses.
7084 #
7085 # Operations can be global, regional or zonal.
7086 #
7087 # - For global operations, use the `globalOperations`
7088 # resource.
7089 # - For regional operations, use the
7090 # `regionOperations` resource.
7091 # - For zonal operations, use
7092 # the `zoneOperations` resource.
7093 #
7094 #
7095 #
7096 # For more information, read
7097 # Global, Regional, and Zonal Resources.
7098 #
7099 # Note that completed Operation resources have a limited
7100 # retention period.
7101 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7102 # Not present otherwise.
7103 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7104 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7105 # set when the operation is created.
7106 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7107 # text format.
7108 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7109 # this field will be populated.
7110 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7111 # operation.
7112 {
7113 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7114 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7115 # details. There is a set of defined message types to use for providing
7116 # details.The syntax depends on the error code. For example,
7117 # QuotaExceededInfo will have details when the error code is
7118 # QUOTA_EXCEEDED.
7119 {
7120 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7121 #
7122 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7123 # is not enabled:
7124 #
7125 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7126 # &quot;domain&quot;: &quot;googleapis.com&quot;
7127 # &quot;metadata&quot;: {
7128 # &quot;resource&quot;: &quot;projects/123&quot;,
7129 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7130 # }
7131 # }
7132 #
7133 # This response indicates that the pubsub.googleapis.com API is not enabled.
7134 #
7135 # Example of an error that is returned when attempting to create a Spanner
7136 # instance in a region that is out of stock:
7137 #
7138 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7139 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7140 # &quot;metadata&quot;: {
7141 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7142 # }
7143 # }
7144 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7145 # is typically the registered service name of the tool or product that
7146 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7147 # generated by some common infrastructure, the error domain must be a
7148 # globally unique value that identifies the infrastructure. For Google API
7149 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7150 &quot;metadatas&quot;: { # Additional structured details about this error.
7151 #
7152 # Keys must match a regular expression of `a-z+` but should
7153 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7154 # length. When identifying the current value of an exceeded limit, the units
7155 # should be contained in the key, not the value. For example, rather than
7156 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7157 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7158 # instances that can be created in a single (batch) request.
7159 &quot;a_key&quot;: &quot;A String&quot;,
7160 },
7161 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7162 # proximate cause of the error. Error reasons are unique within a particular
7163 # domain of errors. This should be at most 63 characters and match a
7164 # regular expression of `A-Z+[A-Z0-9]`, which represents
7165 # UPPER_SNAKE_CASE.
7166 },
7167 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7168 #
7169 # For example, if a quota check failed with an error indicating the calling
7170 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7171 # directly to the right place in the developer console to flip the bit.
7172 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7173 { # Describes a URL link.
7174 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7175 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7176 },
7177 ],
7178 },
7179 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7180 # which can be attached to an RPC error.
7181 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7182 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7183 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7184 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7185 },
7186 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7187 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7188 &quot;a_key&quot;: &quot;A String&quot;,
7189 },
7190 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7191 # type or metric.
7192 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7193 # or metric.
7194 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7195 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7196 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7197 },
7198 },
7199 ],
7200 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7201 # This property is optional.
7202 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7203 },
7204 ],
7205 },
7206 &quot;getVersionOperationMetadata&quot;: {
7207 &quot;inlineSbomInfo&quot;: {
7208 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7209 # appropriate identifiers.
7210 &quot;a_key&quot;: &quot;A String&quot;,
7211 },
7212 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7213 # identifiers.
7214 &quot;a_key&quot;: &quot;A String&quot;,
7215 },
7216 },
7217 },
7218 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7219 # message that was returned, such as `NOT FOUND`.
7220 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7221 # status code that was returned. For example, a `404` means the
7222 # resource was not found.
7223 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7224 # defined by the server.
7225 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7226 # This value is inRFC3339
7227 # text format.
7228 &quot;instancesBulkInsertOperationMetadata&quot;: {
7229 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7230 # Example key: zones/us-central1-a
7231 &quot;a_key&quot;: {
7232 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7233 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7234 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7235 # error.
7236 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7237 # if the flow is rolling forward or rolling back.
7238 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7239 },
7240 },
7241 },
7242 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7243 # Operation resources.
7244 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7245 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7246 # group of operations results from a `bulkInsert` API request.
7247 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7248 # `update`, or `delete`, and so on.
7249 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7250 # There is no requirement that this be linear or support any granularity of
7251 # operations. This should not be used to guess when the operation will be
7252 # complete. This number should monotonically increase as the operation
7253 # progresses.
7254 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7255 # applicable when performing regional operations.
7256 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7257 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7258 # this field will contain information on all underlying zonal actions and
7259 # their state.
7260 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7261 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7262 # Example key: zones/us-central1-a
7263 &quot;a_key&quot;: {
7264 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
7265 # populated.
7266 # different programming environments, including REST APIs and RPC APIs. It is
7267 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7268 # three pieces of data: error code, error message, and error details.
7269 #
7270 # You can find out more about this error model and how to work with it in the
7271 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7272 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7273 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7274 # message types for APIs to use.
7275 {
7276 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7277 },
7278 ],
7279 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7280 # user-facing error message should be localized and sent in the
7281 # google.rpc.Status.details field, or localized by the client.
7282 },
7283 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7284 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7285 },
7286 },
7287 },
7288 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7289 # This value is inRFC3339
7290 # text format.
7291 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7292 # following:
7293 # `PENDING`, `RUNNING`, or `DONE`.
7294 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7295 # operation.
7296 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7297 # of the target resource.
7298 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7299 # operations related to creating a snapshot, this points to the disk
7300 # that the snapshot was created from.
7301 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7302 # `[email protected]` or
7303 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7304 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7305 # operation, this field will be populated.
7306 {
7307 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7308 # Engine returns NO_RESULTS_ON_PAGE if there
7309 # are no results in the response.
7310 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7311 # value format. For example:
7312 #
7313 # &quot;data&quot;: [
7314 # {
7315 # &quot;key&quot;: &quot;scope&quot;,
7316 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7317 # }
7318 {
7319 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7320 # returned. For example, for warnings where there are no results in a list
7321 # request for a particular zone, this key might be scope and
7322 # the key value might be the zone name. Other examples might be a key
7323 # indicating a deprecated resource and a suggested replacement, or a
7324 # warning about invalid network settings (for example, if an instance
7325 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7326 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7327 },
7328 ],
7329 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7330 },
7331 ],
7332 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7333 # applicable when performing per-zone operations.
7334 }</pre>
7335 </div>
7336
7337 <div class="method">
7338 <code class="details" id="removePacketMirroringRule">removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code>
7339 <pre>Deletes a packet mirroring rule of the specified priority.
7340
7341 Args:
7342 project: string, Project ID for this request. (required)
7343 firewallPolicy: string, Name of the firewall policy to update. (required)
7344 priority: integer, The priority of the rule to remove from the firewall policy.
7345 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7346 that if you must retry your request, the server will know to ignore the
7347 request if it has already been completed.
7348
7349 For example, consider a situation where you make an initial request and
7350 the request times out. If you make the request again with the same
7351 request ID, the server can check if original operation with the same
7352 request ID was received, and if so, will ignore the second request. This
7353 prevents clients from accidentally creating duplicate commitments.
7354
7355 The request ID must be
7356 a valid UUID with the exception that zero UUID is not supported
7357 (00000000-0000-0000-0000-000000000000).
7358 x__xgafv: string, V1 error format.
7359 Allowed values
7360 1 - v1 error format
7361 2 - v2 error format
7362
7363 Returns:
7364 An object of the form:
7365
7366 { # Represents an Operation resource.
7367 #
7368 # Google Compute Engine has three Operation resources:
7369 #
7370 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
7371 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
7372 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
7373 #
7374 # You can use an operation resource to manage asynchronous API requests.
7375 # For more information, readHandling
7376 # API responses.
7377 #
7378 # Operations can be global, regional or zonal.
7379 #
7380 # - For global operations, use the `globalOperations`
7381 # resource.
7382 # - For regional operations, use the
7383 # `regionOperations` resource.
7384 # - For zonal operations, use
7385 # the `zoneOperations` resource.
7386 #
7387 #
7388 #
7389 # For more information, read
7390 # Global, Regional, and Zonal Resources.
7391 #
7392 # Note that completed Operation resources have a limited
7393 # retention period.
7394 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7395 # Not present otherwise.
7396 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7397 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7398 # set when the operation is created.
7399 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7400 # text format.
7401 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7402 # this field will be populated.
7403 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7404 # operation.
7405 {
7406 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7407 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7408 # details. There is a set of defined message types to use for providing
7409 # details.The syntax depends on the error code. For example,
7410 # QuotaExceededInfo will have details when the error code is
7411 # QUOTA_EXCEEDED.
7412 {
7413 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7414 #
7415 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7416 # is not enabled:
7417 #
7418 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7419 # &quot;domain&quot;: &quot;googleapis.com&quot;
7420 # &quot;metadata&quot;: {
7421 # &quot;resource&quot;: &quot;projects/123&quot;,
7422 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7423 # }
7424 # }
7425 #
7426 # This response indicates that the pubsub.googleapis.com API is not enabled.
7427 #
7428 # Example of an error that is returned when attempting to create a Spanner
7429 # instance in a region that is out of stock:
7430 #
7431 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7432 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7433 # &quot;metadata&quot;: {
7434 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7435 # }
7436 # }
7437 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7438 # is typically the registered service name of the tool or product that
7439 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7440 # generated by some common infrastructure, the error domain must be a
7441 # globally unique value that identifies the infrastructure. For Google API
7442 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7443 &quot;metadatas&quot;: { # Additional structured details about this error.
7444 #
7445 # Keys must match a regular expression of `a-z+` but should
7446 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7447 # length. When identifying the current value of an exceeded limit, the units
7448 # should be contained in the key, not the value. For example, rather than
7449 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7450 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7451 # instances that can be created in a single (batch) request.
7452 &quot;a_key&quot;: &quot;A String&quot;,
7453 },
7454 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7455 # proximate cause of the error. Error reasons are unique within a particular
7456 # domain of errors. This should be at most 63 characters and match a
7457 # regular expression of `A-Z+[A-Z0-9]`, which represents
7458 # UPPER_SNAKE_CASE.
7459 },
7460 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7461 #
7462 # For example, if a quota check failed with an error indicating the calling
7463 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7464 # directly to the right place in the developer console to flip the bit.
7465 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7466 { # Describes a URL link.
7467 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7468 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7469 },
7470 ],
7471 },
7472 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7473 # which can be attached to an RPC error.
7474 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7475 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7476 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7477 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7478 },
7479 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7480 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7481 &quot;a_key&quot;: &quot;A String&quot;,
7482 },
7483 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7484 # type or metric.
7485 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7486 # or metric.
7487 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7488 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7489 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7490 },
7491 },
7492 ],
7493 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7494 # This property is optional.
7495 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7496 },
7497 ],
7498 },
7499 &quot;getVersionOperationMetadata&quot;: {
7500 &quot;inlineSbomInfo&quot;: {
7501 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7502 # appropriate identifiers.
7503 &quot;a_key&quot;: &quot;A String&quot;,
7504 },
7505 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7506 # identifiers.
7507 &quot;a_key&quot;: &quot;A String&quot;,
7508 },
7509 },
7510 },
7511 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7512 # message that was returned, such as `NOT FOUND`.
7513 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7514 # status code that was returned. For example, a `404` means the
7515 # resource was not found.
7516 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7517 # defined by the server.
7518 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7519 # This value is inRFC3339
7520 # text format.
7521 &quot;instancesBulkInsertOperationMetadata&quot;: {
7522 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7523 # Example key: zones/us-central1-a
7524 &quot;a_key&quot;: {
7525 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7526 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7527 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7528 # error.
7529 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7530 # if the flow is rolling forward or rolling back.
7531 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7532 },
7533 },
7534 },
7535 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7536 # Operation resources.
7537 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7538 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7539 # group of operations results from a `bulkInsert` API request.
7540 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7541 # `update`, or `delete`, and so on.
7542 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7543 # There is no requirement that this be linear or support any granularity of
7544 # operations. This should not be used to guess when the operation will be
7545 # complete. This number should monotonically increase as the operation
7546 # progresses.
7547 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7548 # applicable when performing regional operations.
7549 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7550 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7551 # this field will contain information on all underlying zonal actions and
7552 # their state.
7553 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7554 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7555 # Example key: zones/us-central1-a
7556 &quot;a_key&quot;: {
7557 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
7558 # populated.
7559 # different programming environments, including REST APIs and RPC APIs. It is
7560 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7561 # three pieces of data: error code, error message, and error details.
7562 #
7563 # You can find out more about this error model and how to work with it in the
7564 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7565 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7566 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7567 # message types for APIs to use.
7568 {
7569 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7570 },
7571 ],
7572 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7573 # user-facing error message should be localized and sent in the
7574 # google.rpc.Status.details field, or localized by the client.
7575 },
7576 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7577 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7578 },
7579 },
7580 },
7581 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7582 # This value is inRFC3339
7583 # text format.
7584 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7585 # following:
7586 # `PENDING`, `RUNNING`, or `DONE`.
7587 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7588 # operation.
7589 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7590 # of the target resource.
7591 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7592 # operations related to creating a snapshot, this points to the disk
7593 # that the snapshot was created from.
7594 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7595 # `[email protected]` or
7596 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7597 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7598 # operation, this field will be populated.
7599 {
7600 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7601 # Engine returns NO_RESULTS_ON_PAGE if there
7602 # are no results in the response.
7603 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7604 # value format. For example:
7605 #
7606 # &quot;data&quot;: [
7607 # {
7608 # &quot;key&quot;: &quot;scope&quot;,
7609 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7610 # }
7611 {
7612 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7613 # returned. For example, for warnings where there are no results in a list
7614 # request for a particular zone, this key might be scope and
7615 # the key value might be the zone name. Other examples might be a key
7616 # indicating a deprecated resource and a suggested replacement, or a
7617 # warning about invalid network settings (for example, if an instance
7618 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7619 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7620 },
7621 ],
7622 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7623 },
7624 ],
7625 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7626 # applicable when performing per-zone operations.
7627 }</pre>
7628 </div>
7629
7630 <div class="method">
7631 <code class="details" id="removeRule">removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code>
7632 <pre>Deletes a rule of the specified priority.
7633
7634 Args:
7635 project: string, Project ID for this request. (required)
7636 firewallPolicy: string, Name of the firewall policy to update. (required)
7637 priority: integer, The priority of the rule to remove from the firewall policy.
7638 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7639 that if you must retry your request, the server will know to ignore the
7640 request if it has already been completed.
7641
7642 For example, consider a situation where you make an initial request and
7643 the request times out. If you make the request again with the same
7644 request ID, the server can check if original operation with the same
7645 request ID was received, and if so, will ignore the second request. This
7646 prevents clients from accidentally creating duplicate commitments.
7647
7648 The request ID must be
7649 a valid UUID with the exception that zero UUID is not supported
7650 (00000000-0000-0000-0000-000000000000).
7651 x__xgafv: string, V1 error format.
7652 Allowed values
7653 1 - v1 error format
7654 2 - v2 error format
7655
7656 Returns:
7657 An object of the form:
7658
7659 { # Represents an Operation resource.
7660 #
7661 # Google Compute Engine has three Operation resources:
7662 #
7663 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
7664 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
7665 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
7666 #
7667 # You can use an operation resource to manage asynchronous API requests.
7668 # For more information, readHandling
7669 # API responses.
7670 #
7671 # Operations can be global, regional or zonal.
7672 #
7673 # - For global operations, use the `globalOperations`
7674 # resource.
7675 # - For regional operations, use the
7676 # `regionOperations` resource.
7677 # - For zonal operations, use
7678 # the `zoneOperations` resource.
7679 #
7680 #
7681 #
7682 # For more information, read
7683 # Global, Regional, and Zonal Resources.
7684 #
7685 # Note that completed Operation resources have a limited
7686 # retention period.
7687 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7688 # Not present otherwise.
7689 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7690 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7691 # set when the operation is created.
7692 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7693 # text format.
7694 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7695 # this field will be populated.
7696 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7697 # operation.
7698 {
7699 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7700 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7701 # details. There is a set of defined message types to use for providing
7702 # details.The syntax depends on the error code. For example,
7703 # QuotaExceededInfo will have details when the error code is
7704 # QUOTA_EXCEEDED.
7705 {
7706 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7707 #
7708 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7709 # is not enabled:
7710 #
7711 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7712 # &quot;domain&quot;: &quot;googleapis.com&quot;
7713 # &quot;metadata&quot;: {
7714 # &quot;resource&quot;: &quot;projects/123&quot;,
7715 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7716 # }
7717 # }
7718 #
7719 # This response indicates that the pubsub.googleapis.com API is not enabled.
7720 #
7721 # Example of an error that is returned when attempting to create a Spanner
7722 # instance in a region that is out of stock:
7723 #
7724 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7725 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7726 # &quot;metadata&quot;: {
7727 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7728 # }
7729 # }
7730 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7731 # is typically the registered service name of the tool or product that
7732 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7733 # generated by some common infrastructure, the error domain must be a
7734 # globally unique value that identifies the infrastructure. For Google API
7735 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7736 &quot;metadatas&quot;: { # Additional structured details about this error.
7737 #
7738 # Keys must match a regular expression of `a-z+` but should
7739 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7740 # length. When identifying the current value of an exceeded limit, the units
7741 # should be contained in the key, not the value. For example, rather than
7742 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7743 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7744 # instances that can be created in a single (batch) request.
7745 &quot;a_key&quot;: &quot;A String&quot;,
7746 },
7747 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7748 # proximate cause of the error. Error reasons are unique within a particular
7749 # domain of errors. This should be at most 63 characters and match a
7750 # regular expression of `A-Z+[A-Z0-9]`, which represents
7751 # UPPER_SNAKE_CASE.
7752 },
7753 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7754 #
7755 # For example, if a quota check failed with an error indicating the calling
7756 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7757 # directly to the right place in the developer console to flip the bit.
7758 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7759 { # Describes a URL link.
7760 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7761 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7762 },
7763 ],
7764 },
7765 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7766 # which can be attached to an RPC error.
7767 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7768 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7769 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7770 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7771 },
7772 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7773 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7774 &quot;a_key&quot;: &quot;A String&quot;,
7775 },
7776 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7777 # type or metric.
7778 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7779 # or metric.
7780 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7781 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7782 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7783 },
7784 },
7785 ],
7786 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7787 # This property is optional.
7788 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7789 },
7790 ],
7791 },
7792 &quot;getVersionOperationMetadata&quot;: {
7793 &quot;inlineSbomInfo&quot;: {
7794 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7795 # appropriate identifiers.
7796 &quot;a_key&quot;: &quot;A String&quot;,
7797 },
7798 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7799 # identifiers.
7800 &quot;a_key&quot;: &quot;A String&quot;,
7801 },
7802 },
7803 },
7804 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7805 # message that was returned, such as `NOT FOUND`.
7806 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7807 # status code that was returned. For example, a `404` means the
7808 # resource was not found.
7809 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7810 # defined by the server.
7811 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7812 # This value is inRFC3339
7813 # text format.
7814 &quot;instancesBulkInsertOperationMetadata&quot;: {
7815 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7816 # Example key: zones/us-central1-a
7817 &quot;a_key&quot;: {
7818 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7819 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7820 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7821 # error.
7822 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7823 # if the flow is rolling forward or rolling back.
7824 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7825 },
7826 },
7827 },
7828 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7829 # Operation resources.
7830 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7831 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7832 # group of operations results from a `bulkInsert` API request.
7833 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7834 # `update`, or `delete`, and so on.
7835 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7836 # There is no requirement that this be linear or support any granularity of
7837 # operations. This should not be used to guess when the operation will be
7838 # complete. This number should monotonically increase as the operation
7839 # progresses.
7840 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7841 # applicable when performing regional operations.
7842 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7843 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7844 # this field will contain information on all underlying zonal actions and
7845 # their state.
7846 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7847 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7848 # Example key: zones/us-central1-a
7849 &quot;a_key&quot;: {
7850 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
7851 # populated.
7852 # different programming environments, including REST APIs and RPC APIs. It is
7853 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7854 # three pieces of data: error code, error message, and error details.
7855 #
7856 # You can find out more about this error model and how to work with it in the
7857 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7858 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7859 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7860 # message types for APIs to use.
7861 {
7862 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7863 },
7864 ],
7865 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7866 # user-facing error message should be localized and sent in the
7867 # google.rpc.Status.details field, or localized by the client.
7868 },
7869 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7870 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7871 },
7872 },
7873 },
7874 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7875 # This value is inRFC3339
7876 # text format.
7877 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7878 # following:
7879 # `PENDING`, `RUNNING`, or `DONE`.
7880 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7881 # operation.
7882 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7883 # of the target resource.
7884 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7885 # operations related to creating a snapshot, this points to the disk
7886 # that the snapshot was created from.
7887 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7888 # `[email protected]` or
7889 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7890 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7891 # operation, this field will be populated.
7892 {
7893 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7894 # Engine returns NO_RESULTS_ON_PAGE if there
7895 # are no results in the response.
7896 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7897 # value format. For example:
7898 #
7899 # &quot;data&quot;: [
7900 # {
7901 # &quot;key&quot;: &quot;scope&quot;,
7902 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7903 # }
7904 {
7905 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7906 # returned. For example, for warnings where there are no results in a list
7907 # request for a particular zone, this key might be scope and
7908 # the key value might be the zone name. Other examples might be a key
7909 # indicating a deprecated resource and a suggested replacement, or a
7910 # warning about invalid network settings (for example, if an instance
7911 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7912 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7913 },
7914 ],
7915 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7916 },
7917 ],
7918 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7919 # applicable when performing per-zone operations.
7920 }</pre>
7921 </div>
7922
7923 <div class="method">
7924 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
7925 <pre>Sets the access control policy on the specified resource.
7926 Replaces any existing policy.
7927
7928 Args:
7929 project: string, Project ID for this request. (required)
7930 resource: string, Name or id of the resource for this request. (required)
7931 body: object, The request body.
7932 The object takes the form of:
7933
7934 {
7935 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
7936 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
7937 { # Associates `members`, or principals, with a `role`.
7938 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
7939 #
7940 # If the condition evaluates to `true`, then this binding applies to the
7941 # current request.
7942 #
7943 # If the condition evaluates to `false`, then this binding does not apply to
7944 # the current request. However, a different role binding might grant the same
7945 # role to one or more of the principals in this binding.
7946 #
7947 # To learn which resources support conditions in their IAM policies, see the
7948 # [IAM
7949 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
7950 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
7951 # are documented at https://github.com/google/cel-spec.
7952 #
7953 # Example (Comparison):
7954 #
7955 # title: &quot;Summary size limit&quot;
7956 # description: &quot;Determines if a summary is less than 100 chars&quot;
7957 # expression: &quot;document.summary.size() &lt; 100&quot;
7958 #
7959 # Example (Equality):
7960 #
7961 # title: &quot;Requestor is owner&quot;
7962 # description: &quot;Determines if requestor is the document owner&quot;
7963 # expression: &quot;document.owner == request.auth.claims.email&quot;
7964 #
7965 # Example (Logic):
7966 #
7967 # title: &quot;Public documents&quot;
7968 # description: &quot;Determine whether the document should be publicly visible&quot;
7969 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
7970 #
7971 # Example (Data Manipulation):
7972 #
7973 # title: &quot;Notification string&quot;
7974 # description: &quot;Create a notification string with a timestamp.&quot;
7975 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
7976 #
7977 # The exact variables and functions that may be referenced within an expression
7978 # are determined by the service that evaluates it. See the service
7979 # documentation for additional information.
7980 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
7981 # describes the expression, e.g. when hovered over it in a UI.
7982 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
7983 # syntax.
7984 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
7985 # reporting, e.g. a file name and a position in the file.
7986 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
7987 # its purpose. This can be used e.g. in UIs which allow to enter the
7988 # expression.
7989 },
7990 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
7991 # `members` can have the following values:
7992 #
7993 # * `allUsers`: A special identifier that represents anyone who is
7994 # on the internet; with or without a Google account.
7995 #
7996 # * `allAuthenticatedUsers`: A special identifier that represents anyone
7997 # who is authenticated with a Google account or a service account.
7998 # Does not include identities that come from external identity providers
7999 # (IdPs) through identity federation.
8000 #
8001 # * `user:{emailid}`: An email address that represents a specific Google
8002 # account. For example, `[email protected]` .
8003 #
8004 #
8005 # * `serviceAccount:{emailid}`: An email address that represents a Google
8006 # service account. For example,
8007 # `[email protected]`.
8008 #
8009 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8010 # identifier for a
8011 # [Kubernetes service
8012 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8013 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8014 #
8015 # * `group:{emailid}`: An email address that represents a Google group.
8016 # For example, `[email protected]`.
8017 #
8018 #
8019 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8020 # users of that domain. For example, `google.com` or `example.com`.
8021 #
8022 #
8023 #
8024 #
8025 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8026 # A single identity in a workforce identity pool.
8027 #
8028 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8029 # All workforce identities in a group.
8030 #
8031 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8032 # All workforce identities with a specific attribute value.
8033 #
8034 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8035 # All identities in a workforce identity pool.
8036 #
8037 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8038 # A single identity in a workload identity pool.
8039 #
8040 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8041 # A workload identity pool group.
8042 #
8043 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8044 # All identities in a workload identity pool with a certain attribute.
8045 #
8046 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8047 # All identities in a workload identity pool.
8048 #
8049 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8050 # identifier) representing a user that has been recently deleted. For
8051 # example, `[email protected]?uid=123456789012345678901`. If the user is
8052 # recovered, this value reverts to `user:{emailid}` and the recovered user
8053 # retains the role in the binding.
8054 #
8055 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8056 # unique identifier) representing a service account that has been recently
8057 # deleted. For example,
8058 # `[email protected]?uid=123456789012345678901`.
8059 # If the service account is undeleted, this value reverts to
8060 # `serviceAccount:{emailid}` and the undeleted service account retains the
8061 # role in the binding.
8062 #
8063 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8064 # identifier) representing a Google group that has been recently
8065 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8066 # the group is recovered, this value reverts to `group:{emailid}` and the
8067 # recovered group retains the role in the binding.
8068 #
8069 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8070 # Deleted single identity in a workforce identity pool. For example,
8071 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8072 &quot;A String&quot;,
8073 ],
8074 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8075 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8076 #
8077 # For an overview of the IAM roles and permissions, see the
8078 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8079 # a list of the available pre-defined roles, see
8080 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8081 },
8082 ],
8083 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
8084 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
8085 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of
8086 # the policy is limited to a few 10s of KB. An empty policy is in general a
8087 # valid policy but certain services (like Projects) might reject them.
8088 # controls for Google Cloud resources.
8089 #
8090 #
8091 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8092 # `members`, or principals, to a single `role`. Principals can be user
8093 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8094 # `role` is a named list of permissions; each `role` can be an IAM predefined
8095 # role or a user-created custom role.
8096 #
8097 # For some types of Google Cloud resources, a `binding` can also specify a
8098 # `condition`, which is a logical expression that allows access to a resource
8099 # only if the expression evaluates to `true`. A condition can add constraints
8100 # based on attributes of the request, the resource, or both. To learn which
8101 # resources support conditions in their IAM policies, see the
8102 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8103 #
8104 # **JSON example:**
8105 #
8106 # ```
8107 # {
8108 # &quot;bindings&quot;: [
8109 # {
8110 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8111 # &quot;members&quot;: [
8112 # &quot;user:[email protected]&quot;,
8113 # &quot;group:[email protected]&quot;,
8114 # &quot;domain:google.com&quot;,
8115 # &quot;serviceAccount:[email protected]&quot;
8116 # ]
8117 # },
8118 # {
8119 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8120 # &quot;members&quot;: [
8121 # &quot;user:[email protected]&quot;
8122 # ],
8123 # &quot;condition&quot;: {
8124 # &quot;title&quot;: &quot;expirable access&quot;,
8125 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8126 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8127 # }
8128 # }
8129 # ],
8130 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8131 # &quot;version&quot;: 3
8132 # }
8133 # ```
8134 #
8135 # **YAML example:**
8136 #
8137 # ```
8138 # bindings:
8139 # - members:
8140 # - user:[email protected]
8141 # - group:[email protected]
8142 # - domain:google.com
8143 # - serviceAccount:[email protected]
8144 # role: roles/resourcemanager.organizationAdmin
8145 # - members:
8146 # - user:[email protected]
8147 # role: roles/resourcemanager.organizationViewer
8148 # condition:
8149 # title: expirable access
8150 # description: Does not grant access after Sep 2020
8151 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8152 # etag: BwWWja0YfJA=
8153 # version: 3
8154 # ```
8155 #
8156 # For a description of IAM and its features, see the
8157 # [IAM documentation](https://cloud.google.com/iam/docs/).
8158 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8159 { # Specifies the audit configuration for a service.
8160 # The configuration determines which permission types are logged, and what
8161 # identities, if any, are exempted from logging.
8162 # An AuditConfig must have one or more AuditLogConfigs.
8163 #
8164 # If there are AuditConfigs for both `allServices` and a specific service,
8165 # the union of the two AuditConfigs is used for that service: the log_types
8166 # specified in each AuditConfig are enabled, and the exempted_members in each
8167 # AuditLogConfig are exempted.
8168 #
8169 # Example Policy with multiple AuditConfigs:
8170 #
8171 # {
8172 # &quot;audit_configs&quot;: [
8173 # {
8174 # &quot;service&quot;: &quot;allServices&quot;,
8175 # &quot;audit_log_configs&quot;: [
8176 # {
8177 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8178 # &quot;exempted_members&quot;: [
8179 # &quot;user:[email protected]&quot;
8180 # ]
8181 # },
8182 # {
8183 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8184 # },
8185 # {
8186 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8187 # }
8188 # ]
8189 # },
8190 # {
8191 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8192 # &quot;audit_log_configs&quot;: [
8193 # {
8194 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8195 # },
8196 # {
8197 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8198 # &quot;exempted_members&quot;: [
8199 # &quot;user:[email protected]&quot;
8200 # ]
8201 # }
8202 # ]
8203 # }
8204 # ]
8205 # }
8206 #
8207 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8208 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8209 # `[email protected]` from DATA_WRITE logging.
8210 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8211 { # Provides the configuration for logging a type of permissions.
8212 # Example:
8213 #
8214 # {
8215 # &quot;audit_log_configs&quot;: [
8216 # {
8217 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8218 # &quot;exempted_members&quot;: [
8219 # &quot;user:[email protected]&quot;
8220 # ]
8221 # },
8222 # {
8223 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8224 # }
8225 # ]
8226 # }
8227 #
8228 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8229 # [email protected] from DATA_READ logging.
8230 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8231 # permission.
8232 # Follows the same format of Binding.members.
8233 &quot;A String&quot;,
8234 ],
8235 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8236 },
8237 ],
8238 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8239 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8240 # `allServices` is a special value that covers all services.
8241 },
8242 ],
8243 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8244 # may specify a `condition` that determines how and when the `bindings` are
8245 # applied. Each of the `bindings` must contain at least one principal.
8246 #
8247 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8248 # of these principals can be Google groups. Each occurrence of a principal
8249 # counts towards these limits. For example, if the `bindings` grant 50
8250 # different roles to `user:[email protected]`, and not to any other
8251 # principal, then you can add another 1,450 principals to the `bindings` in
8252 # the `Policy`.
8253 { # Associates `members`, or principals, with a `role`.
8254 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8255 #
8256 # If the condition evaluates to `true`, then this binding applies to the
8257 # current request.
8258 #
8259 # If the condition evaluates to `false`, then this binding does not apply to
8260 # the current request. However, a different role binding might grant the same
8261 # role to one or more of the principals in this binding.
8262 #
8263 # To learn which resources support conditions in their IAM policies, see the
8264 # [IAM
8265 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8266 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8267 # are documented at https://github.com/google/cel-spec.
8268 #
8269 # Example (Comparison):
8270 #
8271 # title: &quot;Summary size limit&quot;
8272 # description: &quot;Determines if a summary is less than 100 chars&quot;
8273 # expression: &quot;document.summary.size() &lt; 100&quot;
8274 #
8275 # Example (Equality):
8276 #
8277 # title: &quot;Requestor is owner&quot;
8278 # description: &quot;Determines if requestor is the document owner&quot;
8279 # expression: &quot;document.owner == request.auth.claims.email&quot;
8280 #
8281 # Example (Logic):
8282 #
8283 # title: &quot;Public documents&quot;
8284 # description: &quot;Determine whether the document should be publicly visible&quot;
8285 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8286 #
8287 # Example (Data Manipulation):
8288 #
8289 # title: &quot;Notification string&quot;
8290 # description: &quot;Create a notification string with a timestamp.&quot;
8291 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8292 #
8293 # The exact variables and functions that may be referenced within an expression
8294 # are determined by the service that evaluates it. See the service
8295 # documentation for additional information.
8296 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8297 # describes the expression, e.g. when hovered over it in a UI.
8298 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8299 # syntax.
8300 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8301 # reporting, e.g. a file name and a position in the file.
8302 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8303 # its purpose. This can be used e.g. in UIs which allow to enter the
8304 # expression.
8305 },
8306 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8307 # `members` can have the following values:
8308 #
8309 # * `allUsers`: A special identifier that represents anyone who is
8310 # on the internet; with or without a Google account.
8311 #
8312 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8313 # who is authenticated with a Google account or a service account.
8314 # Does not include identities that come from external identity providers
8315 # (IdPs) through identity federation.
8316 #
8317 # * `user:{emailid}`: An email address that represents a specific Google
8318 # account. For example, `[email protected]` .
8319 #
8320 #
8321 # * `serviceAccount:{emailid}`: An email address that represents a Google
8322 # service account. For example,
8323 # `[email protected]`.
8324 #
8325 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8326 # identifier for a
8327 # [Kubernetes service
8328 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8329 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8330 #
8331 # * `group:{emailid}`: An email address that represents a Google group.
8332 # For example, `[email protected]`.
8333 #
8334 #
8335 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8336 # users of that domain. For example, `google.com` or `example.com`.
8337 #
8338 #
8339 #
8340 #
8341 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8342 # A single identity in a workforce identity pool.
8343 #
8344 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8345 # All workforce identities in a group.
8346 #
8347 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8348 # All workforce identities with a specific attribute value.
8349 #
8350 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8351 # All identities in a workforce identity pool.
8352 #
8353 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8354 # A single identity in a workload identity pool.
8355 #
8356 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8357 # A workload identity pool group.
8358 #
8359 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8360 # All identities in a workload identity pool with a certain attribute.
8361 #
8362 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8363 # All identities in a workload identity pool.
8364 #
8365 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8366 # identifier) representing a user that has been recently deleted. For
8367 # example, `[email protected]?uid=123456789012345678901`. If the user is
8368 # recovered, this value reverts to `user:{emailid}` and the recovered user
8369 # retains the role in the binding.
8370 #
8371 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8372 # unique identifier) representing a service account that has been recently
8373 # deleted. For example,
8374 # `[email protected]?uid=123456789012345678901`.
8375 # If the service account is undeleted, this value reverts to
8376 # `serviceAccount:{emailid}` and the undeleted service account retains the
8377 # role in the binding.
8378 #
8379 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8380 # identifier) representing a Google group that has been recently
8381 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8382 # the group is recovered, this value reverts to `group:{emailid}` and the
8383 # recovered group retains the role in the binding.
8384 #
8385 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8386 # Deleted single identity in a workforce identity pool. For example,
8387 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8388 &quot;A String&quot;,
8389 ],
8390 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8391 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8392 #
8393 # For an overview of the IAM roles and permissions, see the
8394 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8395 # a list of the available pre-defined roles, see
8396 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8397 },
8398 ],
8399 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8400 # prevent simultaneous updates of a policy from overwriting each other.
8401 # It is strongly suggested that systems make use of the `etag` in the
8402 # read-modify-write cycle to perform policy updates in order to avoid race
8403 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8404 # systems are expected to put that etag in the request to `setIamPolicy` to
8405 # ensure that their change will be applied to the same version of the policy.
8406 #
8407 # **Important:** If you use IAM Conditions, you must include the `etag` field
8408 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8409 # you to overwrite a version `3` policy with a version `1` policy, and all of
8410 # the conditions in the version `3` policy are lost.
8411 &quot;version&quot;: 42, # Specifies the format of the policy.
8412 #
8413 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8414 # are rejected.
8415 #
8416 # Any operation that affects conditional role bindings must specify version
8417 # `3`. This requirement applies to the following operations:
8418 #
8419 # * Getting a policy that includes a conditional role binding
8420 # * Adding a conditional role binding to a policy
8421 # * Changing a conditional role binding in a policy
8422 # * Removing any role binding, with or without a condition, from a policy
8423 # that includes conditions
8424 #
8425 # **Important:** If you use IAM Conditions, you must include the `etag` field
8426 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8427 # you to overwrite a version `3` policy with a version `1` policy, and all of
8428 # the conditions in the version `3` policy are lost.
8429 #
8430 # If a policy does not include any conditions, operations on that policy may
8431 # specify any valid version or leave the field unset.
8432 #
8433 # To learn which resources support conditions in their IAM policies, see the
8434 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8435 },
8436 }
8437
8438 x__xgafv: string, V1 error format.
8439 Allowed values
8440 1 - v1 error format
8441 2 - v2 error format
8442
8443 Returns:
8444 An object of the form:
8445
8446 { # An Identity and Access Management (IAM) policy, which specifies access
8447 # controls for Google Cloud resources.
8448 #
8449 #
8450 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8451 # `members`, or principals, to a single `role`. Principals can be user
8452 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8453 # `role` is a named list of permissions; each `role` can be an IAM predefined
8454 # role or a user-created custom role.
8455 #
8456 # For some types of Google Cloud resources, a `binding` can also specify a
8457 # `condition`, which is a logical expression that allows access to a resource
8458 # only if the expression evaluates to `true`. A condition can add constraints
8459 # based on attributes of the request, the resource, or both. To learn which
8460 # resources support conditions in their IAM policies, see the
8461 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8462 #
8463 # **JSON example:**
8464 #
8465 # ```
8466 # {
8467 # &quot;bindings&quot;: [
8468 # {
8469 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8470 # &quot;members&quot;: [
8471 # &quot;user:[email protected]&quot;,
8472 # &quot;group:[email protected]&quot;,
8473 # &quot;domain:google.com&quot;,
8474 # &quot;serviceAccount:[email protected]&quot;
8475 # ]
8476 # },
8477 # {
8478 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8479 # &quot;members&quot;: [
8480 # &quot;user:[email protected]&quot;
8481 # ],
8482 # &quot;condition&quot;: {
8483 # &quot;title&quot;: &quot;expirable access&quot;,
8484 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8485 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8486 # }
8487 # }
8488 # ],
8489 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8490 # &quot;version&quot;: 3
8491 # }
8492 # ```
8493 #
8494 # **YAML example:**
8495 #
8496 # ```
8497 # bindings:
8498 # - members:
8499 # - user:[email protected]
8500 # - group:[email protected]
8501 # - domain:google.com
8502 # - serviceAccount:[email protected]
8503 # role: roles/resourcemanager.organizationAdmin
8504 # - members:
8505 # - user:[email protected]
8506 # role: roles/resourcemanager.organizationViewer
8507 # condition:
8508 # title: expirable access
8509 # description: Does not grant access after Sep 2020
8510 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8511 # etag: BwWWja0YfJA=
8512 # version: 3
8513 # ```
8514 #
8515 # For a description of IAM and its features, see the
8516 # [IAM documentation](https://cloud.google.com/iam/docs/).
8517 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8518 { # Specifies the audit configuration for a service.
8519 # The configuration determines which permission types are logged, and what
8520 # identities, if any, are exempted from logging.
8521 # An AuditConfig must have one or more AuditLogConfigs.
8522 #
8523 # If there are AuditConfigs for both `allServices` and a specific service,
8524 # the union of the two AuditConfigs is used for that service: the log_types
8525 # specified in each AuditConfig are enabled, and the exempted_members in each
8526 # AuditLogConfig are exempted.
8527 #
8528 # Example Policy with multiple AuditConfigs:
8529 #
8530 # {
8531 # &quot;audit_configs&quot;: [
8532 # {
8533 # &quot;service&quot;: &quot;allServices&quot;,
8534 # &quot;audit_log_configs&quot;: [
8535 # {
8536 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8537 # &quot;exempted_members&quot;: [
8538 # &quot;user:[email protected]&quot;
8539 # ]
8540 # },
8541 # {
8542 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8543 # },
8544 # {
8545 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8546 # }
8547 # ]
8548 # },
8549 # {
8550 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8551 # &quot;audit_log_configs&quot;: [
8552 # {
8553 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8554 # },
8555 # {
8556 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8557 # &quot;exempted_members&quot;: [
8558 # &quot;user:[email protected]&quot;
8559 # ]
8560 # }
8561 # ]
8562 # }
8563 # ]
8564 # }
8565 #
8566 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8567 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8568 # `[email protected]` from DATA_WRITE logging.
8569 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8570 { # Provides the configuration for logging a type of permissions.
8571 # Example:
8572 #
8573 # {
8574 # &quot;audit_log_configs&quot;: [
8575 # {
8576 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8577 # &quot;exempted_members&quot;: [
8578 # &quot;user:[email protected]&quot;
8579 # ]
8580 # },
8581 # {
8582 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8583 # }
8584 # ]
8585 # }
8586 #
8587 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8588 # [email protected] from DATA_READ logging.
8589 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8590 # permission.
8591 # Follows the same format of Binding.members.
8592 &quot;A String&quot;,
8593 ],
8594 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8595 },
8596 ],
8597 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8598 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8599 # `allServices` is a special value that covers all services.
8600 },
8601 ],
8602 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8603 # may specify a `condition` that determines how and when the `bindings` are
8604 # applied. Each of the `bindings` must contain at least one principal.
8605 #
8606 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8607 # of these principals can be Google groups. Each occurrence of a principal
8608 # counts towards these limits. For example, if the `bindings` grant 50
8609 # different roles to `user:[email protected]`, and not to any other
8610 # principal, then you can add another 1,450 principals to the `bindings` in
8611 # the `Policy`.
8612 { # Associates `members`, or principals, with a `role`.
8613 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8614 #
8615 # If the condition evaluates to `true`, then this binding applies to the
8616 # current request.
8617 #
8618 # If the condition evaluates to `false`, then this binding does not apply to
8619 # the current request. However, a different role binding might grant the same
8620 # role to one or more of the principals in this binding.
8621 #
8622 # To learn which resources support conditions in their IAM policies, see the
8623 # [IAM
8624 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8625 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8626 # are documented at https://github.com/google/cel-spec.
8627 #
8628 # Example (Comparison):
8629 #
8630 # title: &quot;Summary size limit&quot;
8631 # description: &quot;Determines if a summary is less than 100 chars&quot;
8632 # expression: &quot;document.summary.size() &lt; 100&quot;
8633 #
8634 # Example (Equality):
8635 #
8636 # title: &quot;Requestor is owner&quot;
8637 # description: &quot;Determines if requestor is the document owner&quot;
8638 # expression: &quot;document.owner == request.auth.claims.email&quot;
8639 #
8640 # Example (Logic):
8641 #
8642 # title: &quot;Public documents&quot;
8643 # description: &quot;Determine whether the document should be publicly visible&quot;
8644 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8645 #
8646 # Example (Data Manipulation):
8647 #
8648 # title: &quot;Notification string&quot;
8649 # description: &quot;Create a notification string with a timestamp.&quot;
8650 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8651 #
8652 # The exact variables and functions that may be referenced within an expression
8653 # are determined by the service that evaluates it. See the service
8654 # documentation for additional information.
8655 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8656 # describes the expression, e.g. when hovered over it in a UI.
8657 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8658 # syntax.
8659 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8660 # reporting, e.g. a file name and a position in the file.
8661 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8662 # its purpose. This can be used e.g. in UIs which allow to enter the
8663 # expression.
8664 },
8665 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8666 # `members` can have the following values:
8667 #
8668 # * `allUsers`: A special identifier that represents anyone who is
8669 # on the internet; with or without a Google account.
8670 #
8671 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8672 # who is authenticated with a Google account or a service account.
8673 # Does not include identities that come from external identity providers
8674 # (IdPs) through identity federation.
8675 #
8676 # * `user:{emailid}`: An email address that represents a specific Google
8677 # account. For example, `[email protected]` .
8678 #
8679 #
8680 # * `serviceAccount:{emailid}`: An email address that represents a Google
8681 # service account. For example,
8682 # `[email protected]`.
8683 #
8684 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8685 # identifier for a
8686 # [Kubernetes service
8687 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8688 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8689 #
8690 # * `group:{emailid}`: An email address that represents a Google group.
8691 # For example, `[email protected]`.
8692 #
8693 #
8694 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8695 # users of that domain. For example, `google.com` or `example.com`.
8696 #
8697 #
8698 #
8699 #
8700 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8701 # A single identity in a workforce identity pool.
8702 #
8703 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8704 # All workforce identities in a group.
8705 #
8706 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8707 # All workforce identities with a specific attribute value.
8708 #
8709 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8710 # All identities in a workforce identity pool.
8711 #
8712 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8713 # A single identity in a workload identity pool.
8714 #
8715 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8716 # A workload identity pool group.
8717 #
8718 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8719 # All identities in a workload identity pool with a certain attribute.
8720 #
8721 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8722 # All identities in a workload identity pool.
8723 #
8724 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8725 # identifier) representing a user that has been recently deleted. For
8726 # example, `[email protected]?uid=123456789012345678901`. If the user is
8727 # recovered, this value reverts to `user:{emailid}` and the recovered user
8728 # retains the role in the binding.
8729 #
8730 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8731 # unique identifier) representing a service account that has been recently
8732 # deleted. For example,
8733 # `[email protected]?uid=123456789012345678901`.
8734 # If the service account is undeleted, this value reverts to
8735 # `serviceAccount:{emailid}` and the undeleted service account retains the
8736 # role in the binding.
8737 #
8738 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8739 # identifier) representing a Google group that has been recently
8740 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8741 # the group is recovered, this value reverts to `group:{emailid}` and the
8742 # recovered group retains the role in the binding.
8743 #
8744 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8745 # Deleted single identity in a workforce identity pool. For example,
8746 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8747 &quot;A String&quot;,
8748 ],
8749 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8750 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8751 #
8752 # For an overview of the IAM roles and permissions, see the
8753 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8754 # a list of the available pre-defined roles, see
8755 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8756 },
8757 ],
8758 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8759 # prevent simultaneous updates of a policy from overwriting each other.
8760 # It is strongly suggested that systems make use of the `etag` in the
8761 # read-modify-write cycle to perform policy updates in order to avoid race
8762 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8763 # systems are expected to put that etag in the request to `setIamPolicy` to
8764 # ensure that their change will be applied to the same version of the policy.
8765 #
8766 # **Important:** If you use IAM Conditions, you must include the `etag` field
8767 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8768 # you to overwrite a version `3` policy with a version `1` policy, and all of
8769 # the conditions in the version `3` policy are lost.
8770 &quot;version&quot;: 42, # Specifies the format of the policy.
8771 #
8772 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8773 # are rejected.
8774 #
8775 # Any operation that affects conditional role bindings must specify version
8776 # `3`. This requirement applies to the following operations:
8777 #
8778 # * Getting a policy that includes a conditional role binding
8779 # * Adding a conditional role binding to a policy
8780 # * Changing a conditional role binding in a policy
8781 # * Removing any role binding, with or without a condition, from a policy
8782 # that includes conditions
8783 #
8784 # **Important:** If you use IAM Conditions, you must include the `etag` field
8785 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8786 # you to overwrite a version `3` policy with a version `1` policy, and all of
8787 # the conditions in the version `3` policy are lost.
8788 #
8789 # If a policy does not include any conditions, operations on that policy may
8790 # specify any valid version or leave the field unset.
8791 #
8792 # To learn which resources support conditions in their IAM policies, see the
8793 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8794 }</pre>
8795 </div>
8796
8797 <div class="method">
8798 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
8799 <pre>Returns permissions that a caller has on the specified resource.
8800
8801 Args:
8802 project: string, Project ID for this request. (required)
8803 resource: string, Name or id of the resource for this request. (required)
8804 body: object, The request body.
8805 The object takes the form of:
8806
8807 {
8808 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
8809 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
8810 &quot;A String&quot;,
8811 ],
8812 }
8813
8814 x__xgafv: string, V1 error format.
8815 Allowed values
8816 1 - v1 error format
8817 2 - v2 error format
8818
8819 Returns:
8820 An object of the form:
8821
8822 {
8823 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
8824 # allowed.
8825 &quot;A String&quot;,
8826 ],
8827 }</pre>
8828 </div>
8829
8830 </body></html>