Debian Codegraph @

docs/dyn/compute_beta.firewallPolicies.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.firewallPolicies.html">firewallPolicies</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addAssociation">addAssociation(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(firewallPolicy, body=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(firewallPolicy, body=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="#cloneRules">cloneRules(firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Copies rules to the specified firewall policy.</p>
89 <p class="toc_element">
90 <code><a href="#close">close()</a></code></p>
91 <p class="firstline">Close httplib2 connections.</p>
92 <p class="toc_element">
93 <code><a href="#delete">delete(firewallPolicy, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Deletes the specified policy.</p>
95 <p class="toc_element">
96 <code><a href="#get">get(firewallPolicy, x__xgafv=None)</a></code></p>
97 <p class="firstline">Returns the specified firewall policy.</p>
98 <p class="toc_element">
99 <code><a href="#getAssociation">getAssociation(firewallPolicy, name=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Gets an association with the specified name.</p>
101 <p class="toc_element">
102 <code><a href="#getIamPolicy">getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
104 <p class="toc_element">
105 <code><a href="#getPacketMirroringRule">getPacketMirroringRule(firewallPolicy, priority=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Gets a packet mirroring rule of the specified priority.</p>
107 <p class="toc_element">
108 <code><a href="#getRule">getRule(firewallPolicy, priority=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Gets a rule of the specified priority.</p>
110 <p class="toc_element">
111 <code><a href="#insert">insert(body=None, parentId=None, requestId=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Creates a new policy in the specified project using the data included in</p>
113 <p class="toc_element">
114 <code><a href="#list">list(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Lists all the policies that have been configured for the specified</p>
116 <p class="toc_element">
117 <code><a href="#listAssociations">listAssociations(includeInheritedPolicies=None, targetResource=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Lists associations of a specified target, i.e., organization or folder.</p>
119 <p class="toc_element">
120 <code><a href="#list_next">list_next()</a></code></p>
121 <p class="firstline">Retrieves the next page of results.</p>
122 <p class="toc_element">
123 <code><a href="#move">move(firewallPolicy, parentId=None, requestId=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Moves the specified firewall policy.</p>
125 <p class="toc_element">
126 <code><a href="#patch">patch(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(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(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(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(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(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(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(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(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 firewallPolicy: string, Name of the firewall policy to update. (required)
156 body: object, The request body.
157 The object takes the form of:
158
159 {
160 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
161 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
162 # of the firewall policy of the association.
163 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
164 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
165 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
166 # must be a positive value between 1 and 2147483647.
167 # Firewall Policies are evaluated from highest to lowest priority where 1
168 # is the highest priority and 2147483647 is the lowest priority.
169 # The default value is `1000`. If two associations have the same priority
170 # then lexicographical order on association names is applied.
171 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
172 }
173
174 replaceExistingAssociation: boolean, Indicates whether or not to replace it if an association of the attachment
175 already exists. This is false by default, in which case an error will be
176 returned if an association already exists.
177 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
178 that if you must retry your request, the server will know to ignore the
179 request if it has already been completed.
180
181 For example, consider a situation where you make an initial request and
182 the request times out. If you make the request again with the same
183 request ID, the server can check if original operation with the same
184 request ID was received, and if so, will ignore the second request. This
185 prevents clients from accidentally creating duplicate commitments.
186
187 The request ID must be
188 a valid UUID with the exception that zero UUID is not supported
189 (00000000-0000-0000-0000-000000000000).
190 x__xgafv: string, V1 error format.
191 Allowed values
192 1 - v1 error format
193 2 - v2 error format
194
195 Returns:
196 An object of the form:
197
198 { # Represents an Operation resource.
199 #
200 # Google Compute Engine has three Operation resources:
201 #
202 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
203 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
204 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
205 #
206 # You can use an operation resource to manage asynchronous API requests.
207 # For more information, readHandling
208 # API responses.
209 #
210 # Operations can be global, regional or zonal.
211 #
212 # - For global operations, use the `globalOperations`
213 # resource.
214 # - For regional operations, use the
215 # `regionOperations` resource.
216 # - For zonal operations, use
217 # the `zoneOperations` resource.
218 #
219 #
220 #
221 # For more information, read
222 # Global, Regional, and Zonal Resources.
223 #
224 # Note that completed Operation resources have a limited
225 # retention period.
226 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
227 # Not present otherwise.
228 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
229 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
230 # set when the operation is created.
231 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
232 # text format.
233 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
234 # this field will be populated.
235 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
236 # operation.
237 {
238 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
239 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
240 # details. There is a set of defined message types to use for providing
241 # details.The syntax depends on the error code. For example,
242 # QuotaExceededInfo will have details when the error code is
243 # QUOTA_EXCEEDED.
244 {
245 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
246 #
247 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
248 # is not enabled:
249 #
250 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
251 # &quot;domain&quot;: &quot;googleapis.com&quot;
252 # &quot;metadata&quot;: {
253 # &quot;resource&quot;: &quot;projects/123&quot;,
254 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
255 # }
256 # }
257 #
258 # This response indicates that the pubsub.googleapis.com API is not enabled.
259 #
260 # Example of an error that is returned when attempting to create a Spanner
261 # instance in a region that is out of stock:
262 #
263 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
264 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
265 # &quot;metadata&quot;: {
266 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
267 # }
268 # }
269 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
270 # is typically the registered service name of the tool or product that
271 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
272 # generated by some common infrastructure, the error domain must be a
273 # globally unique value that identifies the infrastructure. For Google API
274 # infrastructure, the error domain is &quot;googleapis.com&quot;.
275 &quot;metadatas&quot;: { # Additional structured details about this error.
276 #
277 # Keys must match a regular expression of `a-z+` but should
278 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
279 # length. When identifying the current value of an exceeded limit, the units
280 # should be contained in the key, not the value. For example, rather than
281 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
282 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
283 # instances that can be created in a single (batch) request.
284 &quot;a_key&quot;: &quot;A String&quot;,
285 },
286 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
287 # proximate cause of the error. Error reasons are unique within a particular
288 # domain of errors. This should be at most 63 characters and match a
289 # regular expression of `A-Z+[A-Z0-9]`, which represents
290 # UPPER_SNAKE_CASE.
291 },
292 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
293 #
294 # For example, if a quota check failed with an error indicating the calling
295 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
296 # directly to the right place in the developer console to flip the bit.
297 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
298 { # Describes a URL link.
299 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
300 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
301 },
302 ],
303 },
304 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
305 # which can be attached to an RPC error.
306 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
307 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
308 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
309 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
310 },
311 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
312 &quot;dimensions&quot;: { # The map holding related quota dimensions.
313 &quot;a_key&quot;: &quot;A String&quot;,
314 },
315 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
316 # type or metric.
317 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
318 # or metric.
319 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
320 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
321 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
322 },
323 },
324 ],
325 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
326 # This property is optional.
327 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
328 },
329 ],
330 },
331 &quot;getVersionOperationMetadata&quot;: {
332 &quot;inlineSbomInfo&quot;: {
333 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
334 # appropriate identifiers.
335 &quot;a_key&quot;: &quot;A String&quot;,
336 },
337 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
338 # identifiers.
339 &quot;a_key&quot;: &quot;A String&quot;,
340 },
341 },
342 },
343 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
344 # message that was returned, such as `NOT FOUND`.
345 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
346 # status code that was returned. For example, a `404` means the
347 # resource was not found.
348 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
349 # defined by the server.
350 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
351 # This value is inRFC3339
352 # text format.
353 &quot;instancesBulkInsertOperationMetadata&quot;: {
354 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
355 # Example key: zones/us-central1-a
356 &quot;a_key&quot;: {
357 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
358 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
359 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
360 # error.
361 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
362 # if the flow is rolling forward or rolling back.
363 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
364 },
365 },
366 },
367 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
368 # Operation resources.
369 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
370 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
371 # group of operations results from a `bulkInsert` API request.
372 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
373 # `update`, or `delete`, and so on.
374 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
375 # There is no requirement that this be linear or support any granularity of
376 # operations. This should not be used to guess when the operation will be
377 # complete. This number should monotonically increase as the operation
378 # progresses.
379 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
380 # applicable when performing regional operations.
381 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
382 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
383 # this field will contain information on all underlying zonal actions and
384 # their state.
385 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
386 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
387 # Example key: zones/us-central1-a
388 &quot;a_key&quot;: {
389 &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
390 # populated.
391 # different programming environments, including REST APIs and RPC APIs. It is
392 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
393 # three pieces of data: error code, error message, and error details.
394 #
395 # You can find out more about this error model and how to work with it in the
396 # [API Design Guide](https://cloud.google.com/apis/design/errors).
397 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
398 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
399 # message types for APIs to use.
400 {
401 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
402 },
403 ],
404 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
405 # user-facing error message should be localized and sent in the
406 # google.rpc.Status.details field, or localized by the client.
407 },
408 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
409 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
410 },
411 },
412 },
413 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
414 # This value is inRFC3339
415 # text format.
416 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
417 # following:
418 # `PENDING`, `RUNNING`, or `DONE`.
419 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
420 # operation.
421 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
422 # of the target resource.
423 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
424 # operations related to creating a snapshot, this points to the disk
425 # that the snapshot was created from.
426 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
427 # `[email protected]` or
428 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
429 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
430 # operation, this field will be populated.
431 {
432 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
433 # Engine returns NO_RESULTS_ON_PAGE if there
434 # are no results in the response.
435 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
436 # value format. For example:
437 #
438 # &quot;data&quot;: [
439 # {
440 # &quot;key&quot;: &quot;scope&quot;,
441 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
442 # }
443 {
444 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
445 # returned. For example, for warnings where there are no results in a list
446 # request for a particular zone, this key might be scope and
447 # the key value might be the zone name. Other examples might be a key
448 # indicating a deprecated resource and a suggested replacement, or a
449 # warning about invalid network settings (for example, if an instance
450 # attempts to perform IP forwarding but is not enabled for IP forwarding).
451 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
452 },
453 ],
454 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
455 },
456 ],
457 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
458 # applicable when performing per-zone operations.
459 }</pre>
460 </div>
461
462 <div class="method">
463 <code class="details" id="addPacketMirroringRule">addPacketMirroringRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)</code>
464 <pre>Inserts a packet mirroring rule into a firewall policy.
465
466 Args:
467 firewallPolicy: string, Name of the firewall policy to update. (required)
468 body: object, The request body.
469 The object takes the form of:
470
471 { # Represents a rule that describes one or more match conditions along with
472 # the action to be taken when traffic matches this condition (allow or deny).
473 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
474 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
475 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
476 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
477 # and &quot;goto_next&quot;.
478 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
479 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
480 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
481 # the firewall policy rule is not enforced and traffic behaves as if it did
482 # not exist. If this is unspecified, the firewall policy rule will be
483 # enabled.
484 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
485 # enabled, logs will be exported to the configured export destination in
486 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
487 # cannot enable logging on &quot;goto_next&quot; rules.
488 &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.
489 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
490 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
491 # Exactly one field must be specified.
492 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
493 # Maximum number of destination address groups is 10.
494 &quot;A String&quot;,
495 ],
496 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
497 # traffic destination.
498 # Maximum number of destination fqdn allowed is 100.
499 &quot;A String&quot;,
500 ],
501 &quot;destIpRanges&quot;: [ # CIDR IP address range.
502 # Maximum number of destination CIDR IP ranges allowed is 5000.
503 &quot;A String&quot;,
504 ],
505 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
506 #
507 #
508 # - UNSPECIFIED
509 # - INTERNET
510 # - NON_INTERNET
511 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
512 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
513 #
514 #
515 # - UNSPECIFIED
516 # - INTERNET
517 # - NON_INTERNET
518 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
519 # of traffic. Should be specified as 2 letter country code defined as per
520 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
521 # Maximum number of dest region codes allowed is 5000.
522 &quot;A String&quot;,
523 ],
524 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
525 # The IPs in these lists will be matched against traffic destination.
526 &quot;A String&quot;,
527 ],
528 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
529 {
530 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
531 # required when creating a firewall rule. This value can either be
532 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
533 # protocol number.
534 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
535 # only applicable for UDP or TCP protocol. Each entry must be either
536 # an integer or a range. If not specified, this rule applies to
537 # connections through any port.
538 #
539 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
540 &quot;A String&quot;,
541 ],
542 },
543 ],
544 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
545 # Maximum number of source address groups is 10.
546 &quot;A String&quot;,
547 ],
548 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
549 # traffic source.
550 # Maximum number of source fqdn allowed is 100.
551 &quot;A String&quot;,
552 ],
553 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
554 # Maximum number of source CIDR IP ranges allowed is 5000.
555 &quot;A String&quot;,
556 ],
557 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
558 #
559 #
560 # - UNSPECIFIED
561 # - INTERNET
562 # - INTRA_VPC
563 # - NON_INTERNET
564 # - VPC_NETWORKS
565 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
566 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
567 #
568 #
569 # - UNSPECIFIED
570 # - INTERNET
571 # - INTRA_VPC
572 # - NON_INTERNET
573 # - VPC_NETWORKS
574 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
575 &quot;A String&quot;,
576 ],
577 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
578 # of traffic. Should be specified as 2 letter country code defined as per
579 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
580 # Maximum number of source region codes allowed is 5000.
581 &quot;A String&quot;,
582 ],
583 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
584 # of the traffic.
585 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
586 # and there is no srcIpRange, this rule will be ignored.
587 # Maximum number of source tag values allowed is 256.
588 {
589 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
590 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
591 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
592 # or its network is deleted.
593 },
594 ],
595 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
596 # The IPs in these lists will be matched against traffic source.
597 &quot;A String&quot;,
598 ],
599 },
600 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
601 # must be a positive value between 0 and 2147483647.
602 # Rules are evaluated from highest to lowest priority where 0 is the
603 # highest priority and 2147483647 is the lowest priority.
604 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
605 # and can be updated.
606 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
607 # rule.
608 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
609 # Example:
610 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
611 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
612 # &#x27;mirror&#x27;. Cannot be specified for other actions.
613 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
614 # This field allows you to control which load balancers get this rule.
615 # For example, the following are valid values:
616 #
617 #
618 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
619 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
620 # - projects/project/global/
621 # forwardingRules/forwardingRule
622 # - projects/project/regions/region/forwardingRules/
623 # forwardingRule
624 &quot;A String&quot;,
625 ],
626 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
627 # allows you to control which network&#x27;s VMs get this rule. If this field
628 # is left blank, all VMs within the organization will receive the rule.
629 &quot;A String&quot;,
630 ],
631 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
632 # applies to. If targetSecureTag are specified, then the
633 # firewall rule applies only to instances in the VPC network that have one
634 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
635 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
636 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
637 # to all instances on the specified network.
638 # Maximum number of target label tags allowed is 256.
639 {
640 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
641 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
642 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
643 # or its network is deleted.
644 },
645 ],
646 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
647 # applied with this rule.
648 &quot;A String&quot;,
649 ],
650 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
651 # Default value is INSTANCES.
652 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
653 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
654 # be set for other actions.
655 }
656
657 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
658 that if you must retry your request, the server will know to ignore the
659 request if it has already been completed.
660
661 For example, consider a situation where you make an initial request and
662 the request times out. If you make the request again with the same
663 request ID, the server can check if original operation with the same
664 request ID was received, and if so, will ignore the second request. This
665 prevents clients from accidentally creating duplicate commitments.
666
667 The request ID must be
668 a valid UUID with the exception that zero UUID is not supported
669 (00000000-0000-0000-0000-000000000000).
670 x__xgafv: string, V1 error format.
671 Allowed values
672 1 - v1 error format
673 2 - v2 error format
674
675 Returns:
676 An object of the form:
677
678 { # Represents an Operation resource.
679 #
680 # Google Compute Engine has three Operation resources:
681 #
682 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
683 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
684 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
685 #
686 # You can use an operation resource to manage asynchronous API requests.
687 # For more information, readHandling
688 # API responses.
689 #
690 # Operations can be global, regional or zonal.
691 #
692 # - For global operations, use the `globalOperations`
693 # resource.
694 # - For regional operations, use the
695 # `regionOperations` resource.
696 # - For zonal operations, use
697 # the `zoneOperations` resource.
698 #
699 #
700 #
701 # For more information, read
702 # Global, Regional, and Zonal Resources.
703 #
704 # Note that completed Operation resources have a limited
705 # retention period.
706 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
707 # Not present otherwise.
708 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
709 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
710 # set when the operation is created.
711 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
712 # text format.
713 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
714 # this field will be populated.
715 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
716 # operation.
717 {
718 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
719 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
720 # details. There is a set of defined message types to use for providing
721 # details.The syntax depends on the error code. For example,
722 # QuotaExceededInfo will have details when the error code is
723 # QUOTA_EXCEEDED.
724 {
725 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
726 #
727 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
728 # is not enabled:
729 #
730 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
731 # &quot;domain&quot;: &quot;googleapis.com&quot;
732 # &quot;metadata&quot;: {
733 # &quot;resource&quot;: &quot;projects/123&quot;,
734 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
735 # }
736 # }
737 #
738 # This response indicates that the pubsub.googleapis.com API is not enabled.
739 #
740 # Example of an error that is returned when attempting to create a Spanner
741 # instance in a region that is out of stock:
742 #
743 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
744 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
745 # &quot;metadata&quot;: {
746 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
747 # }
748 # }
749 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
750 # is typically the registered service name of the tool or product that
751 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
752 # generated by some common infrastructure, the error domain must be a
753 # globally unique value that identifies the infrastructure. For Google API
754 # infrastructure, the error domain is &quot;googleapis.com&quot;.
755 &quot;metadatas&quot;: { # Additional structured details about this error.
756 #
757 # Keys must match a regular expression of `a-z+` but should
758 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
759 # length. When identifying the current value of an exceeded limit, the units
760 # should be contained in the key, not the value. For example, rather than
761 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
762 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
763 # instances that can be created in a single (batch) request.
764 &quot;a_key&quot;: &quot;A String&quot;,
765 },
766 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
767 # proximate cause of the error. Error reasons are unique within a particular
768 # domain of errors. This should be at most 63 characters and match a
769 # regular expression of `A-Z+[A-Z0-9]`, which represents
770 # UPPER_SNAKE_CASE.
771 },
772 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
773 #
774 # For example, if a quota check failed with an error indicating the calling
775 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
776 # directly to the right place in the developer console to flip the bit.
777 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
778 { # Describes a URL link.
779 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
780 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
781 },
782 ],
783 },
784 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
785 # which can be attached to an RPC error.
786 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
787 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
788 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
789 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
790 },
791 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
792 &quot;dimensions&quot;: { # The map holding related quota dimensions.
793 &quot;a_key&quot;: &quot;A String&quot;,
794 },
795 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
796 # type or metric.
797 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
798 # or metric.
799 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
800 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
801 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
802 },
803 },
804 ],
805 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
806 # This property is optional.
807 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
808 },
809 ],
810 },
811 &quot;getVersionOperationMetadata&quot;: {
812 &quot;inlineSbomInfo&quot;: {
813 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
814 # appropriate identifiers.
815 &quot;a_key&quot;: &quot;A String&quot;,
816 },
817 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
818 # identifiers.
819 &quot;a_key&quot;: &quot;A String&quot;,
820 },
821 },
822 },
823 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
824 # message that was returned, such as `NOT FOUND`.
825 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
826 # status code that was returned. For example, a `404` means the
827 # resource was not found.
828 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
829 # defined by the server.
830 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
831 # This value is inRFC3339
832 # text format.
833 &quot;instancesBulkInsertOperationMetadata&quot;: {
834 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
835 # Example key: zones/us-central1-a
836 &quot;a_key&quot;: {
837 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
838 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
839 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
840 # error.
841 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
842 # if the flow is rolling forward or rolling back.
843 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
844 },
845 },
846 },
847 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
848 # Operation resources.
849 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
850 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
851 # group of operations results from a `bulkInsert` API request.
852 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
853 # `update`, or `delete`, and so on.
854 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
855 # There is no requirement that this be linear or support any granularity of
856 # operations. This should not be used to guess when the operation will be
857 # complete. This number should monotonically increase as the operation
858 # progresses.
859 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
860 # applicable when performing regional operations.
861 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
862 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
863 # this field will contain information on all underlying zonal actions and
864 # their state.
865 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
866 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
867 # Example key: zones/us-central1-a
868 &quot;a_key&quot;: {
869 &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
870 # populated.
871 # different programming environments, including REST APIs and RPC APIs. It is
872 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
873 # three pieces of data: error code, error message, and error details.
874 #
875 # You can find out more about this error model and how to work with it in the
876 # [API Design Guide](https://cloud.google.com/apis/design/errors).
877 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
878 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
879 # message types for APIs to use.
880 {
881 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
882 },
883 ],
884 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
885 # user-facing error message should be localized and sent in the
886 # google.rpc.Status.details field, or localized by the client.
887 },
888 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
889 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
890 },
891 },
892 },
893 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
894 # This value is inRFC3339
895 # text format.
896 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
897 # following:
898 # `PENDING`, `RUNNING`, or `DONE`.
899 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
900 # operation.
901 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
902 # of the target resource.
903 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
904 # operations related to creating a snapshot, this points to the disk
905 # that the snapshot was created from.
906 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
907 # `[email protected]` or
908 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
909 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
910 # operation, this field will be populated.
911 {
912 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
913 # Engine returns NO_RESULTS_ON_PAGE if there
914 # are no results in the response.
915 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
916 # value format. For example:
917 #
918 # &quot;data&quot;: [
919 # {
920 # &quot;key&quot;: &quot;scope&quot;,
921 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
922 # }
923 {
924 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
925 # returned. For example, for warnings where there are no results in a list
926 # request for a particular zone, this key might be scope and
927 # the key value might be the zone name. Other examples might be a key
928 # indicating a deprecated resource and a suggested replacement, or a
929 # warning about invalid network settings (for example, if an instance
930 # attempts to perform IP forwarding but is not enabled for IP forwarding).
931 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
932 },
933 ],
934 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
935 },
936 ],
937 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
938 # applicable when performing per-zone operations.
939 }</pre>
940 </div>
941
942 <div class="method">
943 <code class="details" id="addRule">addRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)</code>
944 <pre>Inserts a rule into a firewall policy.
945
946 Args:
947 firewallPolicy: string, Name of the firewall policy to update. (required)
948 body: object, The request body.
949 The object takes the form of:
950
951 { # Represents a rule that describes one or more match conditions along with
952 # the action to be taken when traffic matches this condition (allow or deny).
953 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
954 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
955 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
956 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
957 # and &quot;goto_next&quot;.
958 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
959 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
960 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
961 # the firewall policy rule is not enforced and traffic behaves as if it did
962 # not exist. If this is unspecified, the firewall policy rule will be
963 # enabled.
964 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
965 # enabled, logs will be exported to the configured export destination in
966 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
967 # cannot enable logging on &quot;goto_next&quot; rules.
968 &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.
969 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
970 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
971 # Exactly one field must be specified.
972 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
973 # Maximum number of destination address groups is 10.
974 &quot;A String&quot;,
975 ],
976 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
977 # traffic destination.
978 # Maximum number of destination fqdn allowed is 100.
979 &quot;A String&quot;,
980 ],
981 &quot;destIpRanges&quot;: [ # CIDR IP address range.
982 # Maximum number of destination CIDR IP ranges allowed is 5000.
983 &quot;A String&quot;,
984 ],
985 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
986 #
987 #
988 # - UNSPECIFIED
989 # - INTERNET
990 # - NON_INTERNET
991 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
992 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
993 #
994 #
995 # - UNSPECIFIED
996 # - INTERNET
997 # - NON_INTERNET
998 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
999 # of traffic. Should be specified as 2 letter country code defined as per
1000 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1001 # Maximum number of dest region codes allowed is 5000.
1002 &quot;A String&quot;,
1003 ],
1004 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1005 # The IPs in these lists will be matched against traffic destination.
1006 &quot;A String&quot;,
1007 ],
1008 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1009 {
1010 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1011 # required when creating a firewall rule. This value can either be
1012 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1013 # protocol number.
1014 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1015 # only applicable for UDP or TCP protocol. Each entry must be either
1016 # an integer or a range. If not specified, this rule applies to
1017 # connections through any port.
1018 #
1019 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1020 &quot;A String&quot;,
1021 ],
1022 },
1023 ],
1024 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1025 # Maximum number of source address groups is 10.
1026 &quot;A String&quot;,
1027 ],
1028 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1029 # traffic source.
1030 # Maximum number of source fqdn allowed is 100.
1031 &quot;A String&quot;,
1032 ],
1033 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1034 # Maximum number of source CIDR IP ranges allowed is 5000.
1035 &quot;A String&quot;,
1036 ],
1037 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1038 #
1039 #
1040 # - UNSPECIFIED
1041 # - INTERNET
1042 # - INTRA_VPC
1043 # - NON_INTERNET
1044 # - VPC_NETWORKS
1045 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1046 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1047 #
1048 #
1049 # - UNSPECIFIED
1050 # - INTERNET
1051 # - INTRA_VPC
1052 # - NON_INTERNET
1053 # - VPC_NETWORKS
1054 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1055 &quot;A String&quot;,
1056 ],
1057 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1058 # of traffic. Should be specified as 2 letter country code defined as per
1059 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1060 # Maximum number of source region codes allowed is 5000.
1061 &quot;A String&quot;,
1062 ],
1063 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1064 # of the traffic.
1065 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1066 # and there is no srcIpRange, this rule will be ignored.
1067 # Maximum number of source tag values allowed is 256.
1068 {
1069 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1070 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1071 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1072 # or its network is deleted.
1073 },
1074 ],
1075 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1076 # The IPs in these lists will be matched against traffic source.
1077 &quot;A String&quot;,
1078 ],
1079 },
1080 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1081 # must be a positive value between 0 and 2147483647.
1082 # Rules are evaluated from highest to lowest priority where 0 is the
1083 # highest priority and 2147483647 is the lowest priority.
1084 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1085 # and can be updated.
1086 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1087 # rule.
1088 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1089 # Example:
1090 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1091 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1092 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1093 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
1094 # This field allows you to control which load balancers get this rule.
1095 # For example, the following are valid values:
1096 #
1097 #
1098 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
1099 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1100 # - projects/project/global/
1101 # forwardingRules/forwardingRule
1102 # - projects/project/regions/region/forwardingRules/
1103 # forwardingRule
1104 &quot;A String&quot;,
1105 ],
1106 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
1107 # allows you to control which network&#x27;s VMs get this rule. If this field
1108 # is left blank, all VMs within the organization will receive the rule.
1109 &quot;A String&quot;,
1110 ],
1111 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
1112 # applies to. If targetSecureTag are specified, then the
1113 # firewall rule applies only to instances in the VPC network that have one
1114 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
1115 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
1116 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
1117 # to all instances on the specified network.
1118 # Maximum number of target label tags allowed is 256.
1119 {
1120 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1121 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1122 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1123 # or its network is deleted.
1124 },
1125 ],
1126 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
1127 # applied with this rule.
1128 &quot;A String&quot;,
1129 ],
1130 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
1131 # Default value is INSTANCES.
1132 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
1133 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
1134 # be set for other actions.
1135 }
1136
1137 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1138 that if you must retry your request, the server will know to ignore the
1139 request if it has already been completed.
1140
1141 For example, consider a situation where you make an initial request and
1142 the request times out. If you make the request again with the same
1143 request ID, the server can check if original operation with the same
1144 request ID was received, and if so, will ignore the second request. This
1145 prevents clients from accidentally creating duplicate commitments.
1146
1147 The request ID must be
1148 a valid UUID with the exception that zero UUID is not supported
1149 (00000000-0000-0000-0000-000000000000).
1150 x__xgafv: string, V1 error format.
1151 Allowed values
1152 1 - v1 error format
1153 2 - v2 error format
1154
1155 Returns:
1156 An object of the form:
1157
1158 { # Represents an Operation resource.
1159 #
1160 # Google Compute Engine has three Operation resources:
1161 #
1162 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1163 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1164 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1165 #
1166 # You can use an operation resource to manage asynchronous API requests.
1167 # For more information, readHandling
1168 # API responses.
1169 #
1170 # Operations can be global, regional or zonal.
1171 #
1172 # - For global operations, use the `globalOperations`
1173 # resource.
1174 # - For regional operations, use the
1175 # `regionOperations` resource.
1176 # - For zonal operations, use
1177 # the `zoneOperations` resource.
1178 #
1179 #
1180 #
1181 # For more information, read
1182 # Global, Regional, and Zonal Resources.
1183 #
1184 # Note that completed Operation resources have a limited
1185 # retention period.
1186 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1187 # Not present otherwise.
1188 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1189 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1190 # set when the operation is created.
1191 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1192 # text format.
1193 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1194 # this field will be populated.
1195 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1196 # operation.
1197 {
1198 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1199 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1200 # details. There is a set of defined message types to use for providing
1201 # details.The syntax depends on the error code. For example,
1202 # QuotaExceededInfo will have details when the error code is
1203 # QUOTA_EXCEEDED.
1204 {
1205 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1206 #
1207 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1208 # is not enabled:
1209 #
1210 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1211 # &quot;domain&quot;: &quot;googleapis.com&quot;
1212 # &quot;metadata&quot;: {
1213 # &quot;resource&quot;: &quot;projects/123&quot;,
1214 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1215 # }
1216 # }
1217 #
1218 # This response indicates that the pubsub.googleapis.com API is not enabled.
1219 #
1220 # Example of an error that is returned when attempting to create a Spanner
1221 # instance in a region that is out of stock:
1222 #
1223 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1224 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1225 # &quot;metadata&quot;: {
1226 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1227 # }
1228 # }
1229 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1230 # is typically the registered service name of the tool or product that
1231 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1232 # generated by some common infrastructure, the error domain must be a
1233 # globally unique value that identifies the infrastructure. For Google API
1234 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1235 &quot;metadatas&quot;: { # Additional structured details about this error.
1236 #
1237 # Keys must match a regular expression of `a-z+` but should
1238 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1239 # length. When identifying the current value of an exceeded limit, the units
1240 # should be contained in the key, not the value. For example, rather than
1241 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1242 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1243 # instances that can be created in a single (batch) request.
1244 &quot;a_key&quot;: &quot;A String&quot;,
1245 },
1246 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1247 # proximate cause of the error. Error reasons are unique within a particular
1248 # domain of errors. This should be at most 63 characters and match a
1249 # regular expression of `A-Z+[A-Z0-9]`, which represents
1250 # UPPER_SNAKE_CASE.
1251 },
1252 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1253 #
1254 # For example, if a quota check failed with an error indicating the calling
1255 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1256 # directly to the right place in the developer console to flip the bit.
1257 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1258 { # Describes a URL link.
1259 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1260 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1261 },
1262 ],
1263 },
1264 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1265 # which can be attached to an RPC error.
1266 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1267 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1268 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1269 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1270 },
1271 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1272 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1273 &quot;a_key&quot;: &quot;A String&quot;,
1274 },
1275 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1276 # type or metric.
1277 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1278 # or metric.
1279 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1280 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1281 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1282 },
1283 },
1284 ],
1285 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1286 # This property is optional.
1287 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1288 },
1289 ],
1290 },
1291 &quot;getVersionOperationMetadata&quot;: {
1292 &quot;inlineSbomInfo&quot;: {
1293 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1294 # appropriate identifiers.
1295 &quot;a_key&quot;: &quot;A String&quot;,
1296 },
1297 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1298 # identifiers.
1299 &quot;a_key&quot;: &quot;A String&quot;,
1300 },
1301 },
1302 },
1303 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1304 # message that was returned, such as `NOT FOUND`.
1305 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1306 # status code that was returned. For example, a `404` means the
1307 # resource was not found.
1308 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1309 # defined by the server.
1310 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1311 # This value is inRFC3339
1312 # text format.
1313 &quot;instancesBulkInsertOperationMetadata&quot;: {
1314 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1315 # Example key: zones/us-central1-a
1316 &quot;a_key&quot;: {
1317 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1318 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1319 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1320 # error.
1321 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1322 # if the flow is rolling forward or rolling back.
1323 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1324 },
1325 },
1326 },
1327 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1328 # Operation resources.
1329 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1330 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1331 # group of operations results from a `bulkInsert` API request.
1332 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1333 # `update`, or `delete`, and so on.
1334 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1335 # There is no requirement that this be linear or support any granularity of
1336 # operations. This should not be used to guess when the operation will be
1337 # complete. This number should monotonically increase as the operation
1338 # progresses.
1339 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1340 # applicable when performing regional operations.
1341 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1342 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1343 # this field will contain information on all underlying zonal actions and
1344 # their state.
1345 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1346 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1347 # Example key: zones/us-central1-a
1348 &quot;a_key&quot;: {
1349 &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
1350 # populated.
1351 # different programming environments, including REST APIs and RPC APIs. It is
1352 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1353 # three pieces of data: error code, error message, and error details.
1354 #
1355 # You can find out more about this error model and how to work with it in the
1356 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1357 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1358 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1359 # message types for APIs to use.
1360 {
1361 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1362 },
1363 ],
1364 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1365 # user-facing error message should be localized and sent in the
1366 # google.rpc.Status.details field, or localized by the client.
1367 },
1368 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1369 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1370 },
1371 },
1372 },
1373 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1374 # This value is inRFC3339
1375 # text format.
1376 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1377 # following:
1378 # `PENDING`, `RUNNING`, or `DONE`.
1379 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1380 # operation.
1381 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1382 # of the target resource.
1383 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1384 # operations related to creating a snapshot, this points to the disk
1385 # that the snapshot was created from.
1386 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1387 # `[email protected]` or
1388 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1389 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1390 # operation, this field will be populated.
1391 {
1392 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1393 # Engine returns NO_RESULTS_ON_PAGE if there
1394 # are no results in the response.
1395 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1396 # value format. For example:
1397 #
1398 # &quot;data&quot;: [
1399 # {
1400 # &quot;key&quot;: &quot;scope&quot;,
1401 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1402 # }
1403 {
1404 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1405 # returned. For example, for warnings where there are no results in a list
1406 # request for a particular zone, this key might be scope and
1407 # the key value might be the zone name. Other examples might be a key
1408 # indicating a deprecated resource and a suggested replacement, or a
1409 # warning about invalid network settings (for example, if an instance
1410 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1411 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1412 },
1413 ],
1414 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1415 },
1416 ],
1417 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1418 # applicable when performing per-zone operations.
1419 }</pre>
1420 </div>
1421
1422 <div class="method">
1423 <code class="details" id="cloneRules">cloneRules(firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</code>
1424 <pre>Copies rules to the specified firewall policy.
1425
1426 Args:
1427 firewallPolicy: string, Name of the firewall policy to update. (required)
1428 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1429 that if you must retry your request, the server will know to ignore the
1430 request if it has already been completed.
1431
1432 For example, consider a situation where you make an initial request and
1433 the request times out. If you make the request again with the same
1434 request ID, the server can check if original operation with the same
1435 request ID was received, and if so, will ignore the second request. This
1436 prevents clients from accidentally creating duplicate commitments.
1437
1438 The request ID must be
1439 a valid UUID with the exception that zero UUID is not supported
1440 (00000000-0000-0000-0000-000000000000).
1441 sourceFirewallPolicy: string, The firewall policy from which to copy rules.
1442 x__xgafv: string, V1 error format.
1443 Allowed values
1444 1 - v1 error format
1445 2 - v2 error format
1446
1447 Returns:
1448 An object of the form:
1449
1450 { # Represents an Operation resource.
1451 #
1452 # Google Compute Engine has three Operation resources:
1453 #
1454 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1455 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1456 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1457 #
1458 # You can use an operation resource to manage asynchronous API requests.
1459 # For more information, readHandling
1460 # API responses.
1461 #
1462 # Operations can be global, regional or zonal.
1463 #
1464 # - For global operations, use the `globalOperations`
1465 # resource.
1466 # - For regional operations, use the
1467 # `regionOperations` resource.
1468 # - For zonal operations, use
1469 # the `zoneOperations` resource.
1470 #
1471 #
1472 #
1473 # For more information, read
1474 # Global, Regional, and Zonal Resources.
1475 #
1476 # Note that completed Operation resources have a limited
1477 # retention period.
1478 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1479 # Not present otherwise.
1480 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1481 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1482 # set when the operation is created.
1483 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1484 # text format.
1485 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1486 # this field will be populated.
1487 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1488 # operation.
1489 {
1490 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1491 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1492 # details. There is a set of defined message types to use for providing
1493 # details.The syntax depends on the error code. For example,
1494 # QuotaExceededInfo will have details when the error code is
1495 # QUOTA_EXCEEDED.
1496 {
1497 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1498 #
1499 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1500 # is not enabled:
1501 #
1502 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1503 # &quot;domain&quot;: &quot;googleapis.com&quot;
1504 # &quot;metadata&quot;: {
1505 # &quot;resource&quot;: &quot;projects/123&quot;,
1506 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1507 # }
1508 # }
1509 #
1510 # This response indicates that the pubsub.googleapis.com API is not enabled.
1511 #
1512 # Example of an error that is returned when attempting to create a Spanner
1513 # instance in a region that is out of stock:
1514 #
1515 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1516 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1517 # &quot;metadata&quot;: {
1518 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1519 # }
1520 # }
1521 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1522 # is typically the registered service name of the tool or product that
1523 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1524 # generated by some common infrastructure, the error domain must be a
1525 # globally unique value that identifies the infrastructure. For Google API
1526 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1527 &quot;metadatas&quot;: { # Additional structured details about this error.
1528 #
1529 # Keys must match a regular expression of `a-z+` but should
1530 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1531 # length. When identifying the current value of an exceeded limit, the units
1532 # should be contained in the key, not the value. For example, rather than
1533 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1534 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1535 # instances that can be created in a single (batch) request.
1536 &quot;a_key&quot;: &quot;A String&quot;,
1537 },
1538 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1539 # proximate cause of the error. Error reasons are unique within a particular
1540 # domain of errors. This should be at most 63 characters and match a
1541 # regular expression of `A-Z+[A-Z0-9]`, which represents
1542 # UPPER_SNAKE_CASE.
1543 },
1544 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1545 #
1546 # For example, if a quota check failed with an error indicating the calling
1547 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1548 # directly to the right place in the developer console to flip the bit.
1549 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1550 { # Describes a URL link.
1551 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1552 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1553 },
1554 ],
1555 },
1556 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1557 # which can be attached to an RPC error.
1558 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1559 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1560 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1561 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1562 },
1563 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1564 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1565 &quot;a_key&quot;: &quot;A String&quot;,
1566 },
1567 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1568 # type or metric.
1569 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1570 # or metric.
1571 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1572 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1573 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1574 },
1575 },
1576 ],
1577 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1578 # This property is optional.
1579 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1580 },
1581 ],
1582 },
1583 &quot;getVersionOperationMetadata&quot;: {
1584 &quot;inlineSbomInfo&quot;: {
1585 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1586 # appropriate identifiers.
1587 &quot;a_key&quot;: &quot;A String&quot;,
1588 },
1589 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1590 # identifiers.
1591 &quot;a_key&quot;: &quot;A String&quot;,
1592 },
1593 },
1594 },
1595 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1596 # message that was returned, such as `NOT FOUND`.
1597 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1598 # status code that was returned. For example, a `404` means the
1599 # resource was not found.
1600 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1601 # defined by the server.
1602 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1603 # This value is inRFC3339
1604 # text format.
1605 &quot;instancesBulkInsertOperationMetadata&quot;: {
1606 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1607 # Example key: zones/us-central1-a
1608 &quot;a_key&quot;: {
1609 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1610 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1611 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1612 # error.
1613 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1614 # if the flow is rolling forward or rolling back.
1615 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1616 },
1617 },
1618 },
1619 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1620 # Operation resources.
1621 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1622 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1623 # group of operations results from a `bulkInsert` API request.
1624 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1625 # `update`, or `delete`, and so on.
1626 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1627 # There is no requirement that this be linear or support any granularity of
1628 # operations. This should not be used to guess when the operation will be
1629 # complete. This number should monotonically increase as the operation
1630 # progresses.
1631 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1632 # applicable when performing regional operations.
1633 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1634 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1635 # this field will contain information on all underlying zonal actions and
1636 # their state.
1637 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1638 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1639 # Example key: zones/us-central1-a
1640 &quot;a_key&quot;: {
1641 &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
1642 # populated.
1643 # different programming environments, including REST APIs and RPC APIs. It is
1644 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1645 # three pieces of data: error code, error message, and error details.
1646 #
1647 # You can find out more about this error model and how to work with it in the
1648 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1649 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1650 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1651 # message types for APIs to use.
1652 {
1653 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1654 },
1655 ],
1656 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1657 # user-facing error message should be localized and sent in the
1658 # google.rpc.Status.details field, or localized by the client.
1659 },
1660 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1661 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1662 },
1663 },
1664 },
1665 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1666 # This value is inRFC3339
1667 # text format.
1668 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1669 # following:
1670 # `PENDING`, `RUNNING`, or `DONE`.
1671 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1672 # operation.
1673 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1674 # of the target resource.
1675 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1676 # operations related to creating a snapshot, this points to the disk
1677 # that the snapshot was created from.
1678 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1679 # `[email protected]` or
1680 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1681 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1682 # operation, this field will be populated.
1683 {
1684 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1685 # Engine returns NO_RESULTS_ON_PAGE if there
1686 # are no results in the response.
1687 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1688 # value format. For example:
1689 #
1690 # &quot;data&quot;: [
1691 # {
1692 # &quot;key&quot;: &quot;scope&quot;,
1693 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1694 # }
1695 {
1696 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1697 # returned. For example, for warnings where there are no results in a list
1698 # request for a particular zone, this key might be scope and
1699 # the key value might be the zone name. Other examples might be a key
1700 # indicating a deprecated resource and a suggested replacement, or a
1701 # warning about invalid network settings (for example, if an instance
1702 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1703 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1704 },
1705 ],
1706 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1707 },
1708 ],
1709 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1710 # applicable when performing per-zone operations.
1711 }</pre>
1712 </div>
1713
1714 <div class="method">
1715 <code class="details" id="close">close()</code>
1716 <pre>Close httplib2 connections.</pre>
1717 </div>
1718
1719 <div class="method">
1720 <code class="details" id="delete">delete(firewallPolicy, requestId=None, x__xgafv=None)</code>
1721 <pre>Deletes the specified policy.
1722
1723 Args:
1724 firewallPolicy: string, Name of the firewall policy to delete. (required)
1725 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1726 that if you must retry your request, the server will know to ignore the
1727 request if it has already been completed.
1728
1729 For example, consider a situation where you make an initial request and
1730 the request times out. If you make the request again with the same
1731 request ID, the server can check if original operation with the same
1732 request ID was received, and if so, will ignore the second request. This
1733 prevents clients from accidentally creating duplicate commitments.
1734
1735 The request ID must be
1736 a valid UUID with the exception that zero UUID is not supported
1737 (00000000-0000-0000-0000-000000000000).
1738 x__xgafv: string, V1 error format.
1739 Allowed values
1740 1 - v1 error format
1741 2 - v2 error format
1742
1743 Returns:
1744 An object of the form:
1745
1746 { # Represents an Operation resource.
1747 #
1748 # Google Compute Engine has three Operation resources:
1749 #
1750 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1751 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1752 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1753 #
1754 # You can use an operation resource to manage asynchronous API requests.
1755 # For more information, readHandling
1756 # API responses.
1757 #
1758 # Operations can be global, regional or zonal.
1759 #
1760 # - For global operations, use the `globalOperations`
1761 # resource.
1762 # - For regional operations, use the
1763 # `regionOperations` resource.
1764 # - For zonal operations, use
1765 # the `zoneOperations` resource.
1766 #
1767 #
1768 #
1769 # For more information, read
1770 # Global, Regional, and Zonal Resources.
1771 #
1772 # Note that completed Operation resources have a limited
1773 # retention period.
1774 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1775 # Not present otherwise.
1776 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1777 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1778 # set when the operation is created.
1779 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1780 # text format.
1781 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1782 # this field will be populated.
1783 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1784 # operation.
1785 {
1786 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1787 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1788 # details. There is a set of defined message types to use for providing
1789 # details.The syntax depends on the error code. For example,
1790 # QuotaExceededInfo will have details when the error code is
1791 # QUOTA_EXCEEDED.
1792 {
1793 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1794 #
1795 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1796 # is not enabled:
1797 #
1798 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1799 # &quot;domain&quot;: &quot;googleapis.com&quot;
1800 # &quot;metadata&quot;: {
1801 # &quot;resource&quot;: &quot;projects/123&quot;,
1802 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1803 # }
1804 # }
1805 #
1806 # This response indicates that the pubsub.googleapis.com API is not enabled.
1807 #
1808 # Example of an error that is returned when attempting to create a Spanner
1809 # instance in a region that is out of stock:
1810 #
1811 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1812 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1813 # &quot;metadata&quot;: {
1814 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1815 # }
1816 # }
1817 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1818 # is typically the registered service name of the tool or product that
1819 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1820 # generated by some common infrastructure, the error domain must be a
1821 # globally unique value that identifies the infrastructure. For Google API
1822 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1823 &quot;metadatas&quot;: { # Additional structured details about this error.
1824 #
1825 # Keys must match a regular expression of `a-z+` but should
1826 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1827 # length. When identifying the current value of an exceeded limit, the units
1828 # should be contained in the key, not the value. For example, rather than
1829 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1830 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1831 # instances that can be created in a single (batch) request.
1832 &quot;a_key&quot;: &quot;A String&quot;,
1833 },
1834 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1835 # proximate cause of the error. Error reasons are unique within a particular
1836 # domain of errors. This should be at most 63 characters and match a
1837 # regular expression of `A-Z+[A-Z0-9]`, which represents
1838 # UPPER_SNAKE_CASE.
1839 },
1840 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1841 #
1842 # For example, if a quota check failed with an error indicating the calling
1843 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1844 # directly to the right place in the developer console to flip the bit.
1845 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1846 { # Describes a URL link.
1847 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1848 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1849 },
1850 ],
1851 },
1852 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1853 # which can be attached to an RPC error.
1854 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1855 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1856 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1857 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1858 },
1859 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1860 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1861 &quot;a_key&quot;: &quot;A String&quot;,
1862 },
1863 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1864 # type or metric.
1865 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1866 # or metric.
1867 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1868 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1869 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1870 },
1871 },
1872 ],
1873 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1874 # This property is optional.
1875 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1876 },
1877 ],
1878 },
1879 &quot;getVersionOperationMetadata&quot;: {
1880 &quot;inlineSbomInfo&quot;: {
1881 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1882 # appropriate identifiers.
1883 &quot;a_key&quot;: &quot;A String&quot;,
1884 },
1885 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1886 # identifiers.
1887 &quot;a_key&quot;: &quot;A String&quot;,
1888 },
1889 },
1890 },
1891 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1892 # message that was returned, such as `NOT FOUND`.
1893 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1894 # status code that was returned. For example, a `404` means the
1895 # resource was not found.
1896 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1897 # defined by the server.
1898 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1899 # This value is inRFC3339
1900 # text format.
1901 &quot;instancesBulkInsertOperationMetadata&quot;: {
1902 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1903 # Example key: zones/us-central1-a
1904 &quot;a_key&quot;: {
1905 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1906 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1907 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1908 # error.
1909 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1910 # if the flow is rolling forward or rolling back.
1911 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1912 },
1913 },
1914 },
1915 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1916 # Operation resources.
1917 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1918 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1919 # group of operations results from a `bulkInsert` API request.
1920 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1921 # `update`, or `delete`, and so on.
1922 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1923 # There is no requirement that this be linear or support any granularity of
1924 # operations. This should not be used to guess when the operation will be
1925 # complete. This number should monotonically increase as the operation
1926 # progresses.
1927 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1928 # applicable when performing regional operations.
1929 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1930 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1931 # this field will contain information on all underlying zonal actions and
1932 # their state.
1933 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1934 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1935 # Example key: zones/us-central1-a
1936 &quot;a_key&quot;: {
1937 &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
1938 # populated.
1939 # different programming environments, including REST APIs and RPC APIs. It is
1940 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1941 # three pieces of data: error code, error message, and error details.
1942 #
1943 # You can find out more about this error model and how to work with it in the
1944 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1945 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1946 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1947 # message types for APIs to use.
1948 {
1949 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1950 },
1951 ],
1952 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1953 # user-facing error message should be localized and sent in the
1954 # google.rpc.Status.details field, or localized by the client.
1955 },
1956 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1957 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1958 },
1959 },
1960 },
1961 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1962 # This value is inRFC3339
1963 # text format.
1964 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1965 # following:
1966 # `PENDING`, `RUNNING`, or `DONE`.
1967 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1968 # operation.
1969 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1970 # of the target resource.
1971 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1972 # operations related to creating a snapshot, this points to the disk
1973 # that the snapshot was created from.
1974 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1975 # `[email protected]` or
1976 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1977 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1978 # operation, this field will be populated.
1979 {
1980 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1981 # Engine returns NO_RESULTS_ON_PAGE if there
1982 # are no results in the response.
1983 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1984 # value format. For example:
1985 #
1986 # &quot;data&quot;: [
1987 # {
1988 # &quot;key&quot;: &quot;scope&quot;,
1989 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1990 # }
1991 {
1992 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1993 # returned. For example, for warnings where there are no results in a list
1994 # request for a particular zone, this key might be scope and
1995 # the key value might be the zone name. Other examples might be a key
1996 # indicating a deprecated resource and a suggested replacement, or a
1997 # warning about invalid network settings (for example, if an instance
1998 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1999 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2000 },
2001 ],
2002 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2003 },
2004 ],
2005 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2006 # applicable when performing per-zone operations.
2007 }</pre>
2008 </div>
2009
2010 <div class="method">
2011 <code class="details" id="get">get(firewallPolicy, x__xgafv=None)</code>
2012 <pre>Returns the specified firewall policy.
2013
2014 Args:
2015 firewallPolicy: string, Name of the firewall policy to get. (required)
2016 x__xgafv: string, V1 error format.
2017 Allowed values
2018 1 - v1 error format
2019 2 - v2 error format
2020
2021 Returns:
2022 An object of the form:
2023
2024 { # Represents a Firewall Policy resource.
2025 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
2026 {
2027 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
2028 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
2029 # of the firewall policy of the association.
2030 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
2031 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
2032 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
2033 # must be a positive value between 1 and 2147483647.
2034 # Firewall Policies are evaluated from highest to lowest priority where 1
2035 # is the highest priority and 2147483647 is the lowest priority.
2036 # The default value is `1000`. If two associations have the same priority
2037 # then lexicographical order on association names is applied.
2038 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
2039 },
2040 ],
2041 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2042 # text format.
2043 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2044 # create the resource.
2045 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
2046 # Organization firewall policy. The name should be unique in the organization
2047 # in which the firewall policy is created.
2048 # This field is not applicable to network firewall policies.
2049 # This name must be set on creation and cannot be changed.
2050 # The name must be 1-63 characters long, and comply
2051 # with RFC1035. Specifically, the name must be 1-63 characters
2052 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
2053 # means the first character must be a lowercase letter, and all following
2054 # characters must be a dash, lowercase letter, or digit, except the last
2055 # character, which cannot be a dash.
2056 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
2057 # the metadata&#x27;s contents and used for optimistic locking. The
2058 # fingerprint is initially generated by Compute Engine and changes after
2059 # every request to modify or update metadata. You must always provide an
2060 # up-to-date fingerprint hash in order to update or change metadata,
2061 # otherwise the request will fail with error412 conditionNotMet.
2062 #
2063 # To see the latest fingerprint, make get() request to the
2064 # firewall policy.
2065 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2066 # defined by the server.
2067 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
2068 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
2069 # [Output Only] numeric ID allocated by Google Cloud which uniquely
2070 # identifies the Organization Firewall Policy.
2071 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
2072 { # Represents a rule that describes one or more match conditions along with
2073 # the action to be taken when traffic matches this condition (allow or deny).
2074 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
2075 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
2076 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
2077 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
2078 # and &quot;goto_next&quot;.
2079 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
2080 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
2081 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
2082 # the firewall policy rule is not enforced and traffic behaves as if it did
2083 # not exist. If this is unspecified, the firewall policy rule will be
2084 # enabled.
2085 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
2086 # enabled, logs will be exported to the configured export destination in
2087 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
2088 # cannot enable logging on &quot;goto_next&quot; rules.
2089 &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.
2090 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
2091 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
2092 # Exactly one field must be specified.
2093 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
2094 # Maximum number of destination address groups is 10.
2095 &quot;A String&quot;,
2096 ],
2097 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2098 # traffic destination.
2099 # Maximum number of destination fqdn allowed is 100.
2100 &quot;A String&quot;,
2101 ],
2102 &quot;destIpRanges&quot;: [ # CIDR IP address range.
2103 # Maximum number of destination CIDR IP ranges allowed is 5000.
2104 &quot;A String&quot;,
2105 ],
2106 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
2107 #
2108 #
2109 # - UNSPECIFIED
2110 # - INTERNET
2111 # - NON_INTERNET
2112 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
2113 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
2114 #
2115 #
2116 # - UNSPECIFIED
2117 # - INTERNET
2118 # - NON_INTERNET
2119 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
2120 # of traffic. Should be specified as 2 letter country code defined as per
2121 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2122 # Maximum number of dest region codes allowed is 5000.
2123 &quot;A String&quot;,
2124 ],
2125 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2126 # The IPs in these lists will be matched against traffic destination.
2127 &quot;A String&quot;,
2128 ],
2129 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
2130 {
2131 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
2132 # required when creating a firewall rule. This value can either be
2133 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
2134 # protocol number.
2135 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
2136 # only applicable for UDP or TCP protocol. Each entry must be either
2137 # an integer or a range. If not specified, this rule applies to
2138 # connections through any port.
2139 #
2140 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
2141 &quot;A String&quot;,
2142 ],
2143 },
2144 ],
2145 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
2146 # Maximum number of source address groups is 10.
2147 &quot;A String&quot;,
2148 ],
2149 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2150 # traffic source.
2151 # Maximum number of source fqdn allowed is 100.
2152 &quot;A String&quot;,
2153 ],
2154 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
2155 # Maximum number of source CIDR IP ranges allowed is 5000.
2156 &quot;A String&quot;,
2157 ],
2158 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
2159 #
2160 #
2161 # - UNSPECIFIED
2162 # - INTERNET
2163 # - INTRA_VPC
2164 # - NON_INTERNET
2165 # - VPC_NETWORKS
2166 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
2167 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
2168 #
2169 #
2170 # - UNSPECIFIED
2171 # - INTERNET
2172 # - INTRA_VPC
2173 # - NON_INTERNET
2174 # - VPC_NETWORKS
2175 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
2176 &quot;A String&quot;,
2177 ],
2178 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
2179 # of traffic. Should be specified as 2 letter country code defined as per
2180 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2181 # Maximum number of source region codes allowed is 5000.
2182 &quot;A String&quot;,
2183 ],
2184 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
2185 # of the traffic.
2186 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
2187 # and there is no srcIpRange, this rule will be ignored.
2188 # Maximum number of source tag values allowed is 256.
2189 {
2190 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2191 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2192 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2193 # or its network is deleted.
2194 },
2195 ],
2196 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2197 # The IPs in these lists will be matched against traffic source.
2198 &quot;A String&quot;,
2199 ],
2200 },
2201 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
2202 # must be a positive value between 0 and 2147483647.
2203 # Rules are evaluated from highest to lowest priority where 0 is the
2204 # highest priority and 2147483647 is the lowest priority.
2205 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
2206 # and can be updated.
2207 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
2208 # rule.
2209 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
2210 # Example:
2211 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
2212 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
2213 # &#x27;mirror&#x27;. Cannot be specified for other actions.
2214 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
2215 # This field allows you to control which load balancers get this rule.
2216 # For example, the following are valid values:
2217 #
2218 #
2219 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
2220 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2221 # - projects/project/global/
2222 # forwardingRules/forwardingRule
2223 # - projects/project/regions/region/forwardingRules/
2224 # forwardingRule
2225 &quot;A String&quot;,
2226 ],
2227 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
2228 # allows you to control which network&#x27;s VMs get this rule. If this field
2229 # is left blank, all VMs within the organization will receive the rule.
2230 &quot;A String&quot;,
2231 ],
2232 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
2233 # applies to. If targetSecureTag are specified, then the
2234 # firewall rule applies only to instances in the VPC network that have one
2235 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
2236 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
2237 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
2238 # to all instances on the specified network.
2239 # Maximum number of target label tags allowed is 256.
2240 {
2241 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2242 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2243 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2244 # or its network is deleted.
2245 },
2246 ],
2247 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
2248 # applied with this rule.
2249 &quot;A String&quot;,
2250 ],
2251 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
2252 # Default value is INSTANCES.
2253 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
2254 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
2255 # be set for other actions.
2256 },
2257 ],
2258 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
2259 # This field is not applicable to network firewall policies.
2260 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
2261 # creation and defaults to USER_DEFINED.
2262 #
2263 # The USER_DEFINED value indicates a regular firewall policy.
2264 #
2265 # The SYSTEM value indicates a system-level policy managed by an
2266 # internal service like GKE. This SYSTEM value is reserved for
2267 # internal services and cannot be set by users during policy creation.
2268 # Policies with a SYSTEM source cannot be modified or deleted by
2269 # users.
2270 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
2271 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
2272 #
2273 # Note: if not specified then VPC_POLICY will be used.
2274 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
2275 # This field is not applicable to global firewall policies.
2276 # You must specify this field as part of the HTTP request URL. It is
2277 # not settable as a field in the request body.
2278 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
2279 # policy can not exceed a set number of tuples.
2280 &quot;rules&quot;: [ # A list of rules that belong to this policy.
2281 # There must always be a default rule (rule with priority 2147483647 and
2282 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
2283 # default rule with action &quot;allow&quot; will be added.
2284 { # Represents a rule that describes one or more match conditions along with
2285 # the action to be taken when traffic matches this condition (allow or deny).
2286 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
2287 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
2288 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
2289 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
2290 # and &quot;goto_next&quot;.
2291 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
2292 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
2293 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
2294 # the firewall policy rule is not enforced and traffic behaves as if it did
2295 # not exist. If this is unspecified, the firewall policy rule will be
2296 # enabled.
2297 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
2298 # enabled, logs will be exported to the configured export destination in
2299 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
2300 # cannot enable logging on &quot;goto_next&quot; rules.
2301 &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.
2302 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
2303 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
2304 # Exactly one field must be specified.
2305 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
2306 # Maximum number of destination address groups is 10.
2307 &quot;A String&quot;,
2308 ],
2309 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2310 # traffic destination.
2311 # Maximum number of destination fqdn allowed is 100.
2312 &quot;A String&quot;,
2313 ],
2314 &quot;destIpRanges&quot;: [ # CIDR IP address range.
2315 # Maximum number of destination CIDR IP ranges allowed is 5000.
2316 &quot;A String&quot;,
2317 ],
2318 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
2319 #
2320 #
2321 # - UNSPECIFIED
2322 # - INTERNET
2323 # - NON_INTERNET
2324 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
2325 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
2326 #
2327 #
2328 # - UNSPECIFIED
2329 # - INTERNET
2330 # - NON_INTERNET
2331 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
2332 # of traffic. Should be specified as 2 letter country code defined as per
2333 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2334 # Maximum number of dest region codes allowed is 5000.
2335 &quot;A String&quot;,
2336 ],
2337 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2338 # The IPs in these lists will be matched against traffic destination.
2339 &quot;A String&quot;,
2340 ],
2341 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
2342 {
2343 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
2344 # required when creating a firewall rule. This value can either be
2345 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
2346 # protocol number.
2347 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
2348 # only applicable for UDP or TCP protocol. Each entry must be either
2349 # an integer or a range. If not specified, this rule applies to
2350 # connections through any port.
2351 #
2352 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
2353 &quot;A String&quot;,
2354 ],
2355 },
2356 ],
2357 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
2358 # Maximum number of source address groups is 10.
2359 &quot;A String&quot;,
2360 ],
2361 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2362 # traffic source.
2363 # Maximum number of source fqdn allowed is 100.
2364 &quot;A String&quot;,
2365 ],
2366 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
2367 # Maximum number of source CIDR IP ranges allowed is 5000.
2368 &quot;A String&quot;,
2369 ],
2370 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
2371 #
2372 #
2373 # - UNSPECIFIED
2374 # - INTERNET
2375 # - INTRA_VPC
2376 # - NON_INTERNET
2377 # - VPC_NETWORKS
2378 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
2379 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
2380 #
2381 #
2382 # - UNSPECIFIED
2383 # - INTERNET
2384 # - INTRA_VPC
2385 # - NON_INTERNET
2386 # - VPC_NETWORKS
2387 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
2388 &quot;A String&quot;,
2389 ],
2390 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
2391 # of traffic. Should be specified as 2 letter country code defined as per
2392 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2393 # Maximum number of source region codes allowed is 5000.
2394 &quot;A String&quot;,
2395 ],
2396 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
2397 # of the traffic.
2398 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
2399 # and there is no srcIpRange, this rule will be ignored.
2400 # Maximum number of source tag values allowed is 256.
2401 {
2402 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2403 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2404 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2405 # or its network is deleted.
2406 },
2407 ],
2408 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2409 # The IPs in these lists will be matched against traffic source.
2410 &quot;A String&quot;,
2411 ],
2412 },
2413 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
2414 # must be a positive value between 0 and 2147483647.
2415 # Rules are evaluated from highest to lowest priority where 0 is the
2416 # highest priority and 2147483647 is the lowest priority.
2417 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
2418 # and can be updated.
2419 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
2420 # rule.
2421 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
2422 # Example:
2423 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
2424 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
2425 # &#x27;mirror&#x27;. Cannot be specified for other actions.
2426 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
2427 # This field allows you to control which load balancers get this rule.
2428 # For example, the following are valid values:
2429 #
2430 #
2431 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
2432 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2433 # - projects/project/global/
2434 # forwardingRules/forwardingRule
2435 # - projects/project/regions/region/forwardingRules/
2436 # forwardingRule
2437 &quot;A String&quot;,
2438 ],
2439 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
2440 # allows you to control which network&#x27;s VMs get this rule. If this field
2441 # is left blank, all VMs within the organization will receive the rule.
2442 &quot;A String&quot;,
2443 ],
2444 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
2445 # applies to. If targetSecureTag are specified, then the
2446 # firewall rule applies only to instances in the VPC network that have one
2447 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
2448 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
2449 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
2450 # to all instances on the specified network.
2451 # Maximum number of target label tags allowed is 256.
2452 {
2453 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2454 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2455 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2456 # or its network is deleted.
2457 },
2458 ],
2459 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
2460 # applied with this rule.
2461 &quot;A String&quot;,
2462 ],
2463 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
2464 # Default value is INSTANCES.
2465 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
2466 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
2467 # be set for other actions.
2468 },
2469 ],
2470 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2471 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2472 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
2473 # unique in the organization in which the firewall policy is created.
2474 # This field is not applicable to network firewall policies.
2475 # This name must be set on creation and cannot be changed. The name must be
2476 # 1-63 characters long, and comply with RFC1035.
2477 # Specifically, the name must be 1-63 characters long and match the regular
2478 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2479 # character must be a lowercase letter, and all following characters must
2480 # be a dash, lowercase letter, or digit, except the last character, which
2481 # cannot be a dash.
2482 }</pre>
2483 </div>
2484
2485 <div class="method">
2486 <code class="details" id="getAssociation">getAssociation(firewallPolicy, name=None, x__xgafv=None)</code>
2487 <pre>Gets an association with the specified name.
2488
2489 Args:
2490 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
2491 name: string, The name of the association to get from the firewall policy.
2492 x__xgafv: string, V1 error format.
2493 Allowed values
2494 1 - v1 error format
2495 2 - v2 error format
2496
2497 Returns:
2498 An object of the form:
2499
2500 {
2501 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
2502 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
2503 # of the firewall policy of the association.
2504 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
2505 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
2506 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
2507 # must be a positive value between 1 and 2147483647.
2508 # Firewall Policies are evaluated from highest to lowest priority where 1
2509 # is the highest priority and 2147483647 is the lowest priority.
2510 # The default value is `1000`. If two associations have the same priority
2511 # then lexicographical order on association names is applied.
2512 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
2513 }</pre>
2514 </div>
2515
2516 <div class="method">
2517 <code class="details" id="getIamPolicy">getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
2518 <pre>Gets the access control policy for a resource. May be empty if no such
2519 policy or resource exists.
2520
2521 Args:
2522 resource: string, Name or id of the resource for this request. (required)
2523 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
2524 x__xgafv: string, V1 error format.
2525 Allowed values
2526 1 - v1 error format
2527 2 - v2 error format
2528
2529 Returns:
2530 An object of the form:
2531
2532 { # An Identity and Access Management (IAM) policy, which specifies access
2533 # controls for Google Cloud resources.
2534 #
2535 #
2536 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2537 # `members`, or principals, to a single `role`. Principals can be user
2538 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2539 # `role` is a named list of permissions; each `role` can be an IAM predefined
2540 # role or a user-created custom role.
2541 #
2542 # For some types of Google Cloud resources, a `binding` can also specify a
2543 # `condition`, which is a logical expression that allows access to a resource
2544 # only if the expression evaluates to `true`. A condition can add constraints
2545 # based on attributes of the request, the resource, or both. To learn which
2546 # resources support conditions in their IAM policies, see the
2547 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2548 #
2549 # **JSON example:**
2550 #
2551 # ```
2552 # {
2553 # &quot;bindings&quot;: [
2554 # {
2555 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2556 # &quot;members&quot;: [
2557 # &quot;user:[email protected]&quot;,
2558 # &quot;group:[email protected]&quot;,
2559 # &quot;domain:google.com&quot;,
2560 # &quot;serviceAccount:[email protected]&quot;
2561 # ]
2562 # },
2563 # {
2564 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2565 # &quot;members&quot;: [
2566 # &quot;user:[email protected]&quot;
2567 # ],
2568 # &quot;condition&quot;: {
2569 # &quot;title&quot;: &quot;expirable access&quot;,
2570 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2571 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2572 # }
2573 # }
2574 # ],
2575 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2576 # &quot;version&quot;: 3
2577 # }
2578 # ```
2579 #
2580 # **YAML example:**
2581 #
2582 # ```
2583 # bindings:
2584 # - members:
2585 # - user:[email protected]
2586 # - group:[email protected]
2587 # - domain:google.com
2588 # - serviceAccount:[email protected]
2589 # role: roles/resourcemanager.organizationAdmin
2590 # - members:
2591 # - user:[email protected]
2592 # role: roles/resourcemanager.organizationViewer
2593 # condition:
2594 # title: expirable access
2595 # description: Does not grant access after Sep 2020
2596 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2597 # etag: BwWWja0YfJA=
2598 # version: 3
2599 # ```
2600 #
2601 # For a description of IAM and its features, see the
2602 # [IAM documentation](https://cloud.google.com/iam/docs/).
2603 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2604 { # Specifies the audit configuration for a service.
2605 # The configuration determines which permission types are logged, and what
2606 # identities, if any, are exempted from logging.
2607 # An AuditConfig must have one or more AuditLogConfigs.
2608 #
2609 # If there are AuditConfigs for both `allServices` and a specific service,
2610 # the union of the two AuditConfigs is used for that service: the log_types
2611 # specified in each AuditConfig are enabled, and the exempted_members in each
2612 # AuditLogConfig are exempted.
2613 #
2614 # Example Policy with multiple AuditConfigs:
2615 #
2616 # {
2617 # &quot;audit_configs&quot;: [
2618 # {
2619 # &quot;service&quot;: &quot;allServices&quot;,
2620 # &quot;audit_log_configs&quot;: [
2621 # {
2622 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2623 # &quot;exempted_members&quot;: [
2624 # &quot;user:[email protected]&quot;
2625 # ]
2626 # },
2627 # {
2628 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2629 # },
2630 # {
2631 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2632 # }
2633 # ]
2634 # },
2635 # {
2636 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2637 # &quot;audit_log_configs&quot;: [
2638 # {
2639 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2640 # },
2641 # {
2642 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2643 # &quot;exempted_members&quot;: [
2644 # &quot;user:[email protected]&quot;
2645 # ]
2646 # }
2647 # ]
2648 # }
2649 # ]
2650 # }
2651 #
2652 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2653 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2654 # `[email protected]` from DATA_WRITE logging.
2655 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2656 { # Provides the configuration for logging a type of permissions.
2657 # Example:
2658 #
2659 # {
2660 # &quot;audit_log_configs&quot;: [
2661 # {
2662 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2663 # &quot;exempted_members&quot;: [
2664 # &quot;user:[email protected]&quot;
2665 # ]
2666 # },
2667 # {
2668 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2669 # }
2670 # ]
2671 # }
2672 #
2673 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2674 # [email protected] from DATA_READ logging.
2675 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2676 # permission.
2677 # Follows the same format of Binding.members.
2678 &quot;A String&quot;,
2679 ],
2680 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2681 },
2682 ],
2683 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2684 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2685 # `allServices` is a special value that covers all services.
2686 },
2687 ],
2688 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2689 # may specify a `condition` that determines how and when the `bindings` are
2690 # applied. Each of the `bindings` must contain at least one principal.
2691 #
2692 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2693 # of these principals can be Google groups. Each occurrence of a principal
2694 # counts towards these limits. For example, if the `bindings` grant 50
2695 # different roles to `user:[email protected]`, and not to any other
2696 # principal, then you can add another 1,450 principals to the `bindings` in
2697 # the `Policy`.
2698 { # Associates `members`, or principals, with a `role`.
2699 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2700 #
2701 # If the condition evaluates to `true`, then this binding applies to the
2702 # current request.
2703 #
2704 # If the condition evaluates to `false`, then this binding does not apply to
2705 # the current request. However, a different role binding might grant the same
2706 # role to one or more of the principals in this binding.
2707 #
2708 # To learn which resources support conditions in their IAM policies, see the
2709 # [IAM
2710 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2711 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2712 # are documented at https://github.com/google/cel-spec.
2713 #
2714 # Example (Comparison):
2715 #
2716 # title: &quot;Summary size limit&quot;
2717 # description: &quot;Determines if a summary is less than 100 chars&quot;
2718 # expression: &quot;document.summary.size() &lt; 100&quot;
2719 #
2720 # Example (Equality):
2721 #
2722 # title: &quot;Requestor is owner&quot;
2723 # description: &quot;Determines if requestor is the document owner&quot;
2724 # expression: &quot;document.owner == request.auth.claims.email&quot;
2725 #
2726 # Example (Logic):
2727 #
2728 # title: &quot;Public documents&quot;
2729 # description: &quot;Determine whether the document should be publicly visible&quot;
2730 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2731 #
2732 # Example (Data Manipulation):
2733 #
2734 # title: &quot;Notification string&quot;
2735 # description: &quot;Create a notification string with a timestamp.&quot;
2736 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2737 #
2738 # The exact variables and functions that may be referenced within an expression
2739 # are determined by the service that evaluates it. See the service
2740 # documentation for additional information.
2741 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2742 # describes the expression, e.g. when hovered over it in a UI.
2743 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2744 # syntax.
2745 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2746 # reporting, e.g. a file name and a position in the file.
2747 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2748 # its purpose. This can be used e.g. in UIs which allow to enter the
2749 # expression.
2750 },
2751 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2752 # `members` can have the following values:
2753 #
2754 # * `allUsers`: A special identifier that represents anyone who is
2755 # on the internet; with or without a Google account.
2756 #
2757 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2758 # who is authenticated with a Google account or a service account.
2759 # Does not include identities that come from external identity providers
2760 # (IdPs) through identity federation.
2761 #
2762 # * `user:{emailid}`: An email address that represents a specific Google
2763 # account. For example, `[email protected]` .
2764 #
2765 #
2766 # * `serviceAccount:{emailid}`: An email address that represents a Google
2767 # service account. For example,
2768 # `[email protected]`.
2769 #
2770 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2771 # identifier for a
2772 # [Kubernetes service
2773 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2774 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2775 #
2776 # * `group:{emailid}`: An email address that represents a Google group.
2777 # For example, `[email protected]`.
2778 #
2779 #
2780 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2781 # users of that domain. For example, `google.com` or `example.com`.
2782 #
2783 #
2784 #
2785 #
2786 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2787 # A single identity in a workforce identity pool.
2788 #
2789 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2790 # All workforce identities in a group.
2791 #
2792 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2793 # All workforce identities with a specific attribute value.
2794 #
2795 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2796 # All identities in a workforce identity pool.
2797 #
2798 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2799 # A single identity in a workload identity pool.
2800 #
2801 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2802 # A workload identity pool group.
2803 #
2804 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2805 # All identities in a workload identity pool with a certain attribute.
2806 #
2807 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2808 # All identities in a workload identity pool.
2809 #
2810 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2811 # identifier) representing a user that has been recently deleted. For
2812 # example, `[email protected]?uid=123456789012345678901`. If the user is
2813 # recovered, this value reverts to `user:{emailid}` and the recovered user
2814 # retains the role in the binding.
2815 #
2816 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2817 # unique identifier) representing a service account that has been recently
2818 # deleted. For example,
2819 # `[email protected]?uid=123456789012345678901`.
2820 # If the service account is undeleted, this value reverts to
2821 # `serviceAccount:{emailid}` and the undeleted service account retains the
2822 # role in the binding.
2823 #
2824 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2825 # identifier) representing a Google group that has been recently
2826 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2827 # the group is recovered, this value reverts to `group:{emailid}` and the
2828 # recovered group retains the role in the binding.
2829 #
2830 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2831 # Deleted single identity in a workforce identity pool. For example,
2832 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2833 &quot;A String&quot;,
2834 ],
2835 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2836 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2837 #
2838 # For an overview of the IAM roles and permissions, see the
2839 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2840 # a list of the available pre-defined roles, see
2841 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2842 },
2843 ],
2844 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2845 # prevent simultaneous updates of a policy from overwriting each other.
2846 # It is strongly suggested that systems make use of the `etag` in the
2847 # read-modify-write cycle to perform policy updates in order to avoid race
2848 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2849 # systems are expected to put that etag in the request to `setIamPolicy` to
2850 # ensure that their change will be applied to the same version of the policy.
2851 #
2852 # **Important:** If you use IAM Conditions, you must include the `etag` field
2853 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2854 # you to overwrite a version `3` policy with a version `1` policy, and all of
2855 # the conditions in the version `3` policy are lost.
2856 &quot;version&quot;: 42, # Specifies the format of the policy.
2857 #
2858 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2859 # are rejected.
2860 #
2861 # Any operation that affects conditional role bindings must specify version
2862 # `3`. This requirement applies to the following operations:
2863 #
2864 # * Getting a policy that includes a conditional role binding
2865 # * Adding a conditional role binding to a policy
2866 # * Changing a conditional role binding in a policy
2867 # * Removing any role binding, with or without a condition, from a policy
2868 # that includes conditions
2869 #
2870 # **Important:** If you use IAM Conditions, you must include the `etag` field
2871 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2872 # you to overwrite a version `3` policy with a version `1` policy, and all of
2873 # the conditions in the version `3` policy are lost.
2874 #
2875 # If a policy does not include any conditions, operations on that policy may
2876 # specify any valid version or leave the field unset.
2877 #
2878 # To learn which resources support conditions in their IAM policies, see the
2879 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2880 }</pre>
2881 </div>
2882
2883 <div class="method">
2884 <code class="details" id="getPacketMirroringRule">getPacketMirroringRule(firewallPolicy, priority=None, x__xgafv=None)</code>
2885 <pre>Gets a packet mirroring rule of the specified priority.
2886
2887 Args:
2888 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
2889 priority: integer, The priority of the rule to get from the firewall policy.
2890 x__xgafv: string, V1 error format.
2891 Allowed values
2892 1 - v1 error format
2893 2 - v2 error format
2894
2895 Returns:
2896 An object of the form:
2897
2898 { # Represents a rule that describes one or more match conditions along with
2899 # the action to be taken when traffic matches this condition (allow or deny).
2900 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
2901 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
2902 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
2903 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
2904 # and &quot;goto_next&quot;.
2905 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
2906 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
2907 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
2908 # the firewall policy rule is not enforced and traffic behaves as if it did
2909 # not exist. If this is unspecified, the firewall policy rule will be
2910 # enabled.
2911 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
2912 # enabled, logs will be exported to the configured export destination in
2913 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
2914 # cannot enable logging on &quot;goto_next&quot; rules.
2915 &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.
2916 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
2917 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
2918 # Exactly one field must be specified.
2919 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
2920 # Maximum number of destination address groups is 10.
2921 &quot;A String&quot;,
2922 ],
2923 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2924 # traffic destination.
2925 # Maximum number of destination fqdn allowed is 100.
2926 &quot;A String&quot;,
2927 ],
2928 &quot;destIpRanges&quot;: [ # CIDR IP address range.
2929 # Maximum number of destination CIDR IP ranges allowed is 5000.
2930 &quot;A String&quot;,
2931 ],
2932 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
2933 #
2934 #
2935 # - UNSPECIFIED
2936 # - INTERNET
2937 # - NON_INTERNET
2938 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
2939 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
2940 #
2941 #
2942 # - UNSPECIFIED
2943 # - INTERNET
2944 # - NON_INTERNET
2945 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
2946 # of traffic. Should be specified as 2 letter country code defined as per
2947 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2948 # Maximum number of dest region codes allowed is 5000.
2949 &quot;A String&quot;,
2950 ],
2951 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2952 # The IPs in these lists will be matched against traffic destination.
2953 &quot;A String&quot;,
2954 ],
2955 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
2956 {
2957 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
2958 # required when creating a firewall rule. This value can either be
2959 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
2960 # protocol number.
2961 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
2962 # only applicable for UDP or TCP protocol. Each entry must be either
2963 # an integer or a range. If not specified, this rule applies to
2964 # connections through any port.
2965 #
2966 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
2967 &quot;A String&quot;,
2968 ],
2969 },
2970 ],
2971 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
2972 # Maximum number of source address groups is 10.
2973 &quot;A String&quot;,
2974 ],
2975 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2976 # traffic source.
2977 # Maximum number of source fqdn allowed is 100.
2978 &quot;A String&quot;,
2979 ],
2980 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
2981 # Maximum number of source CIDR IP ranges allowed is 5000.
2982 &quot;A String&quot;,
2983 ],
2984 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
2985 #
2986 #
2987 # - UNSPECIFIED
2988 # - INTERNET
2989 # - INTRA_VPC
2990 # - NON_INTERNET
2991 # - VPC_NETWORKS
2992 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
2993 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
2994 #
2995 #
2996 # - UNSPECIFIED
2997 # - INTERNET
2998 # - INTRA_VPC
2999 # - NON_INTERNET
3000 # - VPC_NETWORKS
3001 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3002 &quot;A String&quot;,
3003 ],
3004 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3005 # of traffic. Should be specified as 2 letter country code defined as per
3006 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3007 # Maximum number of source region codes allowed is 5000.
3008 &quot;A String&quot;,
3009 ],
3010 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3011 # of the traffic.
3012 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3013 # and there is no srcIpRange, this rule will be ignored.
3014 # Maximum number of source tag values allowed is 256.
3015 {
3016 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3017 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3018 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3019 # or its network is deleted.
3020 },
3021 ],
3022 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3023 # The IPs in these lists will be matched against traffic source.
3024 &quot;A String&quot;,
3025 ],
3026 },
3027 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3028 # must be a positive value between 0 and 2147483647.
3029 # Rules are evaluated from highest to lowest priority where 0 is the
3030 # highest priority and 2147483647 is the lowest priority.
3031 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3032 # and can be updated.
3033 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3034 # rule.
3035 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3036 # Example:
3037 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3038 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3039 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3040 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3041 # This field allows you to control which load balancers get this rule.
3042 # For example, the following are valid values:
3043 #
3044 #
3045 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3046 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3047 # - projects/project/global/
3048 # forwardingRules/forwardingRule
3049 # - projects/project/regions/region/forwardingRules/
3050 # forwardingRule
3051 &quot;A String&quot;,
3052 ],
3053 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3054 # allows you to control which network&#x27;s VMs get this rule. If this field
3055 # is left blank, all VMs within the organization will receive the rule.
3056 &quot;A String&quot;,
3057 ],
3058 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3059 # applies to. If targetSecureTag are specified, then the
3060 # firewall rule applies only to instances in the VPC network that have one
3061 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3062 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3063 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3064 # to all instances on the specified network.
3065 # Maximum number of target label tags allowed is 256.
3066 {
3067 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3068 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3069 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3070 # or its network is deleted.
3071 },
3072 ],
3073 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3074 # applied with this rule.
3075 &quot;A String&quot;,
3076 ],
3077 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3078 # Default value is INSTANCES.
3079 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3080 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3081 # be set for other actions.
3082 }</pre>
3083 </div>
3084
3085 <div class="method">
3086 <code class="details" id="getRule">getRule(firewallPolicy, priority=None, x__xgafv=None)</code>
3087 <pre>Gets a rule of the specified priority.
3088
3089 Args:
3090 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
3091 priority: integer, The priority of the rule to get from the firewall policy.
3092 x__xgafv: string, V1 error format.
3093 Allowed values
3094 1 - v1 error format
3095 2 - v2 error format
3096
3097 Returns:
3098 An object of the form:
3099
3100 { # Represents a rule that describes one or more match conditions along with
3101 # the action to be taken when traffic matches this condition (allow or deny).
3102 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3103 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3104 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3105 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3106 # and &quot;goto_next&quot;.
3107 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3108 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3109 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3110 # the firewall policy rule is not enforced and traffic behaves as if it did
3111 # not exist. If this is unspecified, the firewall policy rule will be
3112 # enabled.
3113 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3114 # enabled, logs will be exported to the configured export destination in
3115 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3116 # cannot enable logging on &quot;goto_next&quot; rules.
3117 &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.
3118 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3119 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3120 # Exactly one field must be specified.
3121 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3122 # Maximum number of destination address groups is 10.
3123 &quot;A String&quot;,
3124 ],
3125 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3126 # traffic destination.
3127 # Maximum number of destination fqdn allowed is 100.
3128 &quot;A String&quot;,
3129 ],
3130 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3131 # Maximum number of destination CIDR IP ranges allowed is 5000.
3132 &quot;A String&quot;,
3133 ],
3134 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3135 #
3136 #
3137 # - UNSPECIFIED
3138 # - INTERNET
3139 # - NON_INTERNET
3140 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3141 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3142 #
3143 #
3144 # - UNSPECIFIED
3145 # - INTERNET
3146 # - NON_INTERNET
3147 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3148 # of traffic. Should be specified as 2 letter country code defined as per
3149 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3150 # Maximum number of dest region codes allowed is 5000.
3151 &quot;A String&quot;,
3152 ],
3153 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3154 # The IPs in these lists will be matched against traffic destination.
3155 &quot;A String&quot;,
3156 ],
3157 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3158 {
3159 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3160 # required when creating a firewall rule. This value can either be
3161 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3162 # protocol number.
3163 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3164 # only applicable for UDP or TCP protocol. Each entry must be either
3165 # an integer or a range. If not specified, this rule applies to
3166 # connections through any port.
3167 #
3168 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3169 &quot;A String&quot;,
3170 ],
3171 },
3172 ],
3173 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3174 # Maximum number of source address groups is 10.
3175 &quot;A String&quot;,
3176 ],
3177 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3178 # traffic source.
3179 # Maximum number of source fqdn allowed is 100.
3180 &quot;A String&quot;,
3181 ],
3182 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3183 # Maximum number of source CIDR IP ranges allowed is 5000.
3184 &quot;A String&quot;,
3185 ],
3186 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3187 #
3188 #
3189 # - UNSPECIFIED
3190 # - INTERNET
3191 # - INTRA_VPC
3192 # - NON_INTERNET
3193 # - VPC_NETWORKS
3194 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3195 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3196 #
3197 #
3198 # - UNSPECIFIED
3199 # - INTERNET
3200 # - INTRA_VPC
3201 # - NON_INTERNET
3202 # - VPC_NETWORKS
3203 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3204 &quot;A String&quot;,
3205 ],
3206 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3207 # of traffic. Should be specified as 2 letter country code defined as per
3208 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3209 # Maximum number of source region codes allowed is 5000.
3210 &quot;A String&quot;,
3211 ],
3212 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3213 # of the traffic.
3214 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3215 # and there is no srcIpRange, this rule will be ignored.
3216 # Maximum number of source tag values allowed is 256.
3217 {
3218 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3219 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3220 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3221 # or its network is deleted.
3222 },
3223 ],
3224 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3225 # The IPs in these lists will be matched against traffic source.
3226 &quot;A String&quot;,
3227 ],
3228 },
3229 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3230 # must be a positive value between 0 and 2147483647.
3231 # Rules are evaluated from highest to lowest priority where 0 is the
3232 # highest priority and 2147483647 is the lowest priority.
3233 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3234 # and can be updated.
3235 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3236 # rule.
3237 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3238 # Example:
3239 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3240 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3241 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3242 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3243 # This field allows you to control which load balancers get this rule.
3244 # For example, the following are valid values:
3245 #
3246 #
3247 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3248 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3249 # - projects/project/global/
3250 # forwardingRules/forwardingRule
3251 # - projects/project/regions/region/forwardingRules/
3252 # forwardingRule
3253 &quot;A String&quot;,
3254 ],
3255 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3256 # allows you to control which network&#x27;s VMs get this rule. If this field
3257 # is left blank, all VMs within the organization will receive the rule.
3258 &quot;A String&quot;,
3259 ],
3260 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3261 # applies to. If targetSecureTag are specified, then the
3262 # firewall rule applies only to instances in the VPC network that have one
3263 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3264 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3265 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3266 # to all instances on the specified network.
3267 # Maximum number of target label tags allowed is 256.
3268 {
3269 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3270 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3271 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3272 # or its network is deleted.
3273 },
3274 ],
3275 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3276 # applied with this rule.
3277 &quot;A String&quot;,
3278 ],
3279 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3280 # Default value is INSTANCES.
3281 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3282 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3283 # be set for other actions.
3284 }</pre>
3285 </div>
3286
3287 <div class="method">
3288 <code class="details" id="insert">insert(body=None, parentId=None, requestId=None, x__xgafv=None)</code>
3289 <pre>Creates a new policy in the specified project using the data included in
3290 the request.
3291
3292 Args:
3293 body: object, The request body.
3294 The object takes the form of:
3295
3296 { # Represents a Firewall Policy resource.
3297 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
3298 {
3299 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
3300 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
3301 # of the firewall policy of the association.
3302 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
3303 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
3304 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
3305 # must be a positive value between 1 and 2147483647.
3306 # Firewall Policies are evaluated from highest to lowest priority where 1
3307 # is the highest priority and 2147483647 is the lowest priority.
3308 # The default value is `1000`. If two associations have the same priority
3309 # then lexicographical order on association names is applied.
3310 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
3311 },
3312 ],
3313 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3314 # text format.
3315 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3316 # create the resource.
3317 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
3318 # Organization firewall policy. The name should be unique in the organization
3319 # in which the firewall policy is created.
3320 # This field is not applicable to network firewall policies.
3321 # This name must be set on creation and cannot be changed.
3322 # The name must be 1-63 characters long, and comply
3323 # with RFC1035. Specifically, the name must be 1-63 characters
3324 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
3325 # means the first character must be a lowercase letter, and all following
3326 # characters must be a dash, lowercase letter, or digit, except the last
3327 # character, which cannot be a dash.
3328 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
3329 # the metadata&#x27;s contents and used for optimistic locking. The
3330 # fingerprint is initially generated by Compute Engine and changes after
3331 # every request to modify or update metadata. You must always provide an
3332 # up-to-date fingerprint hash in order to update or change metadata,
3333 # otherwise the request will fail with error412 conditionNotMet.
3334 #
3335 # To see the latest fingerprint, make get() request to the
3336 # firewall policy.
3337 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
3338 # defined by the server.
3339 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
3340 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
3341 # [Output Only] numeric ID allocated by Google Cloud which uniquely
3342 # identifies the Organization Firewall Policy.
3343 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
3344 { # Represents a rule that describes one or more match conditions along with
3345 # the action to be taken when traffic matches this condition (allow or deny).
3346 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3347 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3348 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3349 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3350 # and &quot;goto_next&quot;.
3351 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3352 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3353 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3354 # the firewall policy rule is not enforced and traffic behaves as if it did
3355 # not exist. If this is unspecified, the firewall policy rule will be
3356 # enabled.
3357 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3358 # enabled, logs will be exported to the configured export destination in
3359 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3360 # cannot enable logging on &quot;goto_next&quot; rules.
3361 &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.
3362 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3363 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3364 # Exactly one field must be specified.
3365 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3366 # Maximum number of destination address groups is 10.
3367 &quot;A String&quot;,
3368 ],
3369 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3370 # traffic destination.
3371 # Maximum number of destination fqdn allowed is 100.
3372 &quot;A String&quot;,
3373 ],
3374 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3375 # Maximum number of destination CIDR IP ranges allowed is 5000.
3376 &quot;A String&quot;,
3377 ],
3378 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3379 #
3380 #
3381 # - UNSPECIFIED
3382 # - INTERNET
3383 # - NON_INTERNET
3384 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3385 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3386 #
3387 #
3388 # - UNSPECIFIED
3389 # - INTERNET
3390 # - NON_INTERNET
3391 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3392 # of traffic. Should be specified as 2 letter country code defined as per
3393 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3394 # Maximum number of dest region codes allowed is 5000.
3395 &quot;A String&quot;,
3396 ],
3397 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3398 # The IPs in these lists will be matched against traffic destination.
3399 &quot;A String&quot;,
3400 ],
3401 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3402 {
3403 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3404 # required when creating a firewall rule. This value can either be
3405 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3406 # protocol number.
3407 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3408 # only applicable for UDP or TCP protocol. Each entry must be either
3409 # an integer or a range. If not specified, this rule applies to
3410 # connections through any port.
3411 #
3412 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3413 &quot;A String&quot;,
3414 ],
3415 },
3416 ],
3417 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3418 # Maximum number of source address groups is 10.
3419 &quot;A String&quot;,
3420 ],
3421 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3422 # traffic source.
3423 # Maximum number of source fqdn allowed is 100.
3424 &quot;A String&quot;,
3425 ],
3426 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3427 # Maximum number of source CIDR IP ranges allowed is 5000.
3428 &quot;A String&quot;,
3429 ],
3430 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3431 #
3432 #
3433 # - UNSPECIFIED
3434 # - INTERNET
3435 # - INTRA_VPC
3436 # - NON_INTERNET
3437 # - VPC_NETWORKS
3438 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3439 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3440 #
3441 #
3442 # - UNSPECIFIED
3443 # - INTERNET
3444 # - INTRA_VPC
3445 # - NON_INTERNET
3446 # - VPC_NETWORKS
3447 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3448 &quot;A String&quot;,
3449 ],
3450 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3451 # of traffic. Should be specified as 2 letter country code defined as per
3452 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3453 # Maximum number of source region codes allowed is 5000.
3454 &quot;A String&quot;,
3455 ],
3456 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3457 # of the traffic.
3458 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3459 # and there is no srcIpRange, this rule will be ignored.
3460 # Maximum number of source tag values allowed is 256.
3461 {
3462 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3463 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3464 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3465 # or its network is deleted.
3466 },
3467 ],
3468 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3469 # The IPs in these lists will be matched against traffic source.
3470 &quot;A String&quot;,
3471 ],
3472 },
3473 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3474 # must be a positive value between 0 and 2147483647.
3475 # Rules are evaluated from highest to lowest priority where 0 is the
3476 # highest priority and 2147483647 is the lowest priority.
3477 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3478 # and can be updated.
3479 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3480 # rule.
3481 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3482 # Example:
3483 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3484 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3485 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3486 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3487 # This field allows you to control which load balancers get this rule.
3488 # For example, the following are valid values:
3489 #
3490 #
3491 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3492 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3493 # - projects/project/global/
3494 # forwardingRules/forwardingRule
3495 # - projects/project/regions/region/forwardingRules/
3496 # forwardingRule
3497 &quot;A String&quot;,
3498 ],
3499 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3500 # allows you to control which network&#x27;s VMs get this rule. If this field
3501 # is left blank, all VMs within the organization will receive the rule.
3502 &quot;A String&quot;,
3503 ],
3504 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3505 # applies to. If targetSecureTag are specified, then the
3506 # firewall rule applies only to instances in the VPC network that have one
3507 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3508 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3509 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3510 # to all instances on the specified network.
3511 # Maximum number of target label tags allowed is 256.
3512 {
3513 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3514 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3515 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3516 # or its network is deleted.
3517 },
3518 ],
3519 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3520 # applied with this rule.
3521 &quot;A String&quot;,
3522 ],
3523 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3524 # Default value is INSTANCES.
3525 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3526 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3527 # be set for other actions.
3528 },
3529 ],
3530 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
3531 # This field is not applicable to network firewall policies.
3532 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
3533 # creation and defaults to USER_DEFINED.
3534 #
3535 # The USER_DEFINED value indicates a regular firewall policy.
3536 #
3537 # The SYSTEM value indicates a system-level policy managed by an
3538 # internal service like GKE. This SYSTEM value is reserved for
3539 # internal services and cannot be set by users during policy creation.
3540 # Policies with a SYSTEM source cannot be modified or deleted by
3541 # users.
3542 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
3543 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
3544 #
3545 # Note: if not specified then VPC_POLICY will be used.
3546 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
3547 # This field is not applicable to global firewall policies.
3548 # You must specify this field as part of the HTTP request URL. It is
3549 # not settable as a field in the request body.
3550 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
3551 # policy can not exceed a set number of tuples.
3552 &quot;rules&quot;: [ # A list of rules that belong to this policy.
3553 # There must always be a default rule (rule with priority 2147483647 and
3554 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
3555 # default rule with action &quot;allow&quot; will be added.
3556 { # Represents a rule that describes one or more match conditions along with
3557 # the action to be taken when traffic matches this condition (allow or deny).
3558 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3559 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3560 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3561 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3562 # and &quot;goto_next&quot;.
3563 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3564 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3565 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3566 # the firewall policy rule is not enforced and traffic behaves as if it did
3567 # not exist. If this is unspecified, the firewall policy rule will be
3568 # enabled.
3569 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3570 # enabled, logs will be exported to the configured export destination in
3571 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3572 # cannot enable logging on &quot;goto_next&quot; rules.
3573 &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.
3574 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3575 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3576 # Exactly one field must be specified.
3577 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3578 # Maximum number of destination address groups is 10.
3579 &quot;A String&quot;,
3580 ],
3581 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3582 # traffic destination.
3583 # Maximum number of destination fqdn allowed is 100.
3584 &quot;A String&quot;,
3585 ],
3586 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3587 # Maximum number of destination CIDR IP ranges allowed is 5000.
3588 &quot;A String&quot;,
3589 ],
3590 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3591 #
3592 #
3593 # - UNSPECIFIED
3594 # - INTERNET
3595 # - NON_INTERNET
3596 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3597 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3598 #
3599 #
3600 # - UNSPECIFIED
3601 # - INTERNET
3602 # - NON_INTERNET
3603 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3604 # of traffic. Should be specified as 2 letter country code defined as per
3605 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3606 # Maximum number of dest region codes allowed is 5000.
3607 &quot;A String&quot;,
3608 ],
3609 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3610 # The IPs in these lists will be matched against traffic destination.
3611 &quot;A String&quot;,
3612 ],
3613 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3614 {
3615 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3616 # required when creating a firewall rule. This value can either be
3617 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3618 # protocol number.
3619 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3620 # only applicable for UDP or TCP protocol. Each entry must be either
3621 # an integer or a range. If not specified, this rule applies to
3622 # connections through any port.
3623 #
3624 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3625 &quot;A String&quot;,
3626 ],
3627 },
3628 ],
3629 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3630 # Maximum number of source address groups is 10.
3631 &quot;A String&quot;,
3632 ],
3633 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3634 # traffic source.
3635 # Maximum number of source fqdn allowed is 100.
3636 &quot;A String&quot;,
3637 ],
3638 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3639 # Maximum number of source CIDR IP ranges allowed is 5000.
3640 &quot;A String&quot;,
3641 ],
3642 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3643 #
3644 #
3645 # - UNSPECIFIED
3646 # - INTERNET
3647 # - INTRA_VPC
3648 # - NON_INTERNET
3649 # - VPC_NETWORKS
3650 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3651 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3652 #
3653 #
3654 # - UNSPECIFIED
3655 # - INTERNET
3656 # - INTRA_VPC
3657 # - NON_INTERNET
3658 # - VPC_NETWORKS
3659 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3660 &quot;A String&quot;,
3661 ],
3662 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3663 # of traffic. Should be specified as 2 letter country code defined as per
3664 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3665 # Maximum number of source region codes allowed is 5000.
3666 &quot;A String&quot;,
3667 ],
3668 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3669 # of the traffic.
3670 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3671 # and there is no srcIpRange, this rule will be ignored.
3672 # Maximum number of source tag values allowed is 256.
3673 {
3674 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3675 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3676 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3677 # or its network is deleted.
3678 },
3679 ],
3680 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3681 # The IPs in these lists will be matched against traffic source.
3682 &quot;A String&quot;,
3683 ],
3684 },
3685 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3686 # must be a positive value between 0 and 2147483647.
3687 # Rules are evaluated from highest to lowest priority where 0 is the
3688 # highest priority and 2147483647 is the lowest priority.
3689 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3690 # and can be updated.
3691 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3692 # rule.
3693 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3694 # Example:
3695 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3696 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3697 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3698 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3699 # This field allows you to control which load balancers get this rule.
3700 # For example, the following are valid values:
3701 #
3702 #
3703 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3704 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3705 # - projects/project/global/
3706 # forwardingRules/forwardingRule
3707 # - projects/project/regions/region/forwardingRules/
3708 # forwardingRule
3709 &quot;A String&quot;,
3710 ],
3711 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3712 # allows you to control which network&#x27;s VMs get this rule. If this field
3713 # is left blank, all VMs within the organization will receive the rule.
3714 &quot;A String&quot;,
3715 ],
3716 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3717 # applies to. If targetSecureTag are specified, then the
3718 # firewall rule applies only to instances in the VPC network that have one
3719 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3720 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3721 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3722 # to all instances on the specified network.
3723 # Maximum number of target label tags allowed is 256.
3724 {
3725 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3726 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3727 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3728 # or its network is deleted.
3729 },
3730 ],
3731 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3732 # applied with this rule.
3733 &quot;A String&quot;,
3734 ],
3735 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3736 # Default value is INSTANCES.
3737 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3738 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3739 # be set for other actions.
3740 },
3741 ],
3742 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3743 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3744 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
3745 # unique in the organization in which the firewall policy is created.
3746 # This field is not applicable to network firewall policies.
3747 # This name must be set on creation and cannot be changed. The name must be
3748 # 1-63 characters long, and comply with RFC1035.
3749 # Specifically, the name must be 1-63 characters long and match the regular
3750 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3751 # character must be a lowercase letter, and all following characters must
3752 # be a dash, lowercase letter, or digit, except the last character, which
3753 # cannot be a dash.
3754 }
3755
3756 parentId: string, Parent ID for this request. The ID can be either be &quot;folders/[FOLDER_ID]&quot;
3757 if the parent is a folder or &quot;organizations/[ORGANIZATION_ID]&quot; if the
3758 parent is an organization.
3759 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3760 that if you must retry your request, the server will know to ignore the
3761 request if it has already been completed.
3762
3763 For example, consider a situation where you make an initial request and
3764 the request times out. If you make the request again with the same
3765 request ID, the server can check if original operation with the same
3766 request ID was received, and if so, will ignore the second request. This
3767 prevents clients from accidentally creating duplicate commitments.
3768
3769 The request ID must be
3770 a valid UUID with the exception that zero UUID is not supported
3771 (00000000-0000-0000-0000-000000000000).
3772 x__xgafv: string, V1 error format.
3773 Allowed values
3774 1 - v1 error format
3775 2 - v2 error format
3776
3777 Returns:
3778 An object of the form:
3779
3780 { # Represents an Operation resource.
3781 #
3782 # Google Compute Engine has three Operation resources:
3783 #
3784 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
3785 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
3786 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
3787 #
3788 # You can use an operation resource to manage asynchronous API requests.
3789 # For more information, readHandling
3790 # API responses.
3791 #
3792 # Operations can be global, regional or zonal.
3793 #
3794 # - For global operations, use the `globalOperations`
3795 # resource.
3796 # - For regional operations, use the
3797 # `regionOperations` resource.
3798 # - For zonal operations, use
3799 # the `zoneOperations` resource.
3800 #
3801 #
3802 #
3803 # For more information, read
3804 # Global, Regional, and Zonal Resources.
3805 #
3806 # Note that completed Operation resources have a limited
3807 # retention period.
3808 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3809 # Not present otherwise.
3810 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3811 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3812 # set when the operation is created.
3813 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3814 # text format.
3815 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3816 # this field will be populated.
3817 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3818 # operation.
3819 {
3820 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3821 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3822 # details. There is a set of defined message types to use for providing
3823 # details.The syntax depends on the error code. For example,
3824 # QuotaExceededInfo will have details when the error code is
3825 # QUOTA_EXCEEDED.
3826 {
3827 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3828 #
3829 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3830 # is not enabled:
3831 #
3832 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3833 # &quot;domain&quot;: &quot;googleapis.com&quot;
3834 # &quot;metadata&quot;: {
3835 # &quot;resource&quot;: &quot;projects/123&quot;,
3836 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3837 # }
3838 # }
3839 #
3840 # This response indicates that the pubsub.googleapis.com API is not enabled.
3841 #
3842 # Example of an error that is returned when attempting to create a Spanner
3843 # instance in a region that is out of stock:
3844 #
3845 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3846 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3847 # &quot;metadata&quot;: {
3848 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3849 # }
3850 # }
3851 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3852 # is typically the registered service name of the tool or product that
3853 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3854 # generated by some common infrastructure, the error domain must be a
3855 # globally unique value that identifies the infrastructure. For Google API
3856 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3857 &quot;metadatas&quot;: { # Additional structured details about this error.
3858 #
3859 # Keys must match a regular expression of `a-z+` but should
3860 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3861 # length. When identifying the current value of an exceeded limit, the units
3862 # should be contained in the key, not the value. For example, rather than
3863 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3864 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3865 # instances that can be created in a single (batch) request.
3866 &quot;a_key&quot;: &quot;A String&quot;,
3867 },
3868 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3869 # proximate cause of the error. Error reasons are unique within a particular
3870 # domain of errors. This should be at most 63 characters and match a
3871 # regular expression of `A-Z+[A-Z0-9]`, which represents
3872 # UPPER_SNAKE_CASE.
3873 },
3874 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3875 #
3876 # For example, if a quota check failed with an error indicating the calling
3877 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3878 # directly to the right place in the developer console to flip the bit.
3879 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3880 { # Describes a URL link.
3881 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3882 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3883 },
3884 ],
3885 },
3886 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3887 # which can be attached to an RPC error.
3888 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3889 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3890 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3891 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3892 },
3893 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3894 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3895 &quot;a_key&quot;: &quot;A String&quot;,
3896 },
3897 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3898 # type or metric.
3899 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3900 # or metric.
3901 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3902 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3903 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3904 },
3905 },
3906 ],
3907 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3908 # This property is optional.
3909 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3910 },
3911 ],
3912 },
3913 &quot;getVersionOperationMetadata&quot;: {
3914 &quot;inlineSbomInfo&quot;: {
3915 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3916 # appropriate identifiers.
3917 &quot;a_key&quot;: &quot;A String&quot;,
3918 },
3919 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3920 # identifiers.
3921 &quot;a_key&quot;: &quot;A String&quot;,
3922 },
3923 },
3924 },
3925 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3926 # message that was returned, such as `NOT FOUND`.
3927 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3928 # status code that was returned. For example, a `404` means the
3929 # resource was not found.
3930 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3931 # defined by the server.
3932 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3933 # This value is inRFC3339
3934 # text format.
3935 &quot;instancesBulkInsertOperationMetadata&quot;: {
3936 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3937 # Example key: zones/us-central1-a
3938 &quot;a_key&quot;: {
3939 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3940 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3941 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3942 # error.
3943 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3944 # if the flow is rolling forward or rolling back.
3945 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3946 },
3947 },
3948 },
3949 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3950 # Operation resources.
3951 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3952 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3953 # group of operations results from a `bulkInsert` API request.
3954 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3955 # `update`, or `delete`, and so on.
3956 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3957 # There is no requirement that this be linear or support any granularity of
3958 # operations. This should not be used to guess when the operation will be
3959 # complete. This number should monotonically increase as the operation
3960 # progresses.
3961 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3962 # applicable when performing regional operations.
3963 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3964 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3965 # this field will contain information on all underlying zonal actions and
3966 # their state.
3967 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3968 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3969 # Example key: zones/us-central1-a
3970 &quot;a_key&quot;: {
3971 &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
3972 # populated.
3973 # different programming environments, including REST APIs and RPC APIs. It is
3974 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3975 # three pieces of data: error code, error message, and error details.
3976 #
3977 # You can find out more about this error model and how to work with it in the
3978 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3979 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3980 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3981 # message types for APIs to use.
3982 {
3983 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3984 },
3985 ],
3986 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3987 # user-facing error message should be localized and sent in the
3988 # google.rpc.Status.details field, or localized by the client.
3989 },
3990 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3991 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3992 },
3993 },
3994 },
3995 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3996 # This value is inRFC3339
3997 # text format.
3998 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3999 # following:
4000 # `PENDING`, `RUNNING`, or `DONE`.
4001 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4002 # operation.
4003 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4004 # of the target resource.
4005 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4006 # operations related to creating a snapshot, this points to the disk
4007 # that the snapshot was created from.
4008 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4009 # `[email protected]` or
4010 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4011 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4012 # operation, this field will be populated.
4013 {
4014 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4015 # Engine returns NO_RESULTS_ON_PAGE if there
4016 # are no results in the response.
4017 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4018 # value format. For example:
4019 #
4020 # &quot;data&quot;: [
4021 # {
4022 # &quot;key&quot;: &quot;scope&quot;,
4023 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4024 # }
4025 {
4026 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4027 # returned. For example, for warnings where there are no results in a list
4028 # request for a particular zone, this key might be scope and
4029 # the key value might be the zone name. Other examples might be a key
4030 # indicating a deprecated resource and a suggested replacement, or a
4031 # warning about invalid network settings (for example, if an instance
4032 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4033 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4034 },
4035 ],
4036 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4037 },
4038 ],
4039 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4040 # applicable when performing per-zone operations.
4041 }</pre>
4042 </div>
4043
4044 <div class="method">
4045 <code class="details" id="list">list(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)</code>
4046 <pre>Lists all the policies that have been configured for the specified
4047 folder or organization.
4048
4049 Args:
4050 filter: string, A filter expression that filters resources listed in the response. Most
4051 Compute resources support two types of filter expressions:
4052 expressions that support regular expressions and expressions that follow
4053 API improvement proposal AIP-160.
4054 These two types of filter expressions cannot be mixed in one request.
4055
4056 If you want to use AIP-160, your expression must specify the field name, an
4057 operator, and the value that you want to use for filtering. The value
4058 must be a string, a number, or a boolean. The operator
4059 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4060
4061 For example, if you are filtering Compute Engine instances, you can
4062 exclude instances named `example-instance` by specifying
4063 `name != example-instance`.
4064
4065 The `:*` comparison can be used to test whether a key has been defined.
4066 For example, to find all objects with `owner` label use:
4067 ```
4068 labels.owner:*
4069 ```
4070
4071 You can also filter nested fields. For example, you could specify
4072 `scheduling.automaticRestart = false` to include instances only
4073 if they are not scheduled for automatic restarts. You can use filtering
4074 on nested fields to filter based onresource labels.
4075
4076 To filter on multiple expressions, provide each separate expression within
4077 parentheses. For example:
4078 ```
4079 (scheduling.automaticRestart = true)
4080 (cpuPlatform = &quot;Intel Skylake&quot;)
4081 ```
4082 By default, each expression is an `AND` expression. However, you
4083 can include `AND` and `OR` expressions explicitly.
4084 For example:
4085 ```
4086 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4087 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4088 (scheduling.automaticRestart = true)
4089 ```
4090
4091 If you want to use a regular expression, use the `eq` (equal) or `ne`
4092 (not equal) operator against a single un-parenthesized expression with or
4093 without quotes or against multiple parenthesized expressions. Examples:
4094
4095 `fieldname eq unquoted literal`
4096 `fieldname eq &#x27;single quoted literal&#x27;`
4097 `fieldname eq &quot;double quoted literal&quot;`
4098 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4099
4100 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4101 The literal value must match the entire field.
4102
4103 For example, to filter for instances that do not end with name &quot;instance&quot;,
4104 you would use `name ne .*instance`.
4105
4106 You cannot combine constraints on multiple fields using regular
4107 expressions.
4108 maxResults: integer, The maximum number of results per page that should be returned.
4109 If the number of available results is larger than `maxResults`,
4110 Compute Engine returns a `nextPageToken` that can be used to get
4111 the next page of results in subsequent list requests. Acceptable values are
4112 `0` to `500`, inclusive. (Default: `500`)
4113 orderBy: string, Sorts list results by a certain order. By default, results
4114 are returned in alphanumerical order based on the resource name.
4115
4116 You can also sort results in descending order based on the creation
4117 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4118 results based on the `creationTimestamp` field in
4119 reverse chronological order (newest result first). Use this to sort
4120 resources like operations so that the newest operation is returned first.
4121
4122 Currently, only sorting by `name` or
4123 `creationTimestamp desc` is supported.
4124 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4125 `nextPageToken` returned by a previous list request to get
4126 the next page of results.
4127 parentId: string, Parent ID for this request. The ID can be either be &quot;folders/[FOLDER_ID]&quot;
4128 if the parent is a folder or &quot;organizations/[ORGANIZATION_ID]&quot; if the
4129 parent is an organization.
4130 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4131 of failure. The default value is false.
4132
4133 For example, when partial success behavior is enabled, aggregatedList for a
4134 single zone scope either returns all resources in the zone or no resources,
4135 with an error code.
4136 x__xgafv: string, V1 error format.
4137 Allowed values
4138 1 - v1 error format
4139 2 - v2 error format
4140
4141 Returns:
4142 An object of the form:
4143
4144 {
4145 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4146 &quot;items&quot;: [ # A list of FirewallPolicy resources.
4147 { # Represents a Firewall Policy resource.
4148 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
4149 {
4150 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
4151 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
4152 # of the firewall policy of the association.
4153 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
4154 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
4155 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
4156 # must be a positive value between 1 and 2147483647.
4157 # Firewall Policies are evaluated from highest to lowest priority where 1
4158 # is the highest priority and 2147483647 is the lowest priority.
4159 # The default value is `1000`. If two associations have the same priority
4160 # then lexicographical order on association names is applied.
4161 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
4162 },
4163 ],
4164 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4165 # text format.
4166 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4167 # create the resource.
4168 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
4169 # Organization firewall policy. The name should be unique in the organization
4170 # in which the firewall policy is created.
4171 # This field is not applicable to network firewall policies.
4172 # This name must be set on creation and cannot be changed.
4173 # The name must be 1-63 characters long, and comply
4174 # with RFC1035. Specifically, the name must be 1-63 characters
4175 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
4176 # means the first character must be a lowercase letter, and all following
4177 # characters must be a dash, lowercase letter, or digit, except the last
4178 # character, which cannot be a dash.
4179 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
4180 # the metadata&#x27;s contents and used for optimistic locking. The
4181 # fingerprint is initially generated by Compute Engine and changes after
4182 # every request to modify or update metadata. You must always provide an
4183 # up-to-date fingerprint hash in order to update or change metadata,
4184 # otherwise the request will fail with error412 conditionNotMet.
4185 #
4186 # To see the latest fingerprint, make get() request to the
4187 # firewall policy.
4188 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4189 # defined by the server.
4190 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
4191 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
4192 # [Output Only] numeric ID allocated by Google Cloud which uniquely
4193 # identifies the Organization Firewall Policy.
4194 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
4195 { # Represents a rule that describes one or more match conditions along with
4196 # the action to be taken when traffic matches this condition (allow or deny).
4197 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
4198 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
4199 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
4200 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
4201 # and &quot;goto_next&quot;.
4202 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
4203 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
4204 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
4205 # the firewall policy rule is not enforced and traffic behaves as if it did
4206 # not exist. If this is unspecified, the firewall policy rule will be
4207 # enabled.
4208 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4209 # enabled, logs will be exported to the configured export destination in
4210 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4211 # cannot enable logging on &quot;goto_next&quot; rules.
4212 &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.
4213 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4214 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4215 # Exactly one field must be specified.
4216 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
4217 # Maximum number of destination address groups is 10.
4218 &quot;A String&quot;,
4219 ],
4220 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4221 # traffic destination.
4222 # Maximum number of destination fqdn allowed is 100.
4223 &quot;A String&quot;,
4224 ],
4225 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4226 # Maximum number of destination CIDR IP ranges allowed is 5000.
4227 &quot;A String&quot;,
4228 ],
4229 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
4230 #
4231 #
4232 # - UNSPECIFIED
4233 # - INTERNET
4234 # - NON_INTERNET
4235 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
4236 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
4237 #
4238 #
4239 # - UNSPECIFIED
4240 # - INTERNET
4241 # - NON_INTERNET
4242 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
4243 # of traffic. Should be specified as 2 letter country code defined as per
4244 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4245 # Maximum number of dest region codes allowed is 5000.
4246 &quot;A String&quot;,
4247 ],
4248 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4249 # The IPs in these lists will be matched against traffic destination.
4250 &quot;A String&quot;,
4251 ],
4252 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4253 {
4254 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4255 # required when creating a firewall rule. This value can either be
4256 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4257 # protocol number.
4258 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4259 # only applicable for UDP or TCP protocol. Each entry must be either
4260 # an integer or a range. If not specified, this rule applies to
4261 # connections through any port.
4262 #
4263 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4264 &quot;A String&quot;,
4265 ],
4266 },
4267 ],
4268 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4269 # Maximum number of source address groups is 10.
4270 &quot;A String&quot;,
4271 ],
4272 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4273 # traffic source.
4274 # Maximum number of source fqdn allowed is 100.
4275 &quot;A String&quot;,
4276 ],
4277 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4278 # Maximum number of source CIDR IP ranges allowed is 5000.
4279 &quot;A String&quot;,
4280 ],
4281 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4282 #
4283 #
4284 # - UNSPECIFIED
4285 # - INTERNET
4286 # - INTRA_VPC
4287 # - NON_INTERNET
4288 # - VPC_NETWORKS
4289 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4290 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4291 #
4292 #
4293 # - UNSPECIFIED
4294 # - INTERNET
4295 # - INTRA_VPC
4296 # - NON_INTERNET
4297 # - VPC_NETWORKS
4298 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4299 &quot;A String&quot;,
4300 ],
4301 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4302 # of traffic. Should be specified as 2 letter country code defined as per
4303 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4304 # Maximum number of source region codes allowed is 5000.
4305 &quot;A String&quot;,
4306 ],
4307 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4308 # of the traffic.
4309 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4310 # and there is no srcIpRange, this rule will be ignored.
4311 # Maximum number of source tag values allowed is 256.
4312 {
4313 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4314 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4315 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4316 # or its network is deleted.
4317 },
4318 ],
4319 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4320 # The IPs in these lists will be matched against traffic source.
4321 &quot;A String&quot;,
4322 ],
4323 },
4324 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4325 # must be a positive value between 0 and 2147483647.
4326 # Rules are evaluated from highest to lowest priority where 0 is the
4327 # highest priority and 2147483647 is the lowest priority.
4328 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4329 # and can be updated.
4330 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4331 # rule.
4332 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4333 # Example:
4334 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4335 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4336 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4337 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4338 # This field allows you to control which load balancers get this rule.
4339 # For example, the following are valid values:
4340 #
4341 #
4342 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4343 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4344 # - projects/project/global/
4345 # forwardingRules/forwardingRule
4346 # - projects/project/regions/region/forwardingRules/
4347 # forwardingRule
4348 &quot;A String&quot;,
4349 ],
4350 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4351 # allows you to control which network&#x27;s VMs get this rule. If this field
4352 # is left blank, all VMs within the organization will receive the rule.
4353 &quot;A String&quot;,
4354 ],
4355 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4356 # applies to. If targetSecureTag are specified, then the
4357 # firewall rule applies only to instances in the VPC network that have one
4358 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4359 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
4360 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
4361 # to all instances on the specified network.
4362 # Maximum number of target label tags allowed is 256.
4363 {
4364 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4365 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4366 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4367 # or its network is deleted.
4368 },
4369 ],
4370 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4371 # applied with this rule.
4372 &quot;A String&quot;,
4373 ],
4374 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
4375 # Default value is INSTANCES.
4376 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
4377 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
4378 # be set for other actions.
4379 },
4380 ],
4381 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
4382 # This field is not applicable to network firewall policies.
4383 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
4384 # creation and defaults to USER_DEFINED.
4385 #
4386 # The USER_DEFINED value indicates a regular firewall policy.
4387 #
4388 # The SYSTEM value indicates a system-level policy managed by an
4389 # internal service like GKE. This SYSTEM value is reserved for
4390 # internal services and cannot be set by users during policy creation.
4391 # Policies with a SYSTEM source cannot be modified or deleted by
4392 # users.
4393 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
4394 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
4395 #
4396 # Note: if not specified then VPC_POLICY will be used.
4397 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
4398 # This field is not applicable to global firewall policies.
4399 # You must specify this field as part of the HTTP request URL. It is
4400 # not settable as a field in the request body.
4401 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
4402 # policy can not exceed a set number of tuples.
4403 &quot;rules&quot;: [ # A list of rules that belong to this policy.
4404 # There must always be a default rule (rule with priority 2147483647 and
4405 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
4406 # default rule with action &quot;allow&quot; will be added.
4407 { # Represents a rule that describes one or more match conditions along with
4408 # the action to be taken when traffic matches this condition (allow or deny).
4409 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
4410 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
4411 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
4412 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
4413 # and &quot;goto_next&quot;.
4414 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
4415 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
4416 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
4417 # the firewall policy rule is not enforced and traffic behaves as if it did
4418 # not exist. If this is unspecified, the firewall policy rule will be
4419 # enabled.
4420 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4421 # enabled, logs will be exported to the configured export destination in
4422 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4423 # cannot enable logging on &quot;goto_next&quot; rules.
4424 &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.
4425 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4426 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4427 # Exactly one field must be specified.
4428 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
4429 # Maximum number of destination address groups is 10.
4430 &quot;A String&quot;,
4431 ],
4432 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4433 # traffic destination.
4434 # Maximum number of destination fqdn allowed is 100.
4435 &quot;A String&quot;,
4436 ],
4437 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4438 # Maximum number of destination CIDR IP ranges allowed is 5000.
4439 &quot;A String&quot;,
4440 ],
4441 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
4442 #
4443 #
4444 # - UNSPECIFIED
4445 # - INTERNET
4446 # - NON_INTERNET
4447 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
4448 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
4449 #
4450 #
4451 # - UNSPECIFIED
4452 # - INTERNET
4453 # - NON_INTERNET
4454 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
4455 # of traffic. Should be specified as 2 letter country code defined as per
4456 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4457 # Maximum number of dest region codes allowed is 5000.
4458 &quot;A String&quot;,
4459 ],
4460 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4461 # The IPs in these lists will be matched against traffic destination.
4462 &quot;A String&quot;,
4463 ],
4464 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4465 {
4466 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4467 # required when creating a firewall rule. This value can either be
4468 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4469 # protocol number.
4470 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4471 # only applicable for UDP or TCP protocol. Each entry must be either
4472 # an integer or a range. If not specified, this rule applies to
4473 # connections through any port.
4474 #
4475 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4476 &quot;A String&quot;,
4477 ],
4478 },
4479 ],
4480 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4481 # Maximum number of source address groups is 10.
4482 &quot;A String&quot;,
4483 ],
4484 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4485 # traffic source.
4486 # Maximum number of source fqdn allowed is 100.
4487 &quot;A String&quot;,
4488 ],
4489 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4490 # Maximum number of source CIDR IP ranges allowed is 5000.
4491 &quot;A String&quot;,
4492 ],
4493 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4494 #
4495 #
4496 # - UNSPECIFIED
4497 # - INTERNET
4498 # - INTRA_VPC
4499 # - NON_INTERNET
4500 # - VPC_NETWORKS
4501 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4502 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4503 #
4504 #
4505 # - UNSPECIFIED
4506 # - INTERNET
4507 # - INTRA_VPC
4508 # - NON_INTERNET
4509 # - VPC_NETWORKS
4510 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4511 &quot;A String&quot;,
4512 ],
4513 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4514 # of traffic. Should be specified as 2 letter country code defined as per
4515 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4516 # Maximum number of source region codes allowed is 5000.
4517 &quot;A String&quot;,
4518 ],
4519 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4520 # of the traffic.
4521 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4522 # and there is no srcIpRange, this rule will be ignored.
4523 # Maximum number of source tag values allowed is 256.
4524 {
4525 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4526 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4527 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4528 # or its network is deleted.
4529 },
4530 ],
4531 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4532 # The IPs in these lists will be matched against traffic source.
4533 &quot;A String&quot;,
4534 ],
4535 },
4536 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4537 # must be a positive value between 0 and 2147483647.
4538 # Rules are evaluated from highest to lowest priority where 0 is the
4539 # highest priority and 2147483647 is the lowest priority.
4540 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4541 # and can be updated.
4542 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4543 # rule.
4544 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4545 # Example:
4546 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4547 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4548 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4549 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4550 # This field allows you to control which load balancers get this rule.
4551 # For example, the following are valid values:
4552 #
4553 #
4554 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4555 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4556 # - projects/project/global/
4557 # forwardingRules/forwardingRule
4558 # - projects/project/regions/region/forwardingRules/
4559 # forwardingRule
4560 &quot;A String&quot;,
4561 ],
4562 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4563 # allows you to control which network&#x27;s VMs get this rule. If this field
4564 # is left blank, all VMs within the organization will receive the rule.
4565 &quot;A String&quot;,
4566 ],
4567 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4568 # applies to. If targetSecureTag are specified, then the
4569 # firewall rule applies only to instances in the VPC network that have one
4570 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4571 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
4572 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
4573 # to all instances on the specified network.
4574 # Maximum number of target label tags allowed is 256.
4575 {
4576 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4577 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4578 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4579 # or its network is deleted.
4580 },
4581 ],
4582 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4583 # applied with this rule.
4584 &quot;A String&quot;,
4585 ],
4586 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
4587 # Default value is INSTANCES.
4588 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
4589 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
4590 # be set for other actions.
4591 },
4592 ],
4593 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4594 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4595 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
4596 # unique in the organization in which the firewall policy is created.
4597 # This field is not applicable to network firewall policies.
4598 # This name must be set on creation and cannot be changed. The name must be
4599 # 1-63 characters long, and comply with RFC1035.
4600 # Specifically, the name must be 1-63 characters long and match the regular
4601 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4602 # character must be a lowercase letter, and all following characters must
4603 # be a dash, lowercase letter, or digit, except the last character, which
4604 # cannot be a dash.
4605 },
4606 ],
4607 &quot;kind&quot;: &quot;compute#firewallPolicyList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#firewallPolicyList for listsof FirewallPolicies
4608 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
4609 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
4610 # the query parameter pageToken in the next list request.
4611 # Subsequent list requests will have their own nextPageToken to
4612 # continue paging through the results.
4613 &quot;warning&quot;: { # [Output Only] Informational warning message.
4614 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4615 # Engine returns NO_RESULTS_ON_PAGE if there
4616 # are no results in the response.
4617 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4618 # value format. For example:
4619 #
4620 # &quot;data&quot;: [
4621 # {
4622 # &quot;key&quot;: &quot;scope&quot;,
4623 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4624 # }
4625 {
4626 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4627 # returned. For example, for warnings where there are no results in a list
4628 # request for a particular zone, this key might be scope and
4629 # the key value might be the zone name. Other examples might be a key
4630 # indicating a deprecated resource and a suggested replacement, or a
4631 # warning about invalid network settings (for example, if an instance
4632 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4633 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4634 },
4635 ],
4636 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4637 },
4638 }</pre>
4639 </div>
4640
4641 <div class="method">
4642 <code class="details" id="listAssociations">listAssociations(includeInheritedPolicies=None, targetResource=None, x__xgafv=None)</code>
4643 <pre>Lists associations of a specified target, i.e., organization or folder.
4644
4645 Args:
4646 includeInheritedPolicies: boolean, If set to &quot;true&quot;, the response will contain a list of all associations for
4647 the containing folders and the containing organization of the target. The
4648 parameter has no effect if the target is an organization.
4649 targetResource: string, The target resource to list associations. It is an organization, or a
4650 folder.
4651 x__xgafv: string, V1 error format.
4652 Allowed values
4653 1 - v1 error format
4654 2 - v2 error format
4655
4656 Returns:
4657 An object of the form:
4658
4659 {
4660 &quot;associations&quot;: [ # A list of associations.
4661 {
4662 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
4663 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
4664 # of the firewall policy of the association.
4665 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
4666 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
4667 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
4668 # must be a positive value between 1 and 2147483647.
4669 # Firewall Policies are evaluated from highest to lowest priority where 1
4670 # is the highest priority and 2147483647 is the lowest priority.
4671 # The default value is `1000`. If two associations have the same priority
4672 # then lexicographical order on association names is applied.
4673 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
4674 },
4675 ],
4676 &quot;kind&quot;: &quot;compute#firewallPoliciesListAssociationsResponse&quot;, # Output only. [Output Only] Type of firewallPolicy associations. Alwayscompute#FirewallPoliciesListAssociations for lists of
4677 # firewallPolicy associations.
4678 }</pre>
4679 </div>
4680
4681 <div class="method">
4682 <code class="details" id="list_next">list_next()</code>
4683 <pre>Retrieves the next page of results.
4684
4685 Args:
4686 previous_request: The request for the previous page. (required)
4687 previous_response: The response from the request for the previous page. (required)
4688
4689 Returns:
4690 A request object that you can call &#x27;execute()&#x27; on to request the next
4691 page. Returns None if there are no more items in the collection.
4692 </pre>
4693 </div>
4694
4695 <div class="method">
4696 <code class="details" id="move">move(firewallPolicy, parentId=None, requestId=None, x__xgafv=None)</code>
4697 <pre>Moves the specified firewall policy.
4698
4699 Args:
4700 firewallPolicy: string, Name of the firewall policy to update. (required)
4701 parentId: string, The new parent of the firewall policy. The ID can be either be
4702 &quot;folders/[FOLDER_ID]&quot; if the parent is a folder or
4703 &quot;organizations/[ORGANIZATION_ID]&quot; if the parent is an organization.
4704 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4705 that if you must retry your request, the server will know to ignore the
4706 request if it has already been completed.
4707
4708 For example, consider a situation where you make an initial request and
4709 the request times out. If you make the request again with the same
4710 request ID, the server can check if original operation with the same
4711 request ID was received, and if so, will ignore the second request. This
4712 prevents clients from accidentally creating duplicate commitments.
4713
4714 The request ID must be
4715 a valid UUID with the exception that zero UUID is not supported
4716 (00000000-0000-0000-0000-000000000000).
4717 x__xgafv: string, V1 error format.
4718 Allowed values
4719 1 - v1 error format
4720 2 - v2 error format
4721
4722 Returns:
4723 An object of the form:
4724
4725 { # Represents an Operation resource.
4726 #
4727 # Google Compute Engine has three Operation resources:
4728 #
4729 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
4730 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
4731 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
4732 #
4733 # You can use an operation resource to manage asynchronous API requests.
4734 # For more information, readHandling
4735 # API responses.
4736 #
4737 # Operations can be global, regional or zonal.
4738 #
4739 # - For global operations, use the `globalOperations`
4740 # resource.
4741 # - For regional operations, use the
4742 # `regionOperations` resource.
4743 # - For zonal operations, use
4744 # the `zoneOperations` resource.
4745 #
4746 #
4747 #
4748 # For more information, read
4749 # Global, Regional, and Zonal Resources.
4750 #
4751 # Note that completed Operation resources have a limited
4752 # retention period.
4753 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4754 # Not present otherwise.
4755 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4756 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4757 # set when the operation is created.
4758 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4759 # text format.
4760 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4761 # this field will be populated.
4762 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4763 # operation.
4764 {
4765 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4766 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4767 # details. There is a set of defined message types to use for providing
4768 # details.The syntax depends on the error code. For example,
4769 # QuotaExceededInfo will have details when the error code is
4770 # QUOTA_EXCEEDED.
4771 {
4772 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4773 #
4774 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4775 # is not enabled:
4776 #
4777 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4778 # &quot;domain&quot;: &quot;googleapis.com&quot;
4779 # &quot;metadata&quot;: {
4780 # &quot;resource&quot;: &quot;projects/123&quot;,
4781 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4782 # }
4783 # }
4784 #
4785 # This response indicates that the pubsub.googleapis.com API is not enabled.
4786 #
4787 # Example of an error that is returned when attempting to create a Spanner
4788 # instance in a region that is out of stock:
4789 #
4790 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4791 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4792 # &quot;metadata&quot;: {
4793 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4794 # }
4795 # }
4796 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4797 # is typically the registered service name of the tool or product that
4798 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4799 # generated by some common infrastructure, the error domain must be a
4800 # globally unique value that identifies the infrastructure. For Google API
4801 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4802 &quot;metadatas&quot;: { # Additional structured details about this error.
4803 #
4804 # Keys must match a regular expression of `a-z+` but should
4805 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4806 # length. When identifying the current value of an exceeded limit, the units
4807 # should be contained in the key, not the value. For example, rather than
4808 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4809 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4810 # instances that can be created in a single (batch) request.
4811 &quot;a_key&quot;: &quot;A String&quot;,
4812 },
4813 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4814 # proximate cause of the error. Error reasons are unique within a particular
4815 # domain of errors. This should be at most 63 characters and match a
4816 # regular expression of `A-Z+[A-Z0-9]`, which represents
4817 # UPPER_SNAKE_CASE.
4818 },
4819 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4820 #
4821 # For example, if a quota check failed with an error indicating the calling
4822 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4823 # directly to the right place in the developer console to flip the bit.
4824 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4825 { # Describes a URL link.
4826 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4827 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4828 },
4829 ],
4830 },
4831 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4832 # which can be attached to an RPC error.
4833 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4834 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4835 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4836 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4837 },
4838 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4839 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4840 &quot;a_key&quot;: &quot;A String&quot;,
4841 },
4842 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4843 # type or metric.
4844 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4845 # or metric.
4846 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4847 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4848 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4849 },
4850 },
4851 ],
4852 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4853 # This property is optional.
4854 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4855 },
4856 ],
4857 },
4858 &quot;getVersionOperationMetadata&quot;: {
4859 &quot;inlineSbomInfo&quot;: {
4860 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4861 # appropriate identifiers.
4862 &quot;a_key&quot;: &quot;A String&quot;,
4863 },
4864 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4865 # identifiers.
4866 &quot;a_key&quot;: &quot;A String&quot;,
4867 },
4868 },
4869 },
4870 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4871 # message that was returned, such as `NOT FOUND`.
4872 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4873 # status code that was returned. For example, a `404` means the
4874 # resource was not found.
4875 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4876 # defined by the server.
4877 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4878 # This value is inRFC3339
4879 # text format.
4880 &quot;instancesBulkInsertOperationMetadata&quot;: {
4881 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4882 # Example key: zones/us-central1-a
4883 &quot;a_key&quot;: {
4884 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4885 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4886 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4887 # error.
4888 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4889 # if the flow is rolling forward or rolling back.
4890 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4891 },
4892 },
4893 },
4894 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4895 # Operation resources.
4896 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4897 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4898 # group of operations results from a `bulkInsert` API request.
4899 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4900 # `update`, or `delete`, and so on.
4901 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4902 # There is no requirement that this be linear or support any granularity of
4903 # operations. This should not be used to guess when the operation will be
4904 # complete. This number should monotonically increase as the operation
4905 # progresses.
4906 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4907 # applicable when performing regional operations.
4908 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4909 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4910 # this field will contain information on all underlying zonal actions and
4911 # their state.
4912 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4913 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4914 # Example key: zones/us-central1-a
4915 &quot;a_key&quot;: {
4916 &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
4917 # populated.
4918 # different programming environments, including REST APIs and RPC APIs. It is
4919 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4920 # three pieces of data: error code, error message, and error details.
4921 #
4922 # You can find out more about this error model and how to work with it in the
4923 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4924 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4925 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4926 # message types for APIs to use.
4927 {
4928 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4929 },
4930 ],
4931 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4932 # user-facing error message should be localized and sent in the
4933 # google.rpc.Status.details field, or localized by the client.
4934 },
4935 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4936 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4937 },
4938 },
4939 },
4940 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4941 # This value is inRFC3339
4942 # text format.
4943 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4944 # following:
4945 # `PENDING`, `RUNNING`, or `DONE`.
4946 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4947 # operation.
4948 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4949 # of the target resource.
4950 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4951 # operations related to creating a snapshot, this points to the disk
4952 # that the snapshot was created from.
4953 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4954 # `[email protected]` or
4955 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4956 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4957 # operation, this field will be populated.
4958 {
4959 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4960 # Engine returns NO_RESULTS_ON_PAGE if there
4961 # are no results in the response.
4962 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4963 # value format. For example:
4964 #
4965 # &quot;data&quot;: [
4966 # {
4967 # &quot;key&quot;: &quot;scope&quot;,
4968 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4969 # }
4970 {
4971 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4972 # returned. For example, for warnings where there are no results in a list
4973 # request for a particular zone, this key might be scope and
4974 # the key value might be the zone name. Other examples might be a key
4975 # indicating a deprecated resource and a suggested replacement, or a
4976 # warning about invalid network settings (for example, if an instance
4977 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4978 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4979 },
4980 ],
4981 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4982 },
4983 ],
4984 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4985 # applicable when performing per-zone operations.
4986 }</pre>
4987 </div>
4988
4989 <div class="method">
4990 <code class="details" id="patch">patch(firewallPolicy, body=None, requestId=None, x__xgafv=None)</code>
4991 <pre>Patches the specified policy with the data included in the request.
4992
4993 Args:
4994 firewallPolicy: string, Name of the firewall policy to update. (required)
4995 body: object, The request body.
4996 The object takes the form of:
4997
4998 { # Represents a Firewall Policy resource.
4999 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
5000 {
5001 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
5002 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
5003 # of the firewall policy of the association.
5004 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
5005 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
5006 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
5007 # must be a positive value between 1 and 2147483647.
5008 # Firewall Policies are evaluated from highest to lowest priority where 1
5009 # is the highest priority and 2147483647 is the lowest priority.
5010 # The default value is `1000`. If two associations have the same priority
5011 # then lexicographical order on association names is applied.
5012 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
5013 },
5014 ],
5015 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5016 # text format.
5017 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5018 # create the resource.
5019 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
5020 # Organization firewall policy. The name should be unique in the organization
5021 # in which the firewall policy is created.
5022 # This field is not applicable to network firewall policies.
5023 # This name must be set on creation and cannot be changed.
5024 # The name must be 1-63 characters long, and comply
5025 # with RFC1035. Specifically, the name must be 1-63 characters
5026 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
5027 # means the first character must be a lowercase letter, and all following
5028 # characters must be a dash, lowercase letter, or digit, except the last
5029 # character, which cannot be a dash.
5030 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
5031 # the metadata&#x27;s contents and used for optimistic locking. The
5032 # fingerprint is initially generated by Compute Engine and changes after
5033 # every request to modify or update metadata. You must always provide an
5034 # up-to-date fingerprint hash in order to update or change metadata,
5035 # otherwise the request will fail with error412 conditionNotMet.
5036 #
5037 # To see the latest fingerprint, make get() request to the
5038 # firewall policy.
5039 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5040 # defined by the server.
5041 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
5042 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
5043 # [Output Only] numeric ID allocated by Google Cloud which uniquely
5044 # identifies the Organization Firewall Policy.
5045 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
5046 { # Represents a rule that describes one or more match conditions along with
5047 # the action to be taken when traffic matches this condition (allow or deny).
5048 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5049 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5050 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5051 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5052 # and &quot;goto_next&quot;.
5053 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5054 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5055 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5056 # the firewall policy rule is not enforced and traffic behaves as if it did
5057 # not exist. If this is unspecified, the firewall policy rule will be
5058 # enabled.
5059 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5060 # enabled, logs will be exported to the configured export destination in
5061 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5062 # cannot enable logging on &quot;goto_next&quot; rules.
5063 &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.
5064 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5065 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5066 # Exactly one field must be specified.
5067 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5068 # Maximum number of destination address groups is 10.
5069 &quot;A String&quot;,
5070 ],
5071 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5072 # traffic destination.
5073 # Maximum number of destination fqdn allowed is 100.
5074 &quot;A String&quot;,
5075 ],
5076 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5077 # Maximum number of destination CIDR IP ranges allowed is 5000.
5078 &quot;A String&quot;,
5079 ],
5080 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5081 #
5082 #
5083 # - UNSPECIFIED
5084 # - INTERNET
5085 # - NON_INTERNET
5086 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5087 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5088 #
5089 #
5090 # - UNSPECIFIED
5091 # - INTERNET
5092 # - NON_INTERNET
5093 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5094 # of traffic. Should be specified as 2 letter country code defined as per
5095 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5096 # Maximum number of dest region codes allowed is 5000.
5097 &quot;A String&quot;,
5098 ],
5099 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5100 # The IPs in these lists will be matched against traffic destination.
5101 &quot;A String&quot;,
5102 ],
5103 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5104 {
5105 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5106 # required when creating a firewall rule. This value can either be
5107 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5108 # protocol number.
5109 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5110 # only applicable for UDP or TCP protocol. Each entry must be either
5111 # an integer or a range. If not specified, this rule applies to
5112 # connections through any port.
5113 #
5114 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5115 &quot;A String&quot;,
5116 ],
5117 },
5118 ],
5119 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5120 # Maximum number of source address groups is 10.
5121 &quot;A String&quot;,
5122 ],
5123 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5124 # traffic source.
5125 # Maximum number of source fqdn allowed is 100.
5126 &quot;A String&quot;,
5127 ],
5128 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5129 # Maximum number of source CIDR IP ranges allowed is 5000.
5130 &quot;A String&quot;,
5131 ],
5132 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5133 #
5134 #
5135 # - UNSPECIFIED
5136 # - INTERNET
5137 # - INTRA_VPC
5138 # - NON_INTERNET
5139 # - VPC_NETWORKS
5140 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5141 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5142 #
5143 #
5144 # - UNSPECIFIED
5145 # - INTERNET
5146 # - INTRA_VPC
5147 # - NON_INTERNET
5148 # - VPC_NETWORKS
5149 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5150 &quot;A String&quot;,
5151 ],
5152 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5153 # of traffic. Should be specified as 2 letter country code defined as per
5154 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5155 # Maximum number of source region codes allowed is 5000.
5156 &quot;A String&quot;,
5157 ],
5158 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5159 # of the traffic.
5160 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5161 # and there is no srcIpRange, this rule will be ignored.
5162 # Maximum number of source tag values allowed is 256.
5163 {
5164 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5165 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5166 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5167 # or its network is deleted.
5168 },
5169 ],
5170 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5171 # The IPs in these lists will be matched against traffic source.
5172 &quot;A String&quot;,
5173 ],
5174 },
5175 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5176 # must be a positive value between 0 and 2147483647.
5177 # Rules are evaluated from highest to lowest priority where 0 is the
5178 # highest priority and 2147483647 is the lowest priority.
5179 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5180 # and can be updated.
5181 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5182 # rule.
5183 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5184 # Example:
5185 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5186 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5187 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5188 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5189 # This field allows you to control which load balancers get this rule.
5190 # For example, the following are valid values:
5191 #
5192 #
5193 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5194 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5195 # - projects/project/global/
5196 # forwardingRules/forwardingRule
5197 # - projects/project/regions/region/forwardingRules/
5198 # forwardingRule
5199 &quot;A String&quot;,
5200 ],
5201 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5202 # allows you to control which network&#x27;s VMs get this rule. If this field
5203 # is left blank, all VMs within the organization will receive the rule.
5204 &quot;A String&quot;,
5205 ],
5206 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5207 # applies to. If targetSecureTag are specified, then the
5208 # firewall rule applies only to instances in the VPC network that have one
5209 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5210 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5211 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5212 # to all instances on the specified network.
5213 # Maximum number of target label tags allowed is 256.
5214 {
5215 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5216 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5217 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5218 # or its network is deleted.
5219 },
5220 ],
5221 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5222 # applied with this rule.
5223 &quot;A String&quot;,
5224 ],
5225 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5226 # Default value is INSTANCES.
5227 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5228 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5229 # be set for other actions.
5230 },
5231 ],
5232 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
5233 # This field is not applicable to network firewall policies.
5234 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
5235 # creation and defaults to USER_DEFINED.
5236 #
5237 # The USER_DEFINED value indicates a regular firewall policy.
5238 #
5239 # The SYSTEM value indicates a system-level policy managed by an
5240 # internal service like GKE. This SYSTEM value is reserved for
5241 # internal services and cannot be set by users during policy creation.
5242 # Policies with a SYSTEM source cannot be modified or deleted by
5243 # users.
5244 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
5245 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
5246 #
5247 # Note: if not specified then VPC_POLICY will be used.
5248 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
5249 # This field is not applicable to global firewall policies.
5250 # You must specify this field as part of the HTTP request URL. It is
5251 # not settable as a field in the request body.
5252 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
5253 # policy can not exceed a set number of tuples.
5254 &quot;rules&quot;: [ # A list of rules that belong to this policy.
5255 # There must always be a default rule (rule with priority 2147483647 and
5256 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
5257 # default rule with action &quot;allow&quot; will be added.
5258 { # Represents a rule that describes one or more match conditions along with
5259 # the action to be taken when traffic matches this condition (allow or deny).
5260 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5261 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5262 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5263 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5264 # and &quot;goto_next&quot;.
5265 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5266 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5267 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5268 # the firewall policy rule is not enforced and traffic behaves as if it did
5269 # not exist. If this is unspecified, the firewall policy rule will be
5270 # enabled.
5271 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5272 # enabled, logs will be exported to the configured export destination in
5273 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5274 # cannot enable logging on &quot;goto_next&quot; rules.
5275 &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.
5276 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5277 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5278 # Exactly one field must be specified.
5279 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5280 # Maximum number of destination address groups is 10.
5281 &quot;A String&quot;,
5282 ],
5283 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5284 # traffic destination.
5285 # Maximum number of destination fqdn allowed is 100.
5286 &quot;A String&quot;,
5287 ],
5288 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5289 # Maximum number of destination CIDR IP ranges allowed is 5000.
5290 &quot;A String&quot;,
5291 ],
5292 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5293 #
5294 #
5295 # - UNSPECIFIED
5296 # - INTERNET
5297 # - NON_INTERNET
5298 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5299 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5300 #
5301 #
5302 # - UNSPECIFIED
5303 # - INTERNET
5304 # - NON_INTERNET
5305 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5306 # of traffic. Should be specified as 2 letter country code defined as per
5307 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5308 # Maximum number of dest region codes allowed is 5000.
5309 &quot;A String&quot;,
5310 ],
5311 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5312 # The IPs in these lists will be matched against traffic destination.
5313 &quot;A String&quot;,
5314 ],
5315 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5316 {
5317 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5318 # required when creating a firewall rule. This value can either be
5319 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5320 # protocol number.
5321 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5322 # only applicable for UDP or TCP protocol. Each entry must be either
5323 # an integer or a range. If not specified, this rule applies to
5324 # connections through any port.
5325 #
5326 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5327 &quot;A String&quot;,
5328 ],
5329 },
5330 ],
5331 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5332 # Maximum number of source address groups is 10.
5333 &quot;A String&quot;,
5334 ],
5335 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5336 # traffic source.
5337 # Maximum number of source fqdn allowed is 100.
5338 &quot;A String&quot;,
5339 ],
5340 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5341 # Maximum number of source CIDR IP ranges allowed is 5000.
5342 &quot;A String&quot;,
5343 ],
5344 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5345 #
5346 #
5347 # - UNSPECIFIED
5348 # - INTERNET
5349 # - INTRA_VPC
5350 # - NON_INTERNET
5351 # - VPC_NETWORKS
5352 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5353 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5354 #
5355 #
5356 # - UNSPECIFIED
5357 # - INTERNET
5358 # - INTRA_VPC
5359 # - NON_INTERNET
5360 # - VPC_NETWORKS
5361 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5362 &quot;A String&quot;,
5363 ],
5364 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5365 # of traffic. Should be specified as 2 letter country code defined as per
5366 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5367 # Maximum number of source region codes allowed is 5000.
5368 &quot;A String&quot;,
5369 ],
5370 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5371 # of the traffic.
5372 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5373 # and there is no srcIpRange, this rule will be ignored.
5374 # Maximum number of source tag values allowed is 256.
5375 {
5376 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5377 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5378 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5379 # or its network is deleted.
5380 },
5381 ],
5382 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5383 # The IPs in these lists will be matched against traffic source.
5384 &quot;A String&quot;,
5385 ],
5386 },
5387 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5388 # must be a positive value between 0 and 2147483647.
5389 # Rules are evaluated from highest to lowest priority where 0 is the
5390 # highest priority and 2147483647 is the lowest priority.
5391 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5392 # and can be updated.
5393 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5394 # rule.
5395 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5396 # Example:
5397 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5398 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5399 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5400 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5401 # This field allows you to control which load balancers get this rule.
5402 # For example, the following are valid values:
5403 #
5404 #
5405 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5406 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5407 # - projects/project/global/
5408 # forwardingRules/forwardingRule
5409 # - projects/project/regions/region/forwardingRules/
5410 # forwardingRule
5411 &quot;A String&quot;,
5412 ],
5413 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5414 # allows you to control which network&#x27;s VMs get this rule. If this field
5415 # is left blank, all VMs within the organization will receive the rule.
5416 &quot;A String&quot;,
5417 ],
5418 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5419 # applies to. If targetSecureTag are specified, then the
5420 # firewall rule applies only to instances in the VPC network that have one
5421 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5422 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5423 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5424 # to all instances on the specified network.
5425 # Maximum number of target label tags allowed is 256.
5426 {
5427 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5428 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5429 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5430 # or its network is deleted.
5431 },
5432 ],
5433 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5434 # applied with this rule.
5435 &quot;A String&quot;,
5436 ],
5437 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5438 # Default value is INSTANCES.
5439 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5440 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5441 # be set for other actions.
5442 },
5443 ],
5444 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5445 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5446 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
5447 # unique in the organization in which the firewall policy is created.
5448 # This field is not applicable to network firewall policies.
5449 # This name must be set on creation and cannot be changed. The name must be
5450 # 1-63 characters long, and comply with RFC1035.
5451 # Specifically, the name must be 1-63 characters long and match the regular
5452 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5453 # character must be a lowercase letter, and all following characters must
5454 # be a dash, lowercase letter, or digit, except the last character, which
5455 # cannot be a dash.
5456 }
5457
5458 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5459 that if you must retry your request, the server will know to ignore the
5460 request if it has already been completed.
5461
5462 For example, consider a situation where you make an initial request and
5463 the request times out. If you make the request again with the same
5464 request ID, the server can check if original operation with the same
5465 request ID was received, and if so, will ignore the second request. This
5466 prevents clients from accidentally creating duplicate commitments.
5467
5468 The request ID must be
5469 a valid UUID with the exception that zero UUID is not supported
5470 (00000000-0000-0000-0000-000000000000).
5471 x__xgafv: string, V1 error format.
5472 Allowed values
5473 1 - v1 error format
5474 2 - v2 error format
5475
5476 Returns:
5477 An object of the form:
5478
5479 { # Represents an Operation resource.
5480 #
5481 # Google Compute Engine has three Operation resources:
5482 #
5483 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
5484 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
5485 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
5486 #
5487 # You can use an operation resource to manage asynchronous API requests.
5488 # For more information, readHandling
5489 # API responses.
5490 #
5491 # Operations can be global, regional or zonal.
5492 #
5493 # - For global operations, use the `globalOperations`
5494 # resource.
5495 # - For regional operations, use the
5496 # `regionOperations` resource.
5497 # - For zonal operations, use
5498 # the `zoneOperations` resource.
5499 #
5500 #
5501 #
5502 # For more information, read
5503 # Global, Regional, and Zonal Resources.
5504 #
5505 # Note that completed Operation resources have a limited
5506 # retention period.
5507 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5508 # Not present otherwise.
5509 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5510 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5511 # set when the operation is created.
5512 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5513 # text format.
5514 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5515 # this field will be populated.
5516 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5517 # operation.
5518 {
5519 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5520 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5521 # details. There is a set of defined message types to use for providing
5522 # details.The syntax depends on the error code. For example,
5523 # QuotaExceededInfo will have details when the error code is
5524 # QUOTA_EXCEEDED.
5525 {
5526 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5527 #
5528 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5529 # is not enabled:
5530 #
5531 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5532 # &quot;domain&quot;: &quot;googleapis.com&quot;
5533 # &quot;metadata&quot;: {
5534 # &quot;resource&quot;: &quot;projects/123&quot;,
5535 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5536 # }
5537 # }
5538 #
5539 # This response indicates that the pubsub.googleapis.com API is not enabled.
5540 #
5541 # Example of an error that is returned when attempting to create a Spanner
5542 # instance in a region that is out of stock:
5543 #
5544 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5545 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5546 # &quot;metadata&quot;: {
5547 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5548 # }
5549 # }
5550 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5551 # is typically the registered service name of the tool or product that
5552 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5553 # generated by some common infrastructure, the error domain must be a
5554 # globally unique value that identifies the infrastructure. For Google API
5555 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5556 &quot;metadatas&quot;: { # Additional structured details about this error.
5557 #
5558 # Keys must match a regular expression of `a-z+` but should
5559 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5560 # length. When identifying the current value of an exceeded limit, the units
5561 # should be contained in the key, not the value. For example, rather than
5562 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5563 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5564 # instances that can be created in a single (batch) request.
5565 &quot;a_key&quot;: &quot;A String&quot;,
5566 },
5567 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5568 # proximate cause of the error. Error reasons are unique within a particular
5569 # domain of errors. This should be at most 63 characters and match a
5570 # regular expression of `A-Z+[A-Z0-9]`, which represents
5571 # UPPER_SNAKE_CASE.
5572 },
5573 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5574 #
5575 # For example, if a quota check failed with an error indicating the calling
5576 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5577 # directly to the right place in the developer console to flip the bit.
5578 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5579 { # Describes a URL link.
5580 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5581 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5582 },
5583 ],
5584 },
5585 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5586 # which can be attached to an RPC error.
5587 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5588 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5589 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5590 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5591 },
5592 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5593 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5594 &quot;a_key&quot;: &quot;A String&quot;,
5595 },
5596 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5597 # type or metric.
5598 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5599 # or metric.
5600 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5601 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5602 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5603 },
5604 },
5605 ],
5606 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5607 # This property is optional.
5608 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5609 },
5610 ],
5611 },
5612 &quot;getVersionOperationMetadata&quot;: {
5613 &quot;inlineSbomInfo&quot;: {
5614 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5615 # appropriate identifiers.
5616 &quot;a_key&quot;: &quot;A String&quot;,
5617 },
5618 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5619 # identifiers.
5620 &quot;a_key&quot;: &quot;A String&quot;,
5621 },
5622 },
5623 },
5624 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5625 # message that was returned, such as `NOT FOUND`.
5626 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5627 # status code that was returned. For example, a `404` means the
5628 # resource was not found.
5629 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5630 # defined by the server.
5631 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5632 # This value is inRFC3339
5633 # text format.
5634 &quot;instancesBulkInsertOperationMetadata&quot;: {
5635 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5636 # Example key: zones/us-central1-a
5637 &quot;a_key&quot;: {
5638 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5639 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5640 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5641 # error.
5642 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5643 # if the flow is rolling forward or rolling back.
5644 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5645 },
5646 },
5647 },
5648 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5649 # Operation resources.
5650 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5651 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5652 # group of operations results from a `bulkInsert` API request.
5653 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5654 # `update`, or `delete`, and so on.
5655 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5656 # There is no requirement that this be linear or support any granularity of
5657 # operations. This should not be used to guess when the operation will be
5658 # complete. This number should monotonically increase as the operation
5659 # progresses.
5660 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5661 # applicable when performing regional operations.
5662 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5663 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5664 # this field will contain information on all underlying zonal actions and
5665 # their state.
5666 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5667 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5668 # Example key: zones/us-central1-a
5669 &quot;a_key&quot;: {
5670 &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
5671 # populated.
5672 # different programming environments, including REST APIs and RPC APIs. It is
5673 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5674 # three pieces of data: error code, error message, and error details.
5675 #
5676 # You can find out more about this error model and how to work with it in the
5677 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5678 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5679 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5680 # message types for APIs to use.
5681 {
5682 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5683 },
5684 ],
5685 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5686 # user-facing error message should be localized and sent in the
5687 # google.rpc.Status.details field, or localized by the client.
5688 },
5689 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5690 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5691 },
5692 },
5693 },
5694 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5695 # This value is inRFC3339
5696 # text format.
5697 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5698 # following:
5699 # `PENDING`, `RUNNING`, or `DONE`.
5700 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5701 # operation.
5702 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5703 # of the target resource.
5704 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5705 # operations related to creating a snapshot, this points to the disk
5706 # that the snapshot was created from.
5707 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5708 # `[email protected]` or
5709 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5710 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5711 # operation, this field will be populated.
5712 {
5713 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5714 # Engine returns NO_RESULTS_ON_PAGE if there
5715 # are no results in the response.
5716 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5717 # value format. For example:
5718 #
5719 # &quot;data&quot;: [
5720 # {
5721 # &quot;key&quot;: &quot;scope&quot;,
5722 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5723 # }
5724 {
5725 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5726 # returned. For example, for warnings where there are no results in a list
5727 # request for a particular zone, this key might be scope and
5728 # the key value might be the zone name. Other examples might be a key
5729 # indicating a deprecated resource and a suggested replacement, or a
5730 # warning about invalid network settings (for example, if an instance
5731 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5732 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5733 },
5734 ],
5735 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5736 },
5737 ],
5738 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5739 # applicable when performing per-zone operations.
5740 }</pre>
5741 </div>
5742
5743 <div class="method">
5744 <code class="details" id="patchPacketMirroringRule">patchPacketMirroringRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code>
5745 <pre>Patches a packet mirroring rule of the specified priority.
5746
5747 Args:
5748 firewallPolicy: string, Name of the firewall policy to update. (required)
5749 body: object, The request body.
5750 The object takes the form of:
5751
5752 { # Represents a rule that describes one or more match conditions along with
5753 # the action to be taken when traffic matches this condition (allow or deny).
5754 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5755 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5756 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5757 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5758 # and &quot;goto_next&quot;.
5759 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5760 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5761 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5762 # the firewall policy rule is not enforced and traffic behaves as if it did
5763 # not exist. If this is unspecified, the firewall policy rule will be
5764 # enabled.
5765 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5766 # enabled, logs will be exported to the configured export destination in
5767 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5768 # cannot enable logging on &quot;goto_next&quot; rules.
5769 &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.
5770 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5771 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5772 # Exactly one field must be specified.
5773 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5774 # Maximum number of destination address groups is 10.
5775 &quot;A String&quot;,
5776 ],
5777 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5778 # traffic destination.
5779 # Maximum number of destination fqdn allowed is 100.
5780 &quot;A String&quot;,
5781 ],
5782 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5783 # Maximum number of destination CIDR IP ranges allowed is 5000.
5784 &quot;A String&quot;,
5785 ],
5786 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5787 #
5788 #
5789 # - UNSPECIFIED
5790 # - INTERNET
5791 # - NON_INTERNET
5792 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5793 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5794 #
5795 #
5796 # - UNSPECIFIED
5797 # - INTERNET
5798 # - NON_INTERNET
5799 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5800 # of traffic. Should be specified as 2 letter country code defined as per
5801 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5802 # Maximum number of dest region codes allowed is 5000.
5803 &quot;A String&quot;,
5804 ],
5805 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5806 # The IPs in these lists will be matched against traffic destination.
5807 &quot;A String&quot;,
5808 ],
5809 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5810 {
5811 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5812 # required when creating a firewall rule. This value can either be
5813 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5814 # protocol number.
5815 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5816 # only applicable for UDP or TCP protocol. Each entry must be either
5817 # an integer or a range. If not specified, this rule applies to
5818 # connections through any port.
5819 #
5820 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5821 &quot;A String&quot;,
5822 ],
5823 },
5824 ],
5825 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5826 # Maximum number of source address groups is 10.
5827 &quot;A String&quot;,
5828 ],
5829 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5830 # traffic source.
5831 # Maximum number of source fqdn allowed is 100.
5832 &quot;A String&quot;,
5833 ],
5834 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5835 # Maximum number of source CIDR IP ranges allowed is 5000.
5836 &quot;A String&quot;,
5837 ],
5838 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5839 #
5840 #
5841 # - UNSPECIFIED
5842 # - INTERNET
5843 # - INTRA_VPC
5844 # - NON_INTERNET
5845 # - VPC_NETWORKS
5846 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5847 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5848 #
5849 #
5850 # - UNSPECIFIED
5851 # - INTERNET
5852 # - INTRA_VPC
5853 # - NON_INTERNET
5854 # - VPC_NETWORKS
5855 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5856 &quot;A String&quot;,
5857 ],
5858 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5859 # of traffic. Should be specified as 2 letter country code defined as per
5860 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5861 # Maximum number of source region codes allowed is 5000.
5862 &quot;A String&quot;,
5863 ],
5864 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5865 # of the traffic.
5866 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5867 # and there is no srcIpRange, this rule will be ignored.
5868 # Maximum number of source tag values allowed is 256.
5869 {
5870 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5871 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5872 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5873 # or its network is deleted.
5874 },
5875 ],
5876 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5877 # The IPs in these lists will be matched against traffic source.
5878 &quot;A String&quot;,
5879 ],
5880 },
5881 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5882 # must be a positive value between 0 and 2147483647.
5883 # Rules are evaluated from highest to lowest priority where 0 is the
5884 # highest priority and 2147483647 is the lowest priority.
5885 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5886 # and can be updated.
5887 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5888 # rule.
5889 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5890 # Example:
5891 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5892 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5893 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5894 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5895 # This field allows you to control which load balancers get this rule.
5896 # For example, the following are valid values:
5897 #
5898 #
5899 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5900 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5901 # - projects/project/global/
5902 # forwardingRules/forwardingRule
5903 # - projects/project/regions/region/forwardingRules/
5904 # forwardingRule
5905 &quot;A String&quot;,
5906 ],
5907 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5908 # allows you to control which network&#x27;s VMs get this rule. If this field
5909 # is left blank, all VMs within the organization will receive the rule.
5910 &quot;A String&quot;,
5911 ],
5912 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5913 # applies to. If targetSecureTag are specified, then the
5914 # firewall rule applies only to instances in the VPC network that have one
5915 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5916 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5917 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5918 # to all instances on the specified network.
5919 # Maximum number of target label tags allowed is 256.
5920 {
5921 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5922 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5923 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5924 # or its network is deleted.
5925 },
5926 ],
5927 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5928 # applied with this rule.
5929 &quot;A String&quot;,
5930 ],
5931 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5932 # Default value is INSTANCES.
5933 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5934 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5935 # be set for other actions.
5936 }
5937
5938 priority: integer, The priority of the rule to patch.
5939 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5940 that if you must retry your request, the server will know to ignore the
5941 request if it has already been completed.
5942
5943 For example, consider a situation where you make an initial request and
5944 the request times out. If you make the request again with the same
5945 request ID, the server can check if original operation with the same
5946 request ID was received, and if so, will ignore the second request. This
5947 prevents clients from accidentally creating duplicate commitments.
5948
5949 The request ID must be
5950 a valid UUID with the exception that zero UUID is not supported
5951 (00000000-0000-0000-0000-000000000000).
5952 x__xgafv: string, V1 error format.
5953 Allowed values
5954 1 - v1 error format
5955 2 - v2 error format
5956
5957 Returns:
5958 An object of the form:
5959
5960 { # Represents an Operation resource.
5961 #
5962 # Google Compute Engine has three Operation resources:
5963 #
5964 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
5965 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
5966 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
5967 #
5968 # You can use an operation resource to manage asynchronous API requests.
5969 # For more information, readHandling
5970 # API responses.
5971 #
5972 # Operations can be global, regional or zonal.
5973 #
5974 # - For global operations, use the `globalOperations`
5975 # resource.
5976 # - For regional operations, use the
5977 # `regionOperations` resource.
5978 # - For zonal operations, use
5979 # the `zoneOperations` resource.
5980 #
5981 #
5982 #
5983 # For more information, read
5984 # Global, Regional, and Zonal Resources.
5985 #
5986 # Note that completed Operation resources have a limited
5987 # retention period.
5988 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5989 # Not present otherwise.
5990 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5991 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5992 # set when the operation is created.
5993 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5994 # text format.
5995 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5996 # this field will be populated.
5997 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5998 # operation.
5999 {
6000 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6001 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6002 # details. There is a set of defined message types to use for providing
6003 # details.The syntax depends on the error code. For example,
6004 # QuotaExceededInfo will have details when the error code is
6005 # QUOTA_EXCEEDED.
6006 {
6007 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6008 #
6009 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6010 # is not enabled:
6011 #
6012 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6013 # &quot;domain&quot;: &quot;googleapis.com&quot;
6014 # &quot;metadata&quot;: {
6015 # &quot;resource&quot;: &quot;projects/123&quot;,
6016 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6017 # }
6018 # }
6019 #
6020 # This response indicates that the pubsub.googleapis.com API is not enabled.
6021 #
6022 # Example of an error that is returned when attempting to create a Spanner
6023 # instance in a region that is out of stock:
6024 #
6025 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6026 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6027 # &quot;metadata&quot;: {
6028 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6029 # }
6030 # }
6031 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6032 # is typically the registered service name of the tool or product that
6033 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6034 # generated by some common infrastructure, the error domain must be a
6035 # globally unique value that identifies the infrastructure. For Google API
6036 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6037 &quot;metadatas&quot;: { # Additional structured details about this error.
6038 #
6039 # Keys must match a regular expression of `a-z+` but should
6040 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6041 # length. When identifying the current value of an exceeded limit, the units
6042 # should be contained in the key, not the value. For example, rather than
6043 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6044 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6045 # instances that can be created in a single (batch) request.
6046 &quot;a_key&quot;: &quot;A String&quot;,
6047 },
6048 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6049 # proximate cause of the error. Error reasons are unique within a particular
6050 # domain of errors. This should be at most 63 characters and match a
6051 # regular expression of `A-Z+[A-Z0-9]`, which represents
6052 # UPPER_SNAKE_CASE.
6053 },
6054 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6055 #
6056 # For example, if a quota check failed with an error indicating the calling
6057 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6058 # directly to the right place in the developer console to flip the bit.
6059 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6060 { # Describes a URL link.
6061 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6062 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6063 },
6064 ],
6065 },
6066 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6067 # which can be attached to an RPC error.
6068 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6069 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6070 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6071 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6072 },
6073 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6074 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6075 &quot;a_key&quot;: &quot;A String&quot;,
6076 },
6077 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6078 # type or metric.
6079 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6080 # or metric.
6081 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6082 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6083 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6084 },
6085 },
6086 ],
6087 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6088 # This property is optional.
6089 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6090 },
6091 ],
6092 },
6093 &quot;getVersionOperationMetadata&quot;: {
6094 &quot;inlineSbomInfo&quot;: {
6095 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6096 # appropriate identifiers.
6097 &quot;a_key&quot;: &quot;A String&quot;,
6098 },
6099 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6100 # identifiers.
6101 &quot;a_key&quot;: &quot;A String&quot;,
6102 },
6103 },
6104 },
6105 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6106 # message that was returned, such as `NOT FOUND`.
6107 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6108 # status code that was returned. For example, a `404` means the
6109 # resource was not found.
6110 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6111 # defined by the server.
6112 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6113 # This value is inRFC3339
6114 # text format.
6115 &quot;instancesBulkInsertOperationMetadata&quot;: {
6116 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6117 # Example key: zones/us-central1-a
6118 &quot;a_key&quot;: {
6119 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6120 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6121 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6122 # error.
6123 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6124 # if the flow is rolling forward or rolling back.
6125 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6126 },
6127 },
6128 },
6129 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6130 # Operation resources.
6131 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6132 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6133 # group of operations results from a `bulkInsert` API request.
6134 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6135 # `update`, or `delete`, and so on.
6136 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6137 # There is no requirement that this be linear or support any granularity of
6138 # operations. This should not be used to guess when the operation will be
6139 # complete. This number should monotonically increase as the operation
6140 # progresses.
6141 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6142 # applicable when performing regional operations.
6143 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6144 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6145 # this field will contain information on all underlying zonal actions and
6146 # their state.
6147 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6148 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6149 # Example key: zones/us-central1-a
6150 &quot;a_key&quot;: {
6151 &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
6152 # populated.
6153 # different programming environments, including REST APIs and RPC APIs. It is
6154 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6155 # three pieces of data: error code, error message, and error details.
6156 #
6157 # You can find out more about this error model and how to work with it in the
6158 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6159 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6160 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6161 # message types for APIs to use.
6162 {
6163 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6164 },
6165 ],
6166 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6167 # user-facing error message should be localized and sent in the
6168 # google.rpc.Status.details field, or localized by the client.
6169 },
6170 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6171 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6172 },
6173 },
6174 },
6175 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6176 # This value is inRFC3339
6177 # text format.
6178 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6179 # following:
6180 # `PENDING`, `RUNNING`, or `DONE`.
6181 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6182 # operation.
6183 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6184 # of the target resource.
6185 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6186 # operations related to creating a snapshot, this points to the disk
6187 # that the snapshot was created from.
6188 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6189 # `[email protected]` or
6190 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6191 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6192 # operation, this field will be populated.
6193 {
6194 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6195 # Engine returns NO_RESULTS_ON_PAGE if there
6196 # are no results in the response.
6197 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6198 # value format. For example:
6199 #
6200 # &quot;data&quot;: [
6201 # {
6202 # &quot;key&quot;: &quot;scope&quot;,
6203 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6204 # }
6205 {
6206 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6207 # returned. For example, for warnings where there are no results in a list
6208 # request for a particular zone, this key might be scope and
6209 # the key value might be the zone name. Other examples might be a key
6210 # indicating a deprecated resource and a suggested replacement, or a
6211 # warning about invalid network settings (for example, if an instance
6212 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6213 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6214 },
6215 ],
6216 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6217 },
6218 ],
6219 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6220 # applicable when performing per-zone operations.
6221 }</pre>
6222 </div>
6223
6224 <div class="method">
6225 <code class="details" id="patchRule">patchRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code>
6226 <pre>Patches a rule of the specified priority.
6227
6228 Args:
6229 firewallPolicy: string, Name of the firewall policy to update. (required)
6230 body: object, The request body.
6231 The object takes the form of:
6232
6233 { # Represents a rule that describes one or more match conditions along with
6234 # the action to be taken when traffic matches this condition (allow or deny).
6235 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
6236 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
6237 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
6238 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
6239 # and &quot;goto_next&quot;.
6240 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
6241 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
6242 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
6243 # the firewall policy rule is not enforced and traffic behaves as if it did
6244 # not exist. If this is unspecified, the firewall policy rule will be
6245 # enabled.
6246 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
6247 # enabled, logs will be exported to the configured export destination in
6248 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
6249 # cannot enable logging on &quot;goto_next&quot; rules.
6250 &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.
6251 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
6252 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
6253 # Exactly one field must be specified.
6254 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
6255 # Maximum number of destination address groups is 10.
6256 &quot;A String&quot;,
6257 ],
6258 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6259 # traffic destination.
6260 # Maximum number of destination fqdn allowed is 100.
6261 &quot;A String&quot;,
6262 ],
6263 &quot;destIpRanges&quot;: [ # CIDR IP address range.
6264 # Maximum number of destination CIDR IP ranges allowed is 5000.
6265 &quot;A String&quot;,
6266 ],
6267 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
6268 #
6269 #
6270 # - UNSPECIFIED
6271 # - INTERNET
6272 # - NON_INTERNET
6273 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
6274 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
6275 #
6276 #
6277 # - UNSPECIFIED
6278 # - INTERNET
6279 # - NON_INTERNET
6280 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
6281 # of traffic. Should be specified as 2 letter country code defined as per
6282 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6283 # Maximum number of dest region codes allowed is 5000.
6284 &quot;A String&quot;,
6285 ],
6286 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6287 # The IPs in these lists will be matched against traffic destination.
6288 &quot;A String&quot;,
6289 ],
6290 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
6291 {
6292 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
6293 # required when creating a firewall rule. This value can either be
6294 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
6295 # protocol number.
6296 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
6297 # only applicable for UDP or TCP protocol. Each entry must be either
6298 # an integer or a range. If not specified, this rule applies to
6299 # connections through any port.
6300 #
6301 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
6302 &quot;A String&quot;,
6303 ],
6304 },
6305 ],
6306 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
6307 # Maximum number of source address groups is 10.
6308 &quot;A String&quot;,
6309 ],
6310 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6311 # traffic source.
6312 # Maximum number of source fqdn allowed is 100.
6313 &quot;A String&quot;,
6314 ],
6315 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
6316 # Maximum number of source CIDR IP ranges allowed is 5000.
6317 &quot;A String&quot;,
6318 ],
6319 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
6320 #
6321 #
6322 # - UNSPECIFIED
6323 # - INTERNET
6324 # - INTRA_VPC
6325 # - NON_INTERNET
6326 # - VPC_NETWORKS
6327 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
6328 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
6329 #
6330 #
6331 # - UNSPECIFIED
6332 # - INTERNET
6333 # - INTRA_VPC
6334 # - NON_INTERNET
6335 # - VPC_NETWORKS
6336 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
6337 &quot;A String&quot;,
6338 ],
6339 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
6340 # of traffic. Should be specified as 2 letter country code defined as per
6341 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6342 # Maximum number of source region codes allowed is 5000.
6343 &quot;A String&quot;,
6344 ],
6345 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
6346 # of the traffic.
6347 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
6348 # and there is no srcIpRange, this rule will be ignored.
6349 # Maximum number of source tag values allowed is 256.
6350 {
6351 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6352 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6353 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6354 # or its network is deleted.
6355 },
6356 ],
6357 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6358 # The IPs in these lists will be matched against traffic source.
6359 &quot;A String&quot;,
6360 ],
6361 },
6362 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
6363 # must be a positive value between 0 and 2147483647.
6364 # Rules are evaluated from highest to lowest priority where 0 is the
6365 # highest priority and 2147483647 is the lowest priority.
6366 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
6367 # and can be updated.
6368 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
6369 # rule.
6370 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
6371 # Example:
6372 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
6373 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
6374 # &#x27;mirror&#x27;. Cannot be specified for other actions.
6375 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
6376 # This field allows you to control which load balancers get this rule.
6377 # For example, the following are valid values:
6378 #
6379 #
6380 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
6381 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
6382 # - projects/project/global/
6383 # forwardingRules/forwardingRule
6384 # - projects/project/regions/region/forwardingRules/
6385 # forwardingRule
6386 &quot;A String&quot;,
6387 ],
6388 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
6389 # allows you to control which network&#x27;s VMs get this rule. If this field
6390 # is left blank, all VMs within the organization will receive the rule.
6391 &quot;A String&quot;,
6392 ],
6393 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
6394 # applies to. If targetSecureTag are specified, then the
6395 # firewall rule applies only to instances in the VPC network that have one
6396 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
6397 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
6398 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
6399 # to all instances on the specified network.
6400 # Maximum number of target label tags allowed is 256.
6401 {
6402 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6403 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6404 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6405 # or its network is deleted.
6406 },
6407 ],
6408 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
6409 # applied with this rule.
6410 &quot;A String&quot;,
6411 ],
6412 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
6413 # Default value is INSTANCES.
6414 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
6415 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
6416 # be set for other actions.
6417 }
6418
6419 priority: integer, The priority of the rule to patch.
6420 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6421 that if you must retry your request, the server will know to ignore the
6422 request if it has already been completed.
6423
6424 For example, consider a situation where you make an initial request and
6425 the request times out. If you make the request again with the same
6426 request ID, the server can check if original operation with the same
6427 request ID was received, and if so, will ignore the second request. This
6428 prevents clients from accidentally creating duplicate commitments.
6429
6430 The request ID must be
6431 a valid UUID with the exception that zero UUID is not supported
6432 (00000000-0000-0000-0000-000000000000).
6433 x__xgafv: string, V1 error format.
6434 Allowed values
6435 1 - v1 error format
6436 2 - v2 error format
6437
6438 Returns:
6439 An object of the form:
6440
6441 { # Represents an Operation resource.
6442 #
6443 # Google Compute Engine has three Operation resources:
6444 #
6445 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6446 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6447 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6448 #
6449 # You can use an operation resource to manage asynchronous API requests.
6450 # For more information, readHandling
6451 # API responses.
6452 #
6453 # Operations can be global, regional or zonal.
6454 #
6455 # - For global operations, use the `globalOperations`
6456 # resource.
6457 # - For regional operations, use the
6458 # `regionOperations` resource.
6459 # - For zonal operations, use
6460 # the `zoneOperations` resource.
6461 #
6462 #
6463 #
6464 # For more information, read
6465 # Global, Regional, and Zonal Resources.
6466 #
6467 # Note that completed Operation resources have a limited
6468 # retention period.
6469 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6470 # Not present otherwise.
6471 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6472 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6473 # set when the operation is created.
6474 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6475 # text format.
6476 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6477 # this field will be populated.
6478 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6479 # operation.
6480 {
6481 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6482 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6483 # details. There is a set of defined message types to use for providing
6484 # details.The syntax depends on the error code. For example,
6485 # QuotaExceededInfo will have details when the error code is
6486 # QUOTA_EXCEEDED.
6487 {
6488 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6489 #
6490 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6491 # is not enabled:
6492 #
6493 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6494 # &quot;domain&quot;: &quot;googleapis.com&quot;
6495 # &quot;metadata&quot;: {
6496 # &quot;resource&quot;: &quot;projects/123&quot;,
6497 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6498 # }
6499 # }
6500 #
6501 # This response indicates that the pubsub.googleapis.com API is not enabled.
6502 #
6503 # Example of an error that is returned when attempting to create a Spanner
6504 # instance in a region that is out of stock:
6505 #
6506 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6507 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6508 # &quot;metadata&quot;: {
6509 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6510 # }
6511 # }
6512 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6513 # is typically the registered service name of the tool or product that
6514 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6515 # generated by some common infrastructure, the error domain must be a
6516 # globally unique value that identifies the infrastructure. For Google API
6517 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6518 &quot;metadatas&quot;: { # Additional structured details about this error.
6519 #
6520 # Keys must match a regular expression of `a-z+` but should
6521 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6522 # length. When identifying the current value of an exceeded limit, the units
6523 # should be contained in the key, not the value. For example, rather than
6524 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6525 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6526 # instances that can be created in a single (batch) request.
6527 &quot;a_key&quot;: &quot;A String&quot;,
6528 },
6529 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6530 # proximate cause of the error. Error reasons are unique within a particular
6531 # domain of errors. This should be at most 63 characters and match a
6532 # regular expression of `A-Z+[A-Z0-9]`, which represents
6533 # UPPER_SNAKE_CASE.
6534 },
6535 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6536 #
6537 # For example, if a quota check failed with an error indicating the calling
6538 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6539 # directly to the right place in the developer console to flip the bit.
6540 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6541 { # Describes a URL link.
6542 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6543 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6544 },
6545 ],
6546 },
6547 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6548 # which can be attached to an RPC error.
6549 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6550 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6551 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6552 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6553 },
6554 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6555 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6556 &quot;a_key&quot;: &quot;A String&quot;,
6557 },
6558 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6559 # type or metric.
6560 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6561 # or metric.
6562 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6563 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6564 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6565 },
6566 },
6567 ],
6568 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6569 # This property is optional.
6570 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6571 },
6572 ],
6573 },
6574 &quot;getVersionOperationMetadata&quot;: {
6575 &quot;inlineSbomInfo&quot;: {
6576 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6577 # appropriate identifiers.
6578 &quot;a_key&quot;: &quot;A String&quot;,
6579 },
6580 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6581 # identifiers.
6582 &quot;a_key&quot;: &quot;A String&quot;,
6583 },
6584 },
6585 },
6586 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6587 # message that was returned, such as `NOT FOUND`.
6588 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6589 # status code that was returned. For example, a `404` means the
6590 # resource was not found.
6591 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6592 # defined by the server.
6593 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6594 # This value is inRFC3339
6595 # text format.
6596 &quot;instancesBulkInsertOperationMetadata&quot;: {
6597 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6598 # Example key: zones/us-central1-a
6599 &quot;a_key&quot;: {
6600 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6601 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6602 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6603 # error.
6604 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6605 # if the flow is rolling forward or rolling back.
6606 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6607 },
6608 },
6609 },
6610 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6611 # Operation resources.
6612 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6613 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6614 # group of operations results from a `bulkInsert` API request.
6615 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6616 # `update`, or `delete`, and so on.
6617 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6618 # There is no requirement that this be linear or support any granularity of
6619 # operations. This should not be used to guess when the operation will be
6620 # complete. This number should monotonically increase as the operation
6621 # progresses.
6622 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6623 # applicable when performing regional operations.
6624 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6625 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6626 # this field will contain information on all underlying zonal actions and
6627 # their state.
6628 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6629 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6630 # Example key: zones/us-central1-a
6631 &quot;a_key&quot;: {
6632 &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
6633 # populated.
6634 # different programming environments, including REST APIs and RPC APIs. It is
6635 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6636 # three pieces of data: error code, error message, and error details.
6637 #
6638 # You can find out more about this error model and how to work with it in the
6639 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6640 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6641 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6642 # message types for APIs to use.
6643 {
6644 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6645 },
6646 ],
6647 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6648 # user-facing error message should be localized and sent in the
6649 # google.rpc.Status.details field, or localized by the client.
6650 },
6651 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6652 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6653 },
6654 },
6655 },
6656 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6657 # This value is inRFC3339
6658 # text format.
6659 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6660 # following:
6661 # `PENDING`, `RUNNING`, or `DONE`.
6662 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6663 # operation.
6664 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6665 # of the target resource.
6666 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6667 # operations related to creating a snapshot, this points to the disk
6668 # that the snapshot was created from.
6669 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6670 # `[email protected]` or
6671 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6672 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6673 # operation, this field will be populated.
6674 {
6675 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6676 # Engine returns NO_RESULTS_ON_PAGE if there
6677 # are no results in the response.
6678 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6679 # value format. For example:
6680 #
6681 # &quot;data&quot;: [
6682 # {
6683 # &quot;key&quot;: &quot;scope&quot;,
6684 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6685 # }
6686 {
6687 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6688 # returned. For example, for warnings where there are no results in a list
6689 # request for a particular zone, this key might be scope and
6690 # the key value might be the zone name. Other examples might be a key
6691 # indicating a deprecated resource and a suggested replacement, or a
6692 # warning about invalid network settings (for example, if an instance
6693 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6694 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6695 },
6696 ],
6697 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6698 },
6699 ],
6700 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6701 # applicable when performing per-zone operations.
6702 }</pre>
6703 </div>
6704
6705 <div class="method">
6706 <code class="details" id="removeAssociation">removeAssociation(firewallPolicy, name=None, requestId=None, x__xgafv=None)</code>
6707 <pre>Removes an association for the specified firewall policy.
6708
6709 Args:
6710 firewallPolicy: string, Name of the firewall policy to update. (required)
6711 name: string, Name for the attachment that will be removed.
6712 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6713 that if you must retry your request, the server will know to ignore the
6714 request if it has already been completed.
6715
6716 For example, consider a situation where you make an initial request and
6717 the request times out. If you make the request again with the same
6718 request ID, the server can check if original operation with the same
6719 request ID was received, and if so, will ignore the second request. This
6720 prevents clients from accidentally creating duplicate commitments.
6721
6722 The request ID must be
6723 a valid UUID with the exception that zero UUID is not supported
6724 (00000000-0000-0000-0000-000000000000).
6725 x__xgafv: string, V1 error format.
6726 Allowed values
6727 1 - v1 error format
6728 2 - v2 error format
6729
6730 Returns:
6731 An object of the form:
6732
6733 { # Represents an Operation resource.
6734 #
6735 # Google Compute Engine has three Operation resources:
6736 #
6737 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6738 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6739 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6740 #
6741 # You can use an operation resource to manage asynchronous API requests.
6742 # For more information, readHandling
6743 # API responses.
6744 #
6745 # Operations can be global, regional or zonal.
6746 #
6747 # - For global operations, use the `globalOperations`
6748 # resource.
6749 # - For regional operations, use the
6750 # `regionOperations` resource.
6751 # - For zonal operations, use
6752 # the `zoneOperations` resource.
6753 #
6754 #
6755 #
6756 # For more information, read
6757 # Global, Regional, and Zonal Resources.
6758 #
6759 # Note that completed Operation resources have a limited
6760 # retention period.
6761 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6762 # Not present otherwise.
6763 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6764 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6765 # set when the operation is created.
6766 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6767 # text format.
6768 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6769 # this field will be populated.
6770 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6771 # operation.
6772 {
6773 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6774 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6775 # details. There is a set of defined message types to use for providing
6776 # details.The syntax depends on the error code. For example,
6777 # QuotaExceededInfo will have details when the error code is
6778 # QUOTA_EXCEEDED.
6779 {
6780 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6781 #
6782 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6783 # is not enabled:
6784 #
6785 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6786 # &quot;domain&quot;: &quot;googleapis.com&quot;
6787 # &quot;metadata&quot;: {
6788 # &quot;resource&quot;: &quot;projects/123&quot;,
6789 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6790 # }
6791 # }
6792 #
6793 # This response indicates that the pubsub.googleapis.com API is not enabled.
6794 #
6795 # Example of an error that is returned when attempting to create a Spanner
6796 # instance in a region that is out of stock:
6797 #
6798 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6799 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6800 # &quot;metadata&quot;: {
6801 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6802 # }
6803 # }
6804 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6805 # is typically the registered service name of the tool or product that
6806 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6807 # generated by some common infrastructure, the error domain must be a
6808 # globally unique value that identifies the infrastructure. For Google API
6809 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6810 &quot;metadatas&quot;: { # Additional structured details about this error.
6811 #
6812 # Keys must match a regular expression of `a-z+` but should
6813 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6814 # length. When identifying the current value of an exceeded limit, the units
6815 # should be contained in the key, not the value. For example, rather than
6816 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6817 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6818 # instances that can be created in a single (batch) request.
6819 &quot;a_key&quot;: &quot;A String&quot;,
6820 },
6821 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6822 # proximate cause of the error. Error reasons are unique within a particular
6823 # domain of errors. This should be at most 63 characters and match a
6824 # regular expression of `A-Z+[A-Z0-9]`, which represents
6825 # UPPER_SNAKE_CASE.
6826 },
6827 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6828 #
6829 # For example, if a quota check failed with an error indicating the calling
6830 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6831 # directly to the right place in the developer console to flip the bit.
6832 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6833 { # Describes a URL link.
6834 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6835 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6836 },
6837 ],
6838 },
6839 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6840 # which can be attached to an RPC error.
6841 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6842 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6843 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6844 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6845 },
6846 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6847 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6848 &quot;a_key&quot;: &quot;A String&quot;,
6849 },
6850 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6851 # type or metric.
6852 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6853 # or metric.
6854 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6855 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6856 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6857 },
6858 },
6859 ],
6860 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6861 # This property is optional.
6862 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6863 },
6864 ],
6865 },
6866 &quot;getVersionOperationMetadata&quot;: {
6867 &quot;inlineSbomInfo&quot;: {
6868 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6869 # appropriate identifiers.
6870 &quot;a_key&quot;: &quot;A String&quot;,
6871 },
6872 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6873 # identifiers.
6874 &quot;a_key&quot;: &quot;A String&quot;,
6875 },
6876 },
6877 },
6878 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6879 # message that was returned, such as `NOT FOUND`.
6880 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6881 # status code that was returned. For example, a `404` means the
6882 # resource was not found.
6883 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6884 # defined by the server.
6885 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6886 # This value is inRFC3339
6887 # text format.
6888 &quot;instancesBulkInsertOperationMetadata&quot;: {
6889 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6890 # Example key: zones/us-central1-a
6891 &quot;a_key&quot;: {
6892 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6893 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6894 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6895 # error.
6896 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6897 # if the flow is rolling forward or rolling back.
6898 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6899 },
6900 },
6901 },
6902 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6903 # Operation resources.
6904 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6905 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6906 # group of operations results from a `bulkInsert` API request.
6907 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6908 # `update`, or `delete`, and so on.
6909 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6910 # There is no requirement that this be linear or support any granularity of
6911 # operations. This should not be used to guess when the operation will be
6912 # complete. This number should monotonically increase as the operation
6913 # progresses.
6914 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6915 # applicable when performing regional operations.
6916 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6917 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6918 # this field will contain information on all underlying zonal actions and
6919 # their state.
6920 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6921 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6922 # Example key: zones/us-central1-a
6923 &quot;a_key&quot;: {
6924 &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
6925 # populated.
6926 # different programming environments, including REST APIs and RPC APIs. It is
6927 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6928 # three pieces of data: error code, error message, and error details.
6929 #
6930 # You can find out more about this error model and how to work with it in the
6931 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6932 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6933 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6934 # message types for APIs to use.
6935 {
6936 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6937 },
6938 ],
6939 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6940 # user-facing error message should be localized and sent in the
6941 # google.rpc.Status.details field, or localized by the client.
6942 },
6943 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6944 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6945 },
6946 },
6947 },
6948 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6949 # This value is inRFC3339
6950 # text format.
6951 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6952 # following:
6953 # `PENDING`, `RUNNING`, or `DONE`.
6954 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6955 # operation.
6956 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6957 # of the target resource.
6958 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6959 # operations related to creating a snapshot, this points to the disk
6960 # that the snapshot was created from.
6961 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6962 # `[email protected]` or
6963 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6964 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6965 # operation, this field will be populated.
6966 {
6967 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6968 # Engine returns NO_RESULTS_ON_PAGE if there
6969 # are no results in the response.
6970 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6971 # value format. For example:
6972 #
6973 # &quot;data&quot;: [
6974 # {
6975 # &quot;key&quot;: &quot;scope&quot;,
6976 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6977 # }
6978 {
6979 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6980 # returned. For example, for warnings where there are no results in a list
6981 # request for a particular zone, this key might be scope and
6982 # the key value might be the zone name. Other examples might be a key
6983 # indicating a deprecated resource and a suggested replacement, or a
6984 # warning about invalid network settings (for example, if an instance
6985 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6986 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6987 },
6988 ],
6989 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6990 },
6991 ],
6992 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6993 # applicable when performing per-zone operations.
6994 }</pre>
6995 </div>
6996
6997 <div class="method">
6998 <code class="details" id="removePacketMirroringRule">removePacketMirroringRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code>
6999 <pre>Deletes a packet mirroring rule of the specified priority.
7000
7001 Args:
7002 firewallPolicy: string, Name of the firewall policy to update. (required)
7003 priority: integer, The priority of the rule to remove from the firewall policy.
7004 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7005 that if you must retry your request, the server will know to ignore the
7006 request if it has already been completed.
7007
7008 For example, consider a situation where you make an initial request and
7009 the request times out. If you make the request again with the same
7010 request ID, the server can check if original operation with the same
7011 request ID was received, and if so, will ignore the second request. This
7012 prevents clients from accidentally creating duplicate commitments.
7013
7014 The request ID must be
7015 a valid UUID with the exception that zero UUID is not supported
7016 (00000000-0000-0000-0000-000000000000).
7017 x__xgafv: string, V1 error format.
7018 Allowed values
7019 1 - v1 error format
7020 2 - v2 error format
7021
7022 Returns:
7023 An object of the form:
7024
7025 { # Represents an Operation resource.
7026 #
7027 # Google Compute Engine has three Operation resources:
7028 #
7029 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
7030 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
7031 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
7032 #
7033 # You can use an operation resource to manage asynchronous API requests.
7034 # For more information, readHandling
7035 # API responses.
7036 #
7037 # Operations can be global, regional or zonal.
7038 #
7039 # - For global operations, use the `globalOperations`
7040 # resource.
7041 # - For regional operations, use the
7042 # `regionOperations` resource.
7043 # - For zonal operations, use
7044 # the `zoneOperations` resource.
7045 #
7046 #
7047 #
7048 # For more information, read
7049 # Global, Regional, and Zonal Resources.
7050 #
7051 # Note that completed Operation resources have a limited
7052 # retention period.
7053 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7054 # Not present otherwise.
7055 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7056 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7057 # set when the operation is created.
7058 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7059 # text format.
7060 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7061 # this field will be populated.
7062 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7063 # operation.
7064 {
7065 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7066 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7067 # details. There is a set of defined message types to use for providing
7068 # details.The syntax depends on the error code. For example,
7069 # QuotaExceededInfo will have details when the error code is
7070 # QUOTA_EXCEEDED.
7071 {
7072 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7073 #
7074 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7075 # is not enabled:
7076 #
7077 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7078 # &quot;domain&quot;: &quot;googleapis.com&quot;
7079 # &quot;metadata&quot;: {
7080 # &quot;resource&quot;: &quot;projects/123&quot;,
7081 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7082 # }
7083 # }
7084 #
7085 # This response indicates that the pubsub.googleapis.com API is not enabled.
7086 #
7087 # Example of an error that is returned when attempting to create a Spanner
7088 # instance in a region that is out of stock:
7089 #
7090 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7091 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7092 # &quot;metadata&quot;: {
7093 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7094 # }
7095 # }
7096 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7097 # is typically the registered service name of the tool or product that
7098 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7099 # generated by some common infrastructure, the error domain must be a
7100 # globally unique value that identifies the infrastructure. For Google API
7101 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7102 &quot;metadatas&quot;: { # Additional structured details about this error.
7103 #
7104 # Keys must match a regular expression of `a-z+` but should
7105 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7106 # length. When identifying the current value of an exceeded limit, the units
7107 # should be contained in the key, not the value. For example, rather than
7108 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7109 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7110 # instances that can be created in a single (batch) request.
7111 &quot;a_key&quot;: &quot;A String&quot;,
7112 },
7113 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7114 # proximate cause of the error. Error reasons are unique within a particular
7115 # domain of errors. This should be at most 63 characters and match a
7116 # regular expression of `A-Z+[A-Z0-9]`, which represents
7117 # UPPER_SNAKE_CASE.
7118 },
7119 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7120 #
7121 # For example, if a quota check failed with an error indicating the calling
7122 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7123 # directly to the right place in the developer console to flip the bit.
7124 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7125 { # Describes a URL link.
7126 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7127 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7128 },
7129 ],
7130 },
7131 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7132 # which can be attached to an RPC error.
7133 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7134 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7135 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7136 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7137 },
7138 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7139 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7140 &quot;a_key&quot;: &quot;A String&quot;,
7141 },
7142 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7143 # type or metric.
7144 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7145 # or metric.
7146 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7147 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7148 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7149 },
7150 },
7151 ],
7152 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7153 # This property is optional.
7154 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7155 },
7156 ],
7157 },
7158 &quot;getVersionOperationMetadata&quot;: {
7159 &quot;inlineSbomInfo&quot;: {
7160 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7161 # appropriate identifiers.
7162 &quot;a_key&quot;: &quot;A String&quot;,
7163 },
7164 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7165 # identifiers.
7166 &quot;a_key&quot;: &quot;A String&quot;,
7167 },
7168 },
7169 },
7170 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7171 # message that was returned, such as `NOT FOUND`.
7172 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7173 # status code that was returned. For example, a `404` means the
7174 # resource was not found.
7175 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7176 # defined by the server.
7177 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7178 # This value is inRFC3339
7179 # text format.
7180 &quot;instancesBulkInsertOperationMetadata&quot;: {
7181 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7182 # Example key: zones/us-central1-a
7183 &quot;a_key&quot;: {
7184 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7185 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7186 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7187 # error.
7188 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7189 # if the flow is rolling forward or rolling back.
7190 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7191 },
7192 },
7193 },
7194 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7195 # Operation resources.
7196 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7197 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7198 # group of operations results from a `bulkInsert` API request.
7199 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7200 # `update`, or `delete`, and so on.
7201 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7202 # There is no requirement that this be linear or support any granularity of
7203 # operations. This should not be used to guess when the operation will be
7204 # complete. This number should monotonically increase as the operation
7205 # progresses.
7206 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7207 # applicable when performing regional operations.
7208 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7209 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7210 # this field will contain information on all underlying zonal actions and
7211 # their state.
7212 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7213 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7214 # Example key: zones/us-central1-a
7215 &quot;a_key&quot;: {
7216 &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
7217 # populated.
7218 # different programming environments, including REST APIs and RPC APIs. It is
7219 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7220 # three pieces of data: error code, error message, and error details.
7221 #
7222 # You can find out more about this error model and how to work with it in the
7223 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7224 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7225 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7226 # message types for APIs to use.
7227 {
7228 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7229 },
7230 ],
7231 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7232 # user-facing error message should be localized and sent in the
7233 # google.rpc.Status.details field, or localized by the client.
7234 },
7235 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7236 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7237 },
7238 },
7239 },
7240 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7241 # This value is inRFC3339
7242 # text format.
7243 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7244 # following:
7245 # `PENDING`, `RUNNING`, or `DONE`.
7246 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7247 # operation.
7248 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7249 # of the target resource.
7250 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7251 # operations related to creating a snapshot, this points to the disk
7252 # that the snapshot was created from.
7253 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7254 # `[email protected]` or
7255 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7256 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7257 # operation, this field will be populated.
7258 {
7259 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7260 # Engine returns NO_RESULTS_ON_PAGE if there
7261 # are no results in the response.
7262 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7263 # value format. For example:
7264 #
7265 # &quot;data&quot;: [
7266 # {
7267 # &quot;key&quot;: &quot;scope&quot;,
7268 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7269 # }
7270 {
7271 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7272 # returned. For example, for warnings where there are no results in a list
7273 # request for a particular zone, this key might be scope and
7274 # the key value might be the zone name. Other examples might be a key
7275 # indicating a deprecated resource and a suggested replacement, or a
7276 # warning about invalid network settings (for example, if an instance
7277 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7278 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7279 },
7280 ],
7281 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7282 },
7283 ],
7284 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7285 # applicable when performing per-zone operations.
7286 }</pre>
7287 </div>
7288
7289 <div class="method">
7290 <code class="details" id="removeRule">removeRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code>
7291 <pre>Deletes a rule of the specified priority.
7292
7293 Args:
7294 firewallPolicy: string, Name of the firewall policy to update. (required)
7295 priority: integer, The priority of the rule to remove from the firewall policy.
7296 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7297 that if you must retry your request, the server will know to ignore the
7298 request if it has already been completed.
7299
7300 For example, consider a situation where you make an initial request and
7301 the request times out. If you make the request again with the same
7302 request ID, the server can check if original operation with the same
7303 request ID was received, and if so, will ignore the second request. This
7304 prevents clients from accidentally creating duplicate commitments.
7305
7306 The request ID must be
7307 a valid UUID with the exception that zero UUID is not supported
7308 (00000000-0000-0000-0000-000000000000).
7309 x__xgafv: string, V1 error format.
7310 Allowed values
7311 1 - v1 error format
7312 2 - v2 error format
7313
7314 Returns:
7315 An object of the form:
7316
7317 { # Represents an Operation resource.
7318 #
7319 # Google Compute Engine has three Operation resources:
7320 #
7321 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
7322 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
7323 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
7324 #
7325 # You can use an operation resource to manage asynchronous API requests.
7326 # For more information, readHandling
7327 # API responses.
7328 #
7329 # Operations can be global, regional or zonal.
7330 #
7331 # - For global operations, use the `globalOperations`
7332 # resource.
7333 # - For regional operations, use the
7334 # `regionOperations` resource.
7335 # - For zonal operations, use
7336 # the `zoneOperations` resource.
7337 #
7338 #
7339 #
7340 # For more information, read
7341 # Global, Regional, and Zonal Resources.
7342 #
7343 # Note that completed Operation resources have a limited
7344 # retention period.
7345 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7346 # Not present otherwise.
7347 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7348 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7349 # set when the operation is created.
7350 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7351 # text format.
7352 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7353 # this field will be populated.
7354 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7355 # operation.
7356 {
7357 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7358 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7359 # details. There is a set of defined message types to use for providing
7360 # details.The syntax depends on the error code. For example,
7361 # QuotaExceededInfo will have details when the error code is
7362 # QUOTA_EXCEEDED.
7363 {
7364 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7365 #
7366 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7367 # is not enabled:
7368 #
7369 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7370 # &quot;domain&quot;: &quot;googleapis.com&quot;
7371 # &quot;metadata&quot;: {
7372 # &quot;resource&quot;: &quot;projects/123&quot;,
7373 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7374 # }
7375 # }
7376 #
7377 # This response indicates that the pubsub.googleapis.com API is not enabled.
7378 #
7379 # Example of an error that is returned when attempting to create a Spanner
7380 # instance in a region that is out of stock:
7381 #
7382 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7383 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7384 # &quot;metadata&quot;: {
7385 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7386 # }
7387 # }
7388 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7389 # is typically the registered service name of the tool or product that
7390 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7391 # generated by some common infrastructure, the error domain must be a
7392 # globally unique value that identifies the infrastructure. For Google API
7393 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7394 &quot;metadatas&quot;: { # Additional structured details about this error.
7395 #
7396 # Keys must match a regular expression of `a-z+` but should
7397 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7398 # length. When identifying the current value of an exceeded limit, the units
7399 # should be contained in the key, not the value. For example, rather than
7400 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7401 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7402 # instances that can be created in a single (batch) request.
7403 &quot;a_key&quot;: &quot;A String&quot;,
7404 },
7405 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7406 # proximate cause of the error. Error reasons are unique within a particular
7407 # domain of errors. This should be at most 63 characters and match a
7408 # regular expression of `A-Z+[A-Z0-9]`, which represents
7409 # UPPER_SNAKE_CASE.
7410 },
7411 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7412 #
7413 # For example, if a quota check failed with an error indicating the calling
7414 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7415 # directly to the right place in the developer console to flip the bit.
7416 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7417 { # Describes a URL link.
7418 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7419 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7420 },
7421 ],
7422 },
7423 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7424 # which can be attached to an RPC error.
7425 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7426 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7427 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7428 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7429 },
7430 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7431 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7432 &quot;a_key&quot;: &quot;A String&quot;,
7433 },
7434 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7435 # type or metric.
7436 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7437 # or metric.
7438 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7439 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7440 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7441 },
7442 },
7443 ],
7444 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7445 # This property is optional.
7446 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7447 },
7448 ],
7449 },
7450 &quot;getVersionOperationMetadata&quot;: {
7451 &quot;inlineSbomInfo&quot;: {
7452 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7453 # appropriate identifiers.
7454 &quot;a_key&quot;: &quot;A String&quot;,
7455 },
7456 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7457 # identifiers.
7458 &quot;a_key&quot;: &quot;A String&quot;,
7459 },
7460 },
7461 },
7462 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7463 # message that was returned, such as `NOT FOUND`.
7464 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7465 # status code that was returned. For example, a `404` means the
7466 # resource was not found.
7467 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7468 # defined by the server.
7469 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7470 # This value is inRFC3339
7471 # text format.
7472 &quot;instancesBulkInsertOperationMetadata&quot;: {
7473 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7474 # Example key: zones/us-central1-a
7475 &quot;a_key&quot;: {
7476 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7477 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7478 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7479 # error.
7480 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7481 # if the flow is rolling forward or rolling back.
7482 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7483 },
7484 },
7485 },
7486 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7487 # Operation resources.
7488 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7489 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7490 # group of operations results from a `bulkInsert` API request.
7491 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7492 # `update`, or `delete`, and so on.
7493 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7494 # There is no requirement that this be linear or support any granularity of
7495 # operations. This should not be used to guess when the operation will be
7496 # complete. This number should monotonically increase as the operation
7497 # progresses.
7498 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7499 # applicable when performing regional operations.
7500 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7501 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7502 # this field will contain information on all underlying zonal actions and
7503 # their state.
7504 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7505 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7506 # Example key: zones/us-central1-a
7507 &quot;a_key&quot;: {
7508 &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
7509 # populated.
7510 # different programming environments, including REST APIs and RPC APIs. It is
7511 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7512 # three pieces of data: error code, error message, and error details.
7513 #
7514 # You can find out more about this error model and how to work with it in the
7515 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7516 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7517 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7518 # message types for APIs to use.
7519 {
7520 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7521 },
7522 ],
7523 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7524 # user-facing error message should be localized and sent in the
7525 # google.rpc.Status.details field, or localized by the client.
7526 },
7527 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7528 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7529 },
7530 },
7531 },
7532 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7533 # This value is inRFC3339
7534 # text format.
7535 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7536 # following:
7537 # `PENDING`, `RUNNING`, or `DONE`.
7538 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7539 # operation.
7540 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7541 # of the target resource.
7542 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7543 # operations related to creating a snapshot, this points to the disk
7544 # that the snapshot was created from.
7545 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7546 # `[email protected]` or
7547 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7548 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7549 # operation, this field will be populated.
7550 {
7551 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7552 # Engine returns NO_RESULTS_ON_PAGE if there
7553 # are no results in the response.
7554 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7555 # value format. For example:
7556 #
7557 # &quot;data&quot;: [
7558 # {
7559 # &quot;key&quot;: &quot;scope&quot;,
7560 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7561 # }
7562 {
7563 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7564 # returned. For example, for warnings where there are no results in a list
7565 # request for a particular zone, this key might be scope and
7566 # the key value might be the zone name. Other examples might be a key
7567 # indicating a deprecated resource and a suggested replacement, or a
7568 # warning about invalid network settings (for example, if an instance
7569 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7570 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7571 },
7572 ],
7573 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7574 },
7575 ],
7576 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7577 # applicable when performing per-zone operations.
7578 }</pre>
7579 </div>
7580
7581 <div class="method">
7582 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
7583 <pre>Sets the access control policy on the specified resource.
7584 Replaces any existing policy.
7585
7586 Args:
7587 resource: string, Name or id of the resource for this request. (required)
7588 body: object, The request body.
7589 The object takes the form of:
7590
7591 {
7592 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
7593 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
7594 { # Associates `members`, or principals, with a `role`.
7595 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
7596 #
7597 # If the condition evaluates to `true`, then this binding applies to the
7598 # current request.
7599 #
7600 # If the condition evaluates to `false`, then this binding does not apply to
7601 # the current request. However, a different role binding might grant the same
7602 # role to one or more of the principals in this binding.
7603 #
7604 # To learn which resources support conditions in their IAM policies, see the
7605 # [IAM
7606 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
7607 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
7608 # are documented at https://github.com/google/cel-spec.
7609 #
7610 # Example (Comparison):
7611 #
7612 # title: &quot;Summary size limit&quot;
7613 # description: &quot;Determines if a summary is less than 100 chars&quot;
7614 # expression: &quot;document.summary.size() &lt; 100&quot;
7615 #
7616 # Example (Equality):
7617 #
7618 # title: &quot;Requestor is owner&quot;
7619 # description: &quot;Determines if requestor is the document owner&quot;
7620 # expression: &quot;document.owner == request.auth.claims.email&quot;
7621 #
7622 # Example (Logic):
7623 #
7624 # title: &quot;Public documents&quot;
7625 # description: &quot;Determine whether the document should be publicly visible&quot;
7626 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
7627 #
7628 # Example (Data Manipulation):
7629 #
7630 # title: &quot;Notification string&quot;
7631 # description: &quot;Create a notification string with a timestamp.&quot;
7632 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
7633 #
7634 # The exact variables and functions that may be referenced within an expression
7635 # are determined by the service that evaluates it. See the service
7636 # documentation for additional information.
7637 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
7638 # describes the expression, e.g. when hovered over it in a UI.
7639 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
7640 # syntax.
7641 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
7642 # reporting, e.g. a file name and a position in the file.
7643 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
7644 # its purpose. This can be used e.g. in UIs which allow to enter the
7645 # expression.
7646 },
7647 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
7648 # `members` can have the following values:
7649 #
7650 # * `allUsers`: A special identifier that represents anyone who is
7651 # on the internet; with or without a Google account.
7652 #
7653 # * `allAuthenticatedUsers`: A special identifier that represents anyone
7654 # who is authenticated with a Google account or a service account.
7655 # Does not include identities that come from external identity providers
7656 # (IdPs) through identity federation.
7657 #
7658 # * `user:{emailid}`: An email address that represents a specific Google
7659 # account. For example, `[email protected]` .
7660 #
7661 #
7662 # * `serviceAccount:{emailid}`: An email address that represents a Google
7663 # service account. For example,
7664 # `[email protected]`.
7665 #
7666 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
7667 # identifier for a
7668 # [Kubernetes service
7669 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
7670 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
7671 #
7672 # * `group:{emailid}`: An email address that represents a Google group.
7673 # For example, `[email protected]`.
7674 #
7675 #
7676 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
7677 # users of that domain. For example, `google.com` or `example.com`.
7678 #
7679 #
7680 #
7681 #
7682 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
7683 # A single identity in a workforce identity pool.
7684 #
7685 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
7686 # All workforce identities in a group.
7687 #
7688 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
7689 # All workforce identities with a specific attribute value.
7690 #
7691 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
7692 # All identities in a workforce identity pool.
7693 #
7694 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
7695 # A single identity in a workload identity pool.
7696 #
7697 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
7698 # A workload identity pool group.
7699 #
7700 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
7701 # All identities in a workload identity pool with a certain attribute.
7702 #
7703 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
7704 # All identities in a workload identity pool.
7705 #
7706 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
7707 # identifier) representing a user that has been recently deleted. For
7708 # example, `[email protected]?uid=123456789012345678901`. If the user is
7709 # recovered, this value reverts to `user:{emailid}` and the recovered user
7710 # retains the role in the binding.
7711 #
7712 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
7713 # unique identifier) representing a service account that has been recently
7714 # deleted. For example,
7715 # `[email protected]?uid=123456789012345678901`.
7716 # If the service account is undeleted, this value reverts to
7717 # `serviceAccount:{emailid}` and the undeleted service account retains the
7718 # role in the binding.
7719 #
7720 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
7721 # identifier) representing a Google group that has been recently
7722 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
7723 # the group is recovered, this value reverts to `group:{emailid}` and the
7724 # recovered group retains the role in the binding.
7725 #
7726 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
7727 # Deleted single identity in a workforce identity pool. For example,
7728 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
7729 &quot;A String&quot;,
7730 ],
7731 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
7732 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
7733 #
7734 # For an overview of the IAM roles and permissions, see the
7735 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
7736 # a list of the available pre-defined roles, see
7737 # [here](https://cloud.google.com/iam/docs/understanding-roles).
7738 },
7739 ],
7740 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
7741 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
7742 &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
7743 # the policy is limited to a few 10s of KB. An empty policy is in general a
7744 # valid policy but certain services (like Projects) might reject them.
7745 # controls for Google Cloud resources.
7746 #
7747 #
7748 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
7749 # `members`, or principals, to a single `role`. Principals can be user
7750 # accounts, service accounts, Google groups, and domains (such as G Suite). A
7751 # `role` is a named list of permissions; each `role` can be an IAM predefined
7752 # role or a user-created custom role.
7753 #
7754 # For some types of Google Cloud resources, a `binding` can also specify a
7755 # `condition`, which is a logical expression that allows access to a resource
7756 # only if the expression evaluates to `true`. A condition can add constraints
7757 # based on attributes of the request, the resource, or both. To learn which
7758 # resources support conditions in their IAM policies, see the
7759 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
7760 #
7761 # **JSON example:**
7762 #
7763 # ```
7764 # {
7765 # &quot;bindings&quot;: [
7766 # {
7767 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
7768 # &quot;members&quot;: [
7769 # &quot;user:[email protected]&quot;,
7770 # &quot;group:[email protected]&quot;,
7771 # &quot;domain:google.com&quot;,
7772 # &quot;serviceAccount:[email protected]&quot;
7773 # ]
7774 # },
7775 # {
7776 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
7777 # &quot;members&quot;: [
7778 # &quot;user:[email protected]&quot;
7779 # ],
7780 # &quot;condition&quot;: {
7781 # &quot;title&quot;: &quot;expirable access&quot;,
7782 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
7783 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
7784 # }
7785 # }
7786 # ],
7787 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
7788 # &quot;version&quot;: 3
7789 # }
7790 # ```
7791 #
7792 # **YAML example:**
7793 #
7794 # ```
7795 # bindings:
7796 # - members:
7797 # - user:[email protected]
7798 # - group:[email protected]
7799 # - domain:google.com
7800 # - serviceAccount:[email protected]
7801 # role: roles/resourcemanager.organizationAdmin
7802 # - members:
7803 # - user:[email protected]
7804 # role: roles/resourcemanager.organizationViewer
7805 # condition:
7806 # title: expirable access
7807 # description: Does not grant access after Sep 2020
7808 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
7809 # etag: BwWWja0YfJA=
7810 # version: 3
7811 # ```
7812 #
7813 # For a description of IAM and its features, see the
7814 # [IAM documentation](https://cloud.google.com/iam/docs/).
7815 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
7816 { # Specifies the audit configuration for a service.
7817 # The configuration determines which permission types are logged, and what
7818 # identities, if any, are exempted from logging.
7819 # An AuditConfig must have one or more AuditLogConfigs.
7820 #
7821 # If there are AuditConfigs for both `allServices` and a specific service,
7822 # the union of the two AuditConfigs is used for that service: the log_types
7823 # specified in each AuditConfig are enabled, and the exempted_members in each
7824 # AuditLogConfig are exempted.
7825 #
7826 # Example Policy with multiple AuditConfigs:
7827 #
7828 # {
7829 # &quot;audit_configs&quot;: [
7830 # {
7831 # &quot;service&quot;: &quot;allServices&quot;,
7832 # &quot;audit_log_configs&quot;: [
7833 # {
7834 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
7835 # &quot;exempted_members&quot;: [
7836 # &quot;user:[email protected]&quot;
7837 # ]
7838 # },
7839 # {
7840 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
7841 # },
7842 # {
7843 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
7844 # }
7845 # ]
7846 # },
7847 # {
7848 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
7849 # &quot;audit_log_configs&quot;: [
7850 # {
7851 # &quot;log_type&quot;: &quot;DATA_READ&quot;
7852 # },
7853 # {
7854 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
7855 # &quot;exempted_members&quot;: [
7856 # &quot;user:[email protected]&quot;
7857 # ]
7858 # }
7859 # ]
7860 # }
7861 # ]
7862 # }
7863 #
7864 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
7865 # logging. It also exempts `[email protected]` from DATA_READ logging, and
7866 # `[email protected]` from DATA_WRITE logging.
7867 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
7868 { # Provides the configuration for logging a type of permissions.
7869 # Example:
7870 #
7871 # {
7872 # &quot;audit_log_configs&quot;: [
7873 # {
7874 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
7875 # &quot;exempted_members&quot;: [
7876 # &quot;user:[email protected]&quot;
7877 # ]
7878 # },
7879 # {
7880 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
7881 # }
7882 # ]
7883 # }
7884 #
7885 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
7886 # [email protected] from DATA_READ logging.
7887 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
7888 # permission.
7889 # Follows the same format of Binding.members.
7890 &quot;A String&quot;,
7891 ],
7892 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
7893 },
7894 ],
7895 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
7896 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
7897 # `allServices` is a special value that covers all services.
7898 },
7899 ],
7900 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
7901 # may specify a `condition` that determines how and when the `bindings` are
7902 # applied. Each of the `bindings` must contain at least one principal.
7903 #
7904 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
7905 # of these principals can be Google groups. Each occurrence of a principal
7906 # counts towards these limits. For example, if the `bindings` grant 50
7907 # different roles to `user:[email protected]`, and not to any other
7908 # principal, then you can add another 1,450 principals to the `bindings` in
7909 # the `Policy`.
7910 { # Associates `members`, or principals, with a `role`.
7911 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
7912 #
7913 # If the condition evaluates to `true`, then this binding applies to the
7914 # current request.
7915 #
7916 # If the condition evaluates to `false`, then this binding does not apply to
7917 # the current request. However, a different role binding might grant the same
7918 # role to one or more of the principals in this binding.
7919 #
7920 # To learn which resources support conditions in their IAM policies, see the
7921 # [IAM
7922 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
7923 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
7924 # are documented at https://github.com/google/cel-spec.
7925 #
7926 # Example (Comparison):
7927 #
7928 # title: &quot;Summary size limit&quot;
7929 # description: &quot;Determines if a summary is less than 100 chars&quot;
7930 # expression: &quot;document.summary.size() &lt; 100&quot;
7931 #
7932 # Example (Equality):
7933 #
7934 # title: &quot;Requestor is owner&quot;
7935 # description: &quot;Determines if requestor is the document owner&quot;
7936 # expression: &quot;document.owner == request.auth.claims.email&quot;
7937 #
7938 # Example (Logic):
7939 #
7940 # title: &quot;Public documents&quot;
7941 # description: &quot;Determine whether the document should be publicly visible&quot;
7942 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
7943 #
7944 # Example (Data Manipulation):
7945 #
7946 # title: &quot;Notification string&quot;
7947 # description: &quot;Create a notification string with a timestamp.&quot;
7948 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
7949 #
7950 # The exact variables and functions that may be referenced within an expression
7951 # are determined by the service that evaluates it. See the service
7952 # documentation for additional information.
7953 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
7954 # describes the expression, e.g. when hovered over it in a UI.
7955 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
7956 # syntax.
7957 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
7958 # reporting, e.g. a file name and a position in the file.
7959 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
7960 # its purpose. This can be used e.g. in UIs which allow to enter the
7961 # expression.
7962 },
7963 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
7964 # `members` can have the following values:
7965 #
7966 # * `allUsers`: A special identifier that represents anyone who is
7967 # on the internet; with or without a Google account.
7968 #
7969 # * `allAuthenticatedUsers`: A special identifier that represents anyone
7970 # who is authenticated with a Google account or a service account.
7971 # Does not include identities that come from external identity providers
7972 # (IdPs) through identity federation.
7973 #
7974 # * `user:{emailid}`: An email address that represents a specific Google
7975 # account. For example, `[email protected]` .
7976 #
7977 #
7978 # * `serviceAccount:{emailid}`: An email address that represents a Google
7979 # service account. For example,
7980 # `[email protected]`.
7981 #
7982 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
7983 # identifier for a
7984 # [Kubernetes service
7985 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
7986 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
7987 #
7988 # * `group:{emailid}`: An email address that represents a Google group.
7989 # For example, `[email protected]`.
7990 #
7991 #
7992 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
7993 # users of that domain. For example, `google.com` or `example.com`.
7994 #
7995 #
7996 #
7997 #
7998 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
7999 # A single identity in a workforce identity pool.
8000 #
8001 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8002 # All workforce identities in a group.
8003 #
8004 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8005 # All workforce identities with a specific attribute value.
8006 #
8007 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8008 # All identities in a workforce identity pool.
8009 #
8010 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8011 # A single identity in a workload identity pool.
8012 #
8013 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8014 # A workload identity pool group.
8015 #
8016 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8017 # All identities in a workload identity pool with a certain attribute.
8018 #
8019 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8020 # All identities in a workload identity pool.
8021 #
8022 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8023 # identifier) representing a user that has been recently deleted. For
8024 # example, `[email protected]?uid=123456789012345678901`. If the user is
8025 # recovered, this value reverts to `user:{emailid}` and the recovered user
8026 # retains the role in the binding.
8027 #
8028 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8029 # unique identifier) representing a service account that has been recently
8030 # deleted. For example,
8031 # `[email protected]?uid=123456789012345678901`.
8032 # If the service account is undeleted, this value reverts to
8033 # `serviceAccount:{emailid}` and the undeleted service account retains the
8034 # role in the binding.
8035 #
8036 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8037 # identifier) representing a Google group that has been recently
8038 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8039 # the group is recovered, this value reverts to `group:{emailid}` and the
8040 # recovered group retains the role in the binding.
8041 #
8042 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8043 # Deleted single identity in a workforce identity pool. For example,
8044 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8045 &quot;A String&quot;,
8046 ],
8047 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8048 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8049 #
8050 # For an overview of the IAM roles and permissions, see the
8051 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8052 # a list of the available pre-defined roles, see
8053 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8054 },
8055 ],
8056 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8057 # prevent simultaneous updates of a policy from overwriting each other.
8058 # It is strongly suggested that systems make use of the `etag` in the
8059 # read-modify-write cycle to perform policy updates in order to avoid race
8060 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8061 # systems are expected to put that etag in the request to `setIamPolicy` to
8062 # ensure that their change will be applied to the same version of the policy.
8063 #
8064 # **Important:** If you use IAM Conditions, you must include the `etag` field
8065 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8066 # you to overwrite a version `3` policy with a version `1` policy, and all of
8067 # the conditions in the version `3` policy are lost.
8068 &quot;version&quot;: 42, # Specifies the format of the policy.
8069 #
8070 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8071 # are rejected.
8072 #
8073 # Any operation that affects conditional role bindings must specify version
8074 # `3`. This requirement applies to the following operations:
8075 #
8076 # * Getting a policy that includes a conditional role binding
8077 # * Adding a conditional role binding to a policy
8078 # * Changing a conditional role binding in a policy
8079 # * Removing any role binding, with or without a condition, from a policy
8080 # that includes conditions
8081 #
8082 # **Important:** If you use IAM Conditions, you must include the `etag` field
8083 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8084 # you to overwrite a version `3` policy with a version `1` policy, and all of
8085 # the conditions in the version `3` policy are lost.
8086 #
8087 # If a policy does not include any conditions, operations on that policy may
8088 # specify any valid version or leave the field unset.
8089 #
8090 # To learn which resources support conditions in their IAM policies, see the
8091 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8092 },
8093 }
8094
8095 x__xgafv: string, V1 error format.
8096 Allowed values
8097 1 - v1 error format
8098 2 - v2 error format
8099
8100 Returns:
8101 An object of the form:
8102
8103 { # An Identity and Access Management (IAM) policy, which specifies access
8104 # controls for Google Cloud resources.
8105 #
8106 #
8107 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8108 # `members`, or principals, to a single `role`. Principals can be user
8109 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8110 # `role` is a named list of permissions; each `role` can be an IAM predefined
8111 # role or a user-created custom role.
8112 #
8113 # For some types of Google Cloud resources, a `binding` can also specify a
8114 # `condition`, which is a logical expression that allows access to a resource
8115 # only if the expression evaluates to `true`. A condition can add constraints
8116 # based on attributes of the request, the resource, or both. To learn which
8117 # resources support conditions in their IAM policies, see the
8118 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8119 #
8120 # **JSON example:**
8121 #
8122 # ```
8123 # {
8124 # &quot;bindings&quot;: [
8125 # {
8126 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8127 # &quot;members&quot;: [
8128 # &quot;user:[email protected]&quot;,
8129 # &quot;group:[email protected]&quot;,
8130 # &quot;domain:google.com&quot;,
8131 # &quot;serviceAccount:[email protected]&quot;
8132 # ]
8133 # },
8134 # {
8135 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8136 # &quot;members&quot;: [
8137 # &quot;user:[email protected]&quot;
8138 # ],
8139 # &quot;condition&quot;: {
8140 # &quot;title&quot;: &quot;expirable access&quot;,
8141 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8142 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8143 # }
8144 # }
8145 # ],
8146 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8147 # &quot;version&quot;: 3
8148 # }
8149 # ```
8150 #
8151 # **YAML example:**
8152 #
8153 # ```
8154 # bindings:
8155 # - members:
8156 # - user:[email protected]
8157 # - group:[email protected]
8158 # - domain:google.com
8159 # - serviceAccount:[email protected]
8160 # role: roles/resourcemanager.organizationAdmin
8161 # - members:
8162 # - user:[email protected]
8163 # role: roles/resourcemanager.organizationViewer
8164 # condition:
8165 # title: expirable access
8166 # description: Does not grant access after Sep 2020
8167 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8168 # etag: BwWWja0YfJA=
8169 # version: 3
8170 # ```
8171 #
8172 # For a description of IAM and its features, see the
8173 # [IAM documentation](https://cloud.google.com/iam/docs/).
8174 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8175 { # Specifies the audit configuration for a service.
8176 # The configuration determines which permission types are logged, and what
8177 # identities, if any, are exempted from logging.
8178 # An AuditConfig must have one or more AuditLogConfigs.
8179 #
8180 # If there are AuditConfigs for both `allServices` and a specific service,
8181 # the union of the two AuditConfigs is used for that service: the log_types
8182 # specified in each AuditConfig are enabled, and the exempted_members in each
8183 # AuditLogConfig are exempted.
8184 #
8185 # Example Policy with multiple AuditConfigs:
8186 #
8187 # {
8188 # &quot;audit_configs&quot;: [
8189 # {
8190 # &quot;service&quot;: &quot;allServices&quot;,
8191 # &quot;audit_log_configs&quot;: [
8192 # {
8193 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8194 # &quot;exempted_members&quot;: [
8195 # &quot;user:[email protected]&quot;
8196 # ]
8197 # },
8198 # {
8199 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8200 # },
8201 # {
8202 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8203 # }
8204 # ]
8205 # },
8206 # {
8207 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8208 # &quot;audit_log_configs&quot;: [
8209 # {
8210 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8211 # },
8212 # {
8213 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8214 # &quot;exempted_members&quot;: [
8215 # &quot;user:[email protected]&quot;
8216 # ]
8217 # }
8218 # ]
8219 # }
8220 # ]
8221 # }
8222 #
8223 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8224 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8225 # `[email protected]` from DATA_WRITE logging.
8226 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8227 { # Provides the configuration for logging a type of permissions.
8228 # Example:
8229 #
8230 # {
8231 # &quot;audit_log_configs&quot;: [
8232 # {
8233 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8234 # &quot;exempted_members&quot;: [
8235 # &quot;user:[email protected]&quot;
8236 # ]
8237 # },
8238 # {
8239 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8240 # }
8241 # ]
8242 # }
8243 #
8244 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8245 # [email protected] from DATA_READ logging.
8246 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8247 # permission.
8248 # Follows the same format of Binding.members.
8249 &quot;A String&quot;,
8250 ],
8251 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8252 },
8253 ],
8254 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8255 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8256 # `allServices` is a special value that covers all services.
8257 },
8258 ],
8259 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8260 # may specify a `condition` that determines how and when the `bindings` are
8261 # applied. Each of the `bindings` must contain at least one principal.
8262 #
8263 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8264 # of these principals can be Google groups. Each occurrence of a principal
8265 # counts towards these limits. For example, if the `bindings` grant 50
8266 # different roles to `user:[email protected]`, and not to any other
8267 # principal, then you can add another 1,450 principals to the `bindings` in
8268 # the `Policy`.
8269 { # Associates `members`, or principals, with a `role`.
8270 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8271 #
8272 # If the condition evaluates to `true`, then this binding applies to the
8273 # current request.
8274 #
8275 # If the condition evaluates to `false`, then this binding does not apply to
8276 # the current request. However, a different role binding might grant the same
8277 # role to one or more of the principals in this binding.
8278 #
8279 # To learn which resources support conditions in their IAM policies, see the
8280 # [IAM
8281 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8282 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8283 # are documented at https://github.com/google/cel-spec.
8284 #
8285 # Example (Comparison):
8286 #
8287 # title: &quot;Summary size limit&quot;
8288 # description: &quot;Determines if a summary is less than 100 chars&quot;
8289 # expression: &quot;document.summary.size() &lt; 100&quot;
8290 #
8291 # Example (Equality):
8292 #
8293 # title: &quot;Requestor is owner&quot;
8294 # description: &quot;Determines if requestor is the document owner&quot;
8295 # expression: &quot;document.owner == request.auth.claims.email&quot;
8296 #
8297 # Example (Logic):
8298 #
8299 # title: &quot;Public documents&quot;
8300 # description: &quot;Determine whether the document should be publicly visible&quot;
8301 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8302 #
8303 # Example (Data Manipulation):
8304 #
8305 # title: &quot;Notification string&quot;
8306 # description: &quot;Create a notification string with a timestamp.&quot;
8307 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8308 #
8309 # The exact variables and functions that may be referenced within an expression
8310 # are determined by the service that evaluates it. See the service
8311 # documentation for additional information.
8312 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8313 # describes the expression, e.g. when hovered over it in a UI.
8314 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8315 # syntax.
8316 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8317 # reporting, e.g. a file name and a position in the file.
8318 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8319 # its purpose. This can be used e.g. in UIs which allow to enter the
8320 # expression.
8321 },
8322 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8323 # `members` can have the following values:
8324 #
8325 # * `allUsers`: A special identifier that represents anyone who is
8326 # on the internet; with or without a Google account.
8327 #
8328 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8329 # who is authenticated with a Google account or a service account.
8330 # Does not include identities that come from external identity providers
8331 # (IdPs) through identity federation.
8332 #
8333 # * `user:{emailid}`: An email address that represents a specific Google
8334 # account. For example, `[email protected]` .
8335 #
8336 #
8337 # * `serviceAccount:{emailid}`: An email address that represents a Google
8338 # service account. For example,
8339 # `[email protected]`.
8340 #
8341 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8342 # identifier for a
8343 # [Kubernetes service
8344 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8345 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8346 #
8347 # * `group:{emailid}`: An email address that represents a Google group.
8348 # For example, `[email protected]`.
8349 #
8350 #
8351 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8352 # users of that domain. For example, `google.com` or `example.com`.
8353 #
8354 #
8355 #
8356 #
8357 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8358 # A single identity in a workforce identity pool.
8359 #
8360 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8361 # All workforce identities in a group.
8362 #
8363 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8364 # All workforce identities with a specific attribute value.
8365 #
8366 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8367 # All identities in a workforce identity pool.
8368 #
8369 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8370 # A single identity in a workload identity pool.
8371 #
8372 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8373 # A workload identity pool group.
8374 #
8375 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8376 # All identities in a workload identity pool with a certain attribute.
8377 #
8378 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8379 # All identities in a workload identity pool.
8380 #
8381 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8382 # identifier) representing a user that has been recently deleted. For
8383 # example, `[email protected]?uid=123456789012345678901`. If the user is
8384 # recovered, this value reverts to `user:{emailid}` and the recovered user
8385 # retains the role in the binding.
8386 #
8387 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8388 # unique identifier) representing a service account that has been recently
8389 # deleted. For example,
8390 # `[email protected]?uid=123456789012345678901`.
8391 # If the service account is undeleted, this value reverts to
8392 # `serviceAccount:{emailid}` and the undeleted service account retains the
8393 # role in the binding.
8394 #
8395 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8396 # identifier) representing a Google group that has been recently
8397 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8398 # the group is recovered, this value reverts to `group:{emailid}` and the
8399 # recovered group retains the role in the binding.
8400 #
8401 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8402 # Deleted single identity in a workforce identity pool. For example,
8403 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8404 &quot;A String&quot;,
8405 ],
8406 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8407 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8408 #
8409 # For an overview of the IAM roles and permissions, see the
8410 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8411 # a list of the available pre-defined roles, see
8412 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8413 },
8414 ],
8415 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8416 # prevent simultaneous updates of a policy from overwriting each other.
8417 # It is strongly suggested that systems make use of the `etag` in the
8418 # read-modify-write cycle to perform policy updates in order to avoid race
8419 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8420 # systems are expected to put that etag in the request to `setIamPolicy` to
8421 # ensure that their change will be applied to the same version of the policy.
8422 #
8423 # **Important:** If you use IAM Conditions, you must include the `etag` field
8424 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8425 # you to overwrite a version `3` policy with a version `1` policy, and all of
8426 # the conditions in the version `3` policy are lost.
8427 &quot;version&quot;: 42, # Specifies the format of the policy.
8428 #
8429 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8430 # are rejected.
8431 #
8432 # Any operation that affects conditional role bindings must specify version
8433 # `3`. This requirement applies to the following operations:
8434 #
8435 # * Getting a policy that includes a conditional role binding
8436 # * Adding a conditional role binding to a policy
8437 # * Changing a conditional role binding in a policy
8438 # * Removing any role binding, with or without a condition, from a policy
8439 # that includes conditions
8440 #
8441 # **Important:** If you use IAM Conditions, you must include the `etag` field
8442 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8443 # you to overwrite a version `3` policy with a version `1` policy, and all of
8444 # the conditions in the version `3` policy are lost.
8445 #
8446 # If a policy does not include any conditions, operations on that policy may
8447 # specify any valid version or leave the field unset.
8448 #
8449 # To learn which resources support conditions in their IAM policies, see the
8450 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8451 }</pre>
8452 </div>
8453
8454 <div class="method">
8455 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
8456 <pre>Returns permissions that a caller has on the specified resource.
8457
8458 Args:
8459 resource: string, Name or id of the resource for this request. (required)
8460 body: object, The request body.
8461 The object takes the form of:
8462
8463 {
8464 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
8465 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
8466 &quot;A String&quot;,
8467 ],
8468 }
8469
8470 x__xgafv: string, V1 error format.
8471 Allowed values
8472 1 - v1 error format
8473 2 - v2 error format
8474
8475 Returns:
8476 An object of the form:
8477
8478 {
8479 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
8480 # allowed.
8481 &quot;A String&quot;,
8482 ],
8483 }</pre>
8484 </div>
8485
8486 </body></html>