Debian Codegraph @

docs/dyn/compute_alpha.networkFirewallPolicies.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.networkFirewallPolicies.html">networkFirewallPolicies</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addAssociation">addAssociation(project, firewallPolicy, associatedPolicyToBeReplaced=None, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Inserts an association for the specified firewall policy.</p>
80 <p class="toc_element">
81 <code><a href="#addPacketMirroringRule">addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Inserts a packet mirroring rule into a firewall policy.</p>
83 <p class="toc_element">
84 <code><a href="#addRule">addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Inserts a rule into a firewall policy.</p>
86 <p class="toc_element">
87 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves an aggregated list of network firewall policies, listing network</p>
89 <p class="toc_element">
90 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#cloneRules">cloneRules(project, firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Copies rules to the specified firewall policy.</p>
95 <p class="toc_element">
96 <code><a href="#close">close()</a></code></p>
97 <p class="firstline">Close httplib2 connections.</p>
98 <p class="toc_element">
99 <code><a href="#delete">delete(project, firewallPolicy, requestId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Deletes the specified policy.</p>
101 <p class="toc_element">
102 <code><a href="#get">get(project, firewallPolicy, x__xgafv=None)</a></code></p>
103 <p class="firstline">Returns the specified network firewall policy.</p>
104 <p class="toc_element">
105 <code><a href="#getAssociation">getAssociation(project, firewallPolicy, name=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Gets an association with the specified name.</p>
107 <p class="toc_element">
108 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
110 <p class="toc_element">
111 <code><a href="#getPacketMirroringRule">getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Gets a packet mirroring rule of the specified priority.</p>
113 <p class="toc_element">
114 <code><a href="#getRule">getRule(project, firewallPolicy, priority=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Gets a rule of the specified priority.</p>
116 <p class="toc_element">
117 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Creates a new policy in the specified project using the data included in</p>
119 <p class="toc_element">
120 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Lists all the policies that have been configured for the specified project.</p>
122 <p class="toc_element">
123 <code><a href="#list_next">list_next()</a></code></p>
124 <p class="firstline">Retrieves the next page of results.</p>
125 <p class="toc_element">
126 <code><a href="#patch">patch(project, firewallPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Patches the specified policy with the data included in the request.</p>
128 <p class="toc_element">
129 <code><a href="#patchAssociation">patchAssociation(project, firewallPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Updates an association for the specified network firewall policy.</p>
131 <p class="toc_element">
132 <code><a href="#patchPacketMirroringRule">patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</a></code></p>
133 <p class="firstline">Patches a packet mirroring rule of the specified priority.</p>
134 <p class="toc_element">
135 <code><a href="#patchRule">patchRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Patches a rule of the specified priority.</p>
137 <p class="toc_element">
138 <code><a href="#removeAssociation">removeAssociation(project, firewallPolicy, name=None, requestId=None, x__xgafv=None)</a></code></p>
139 <p class="firstline">Removes an association for the specified firewall policy.</p>
140 <p class="toc_element">
141 <code><a href="#removePacketMirroringRule">removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</a></code></p>
142 <p class="firstline">Deletes a packet mirroring rule of the specified priority.</p>
143 <p class="toc_element">
144 <code><a href="#removeRule">removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Deletes a rule of the specified priority.</p>
146 <p class="toc_element">
147 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
148 <p class="firstline">Sets the access control policy on the specified resource.</p>
149 <p class="toc_element">
150 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
151 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
152 <h3>Method Details</h3>
153 <div class="method">
154 <code class="details" id="addAssociation">addAssociation(project, firewallPolicy, associatedPolicyToBeReplaced=None, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</code>
155 <pre>Inserts an association for the specified firewall policy.
156
157 Args:
158 project: string, Project ID for this request. (required)
159 firewallPolicy: string, Name of the firewall policy to update. (required)
160 body: object, The request body.
161 The object takes the form of:
162
163 {
164 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
165 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
166 # of the firewall policy of the association.
167 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
168 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
169 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
170 # must be a positive value between 1 and 2147483647.
171 # Firewall Policies are evaluated from highest to lowest priority where 1
172 # is the highest priority and 2147483647 is the lowest priority.
173 # The default value is `1000`. If two associations have the same priority
174 # then lexicographical order on association names is applied.
175 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
176 }
177
178 associatedPolicyToBeReplaced: string, Name of the firewall policy associated with the target network to swap
179 association with. This field is mutually exclusive with
180 &#x27;replace_existing_association&#x27;.
181 replaceExistingAssociation: boolean, Indicates whether or not to replace it if an association of the attachment
182 already exists. This is false by default, in which case an error will be
183 returned if an association already exists.
184 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
185 that if you must retry your request, the server will know to ignore the
186 request if it has already been completed.
187
188 For example, consider a situation where you make an initial request and
189 the request times out. If you make the request again with the same
190 request ID, the server can check if original operation with the same
191 request ID was received, and if so, will ignore the second request. This
192 prevents clients from accidentally creating duplicate commitments.
193
194 The request ID must be
195 a valid UUID with the exception that zero UUID is not supported
196 (00000000-0000-0000-0000-000000000000).
197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
201
202 Returns:
203 An object of the form:
204
205 { # Represents an Operation resource.
206 #
207 # Google Compute Engine has three Operation resources:
208 #
209 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
210 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
211 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
212 #
213 # You can use an operation resource to manage asynchronous API requests.
214 # For more information, readHandling
215 # API responses.
216 #
217 # Operations can be global, regional or zonal.
218 #
219 # - For global operations, use the `globalOperations`
220 # resource.
221 # - For regional operations, use the
222 # `regionOperations` resource.
223 # - For zonal operations, use
224 # the `zoneOperations` resource.
225 #
226 #
227 #
228 # For more information, read
229 # Global, Regional, and Zonal Resources.
230 #
231 # Note that completed Operation resources have a limited
232 # retention period.
233 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
234 # Not present otherwise.
235 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
236 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
237 # set when the operation is created.
238 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
239 # text format.
240 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
241 # this field will be populated.
242 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
243 # operation.
244 {
245 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
246 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
247 # details. There is a set of defined message types to use for providing
248 # details.The syntax depends on the error code. For example,
249 # QuotaExceededInfo will have details when the error code is
250 # QUOTA_EXCEEDED.
251 {
252 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
253 #
254 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
255 # is not enabled:
256 #
257 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
258 # &quot;domain&quot;: &quot;googleapis.com&quot;
259 # &quot;metadata&quot;: {
260 # &quot;resource&quot;: &quot;projects/123&quot;,
261 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
262 # }
263 # }
264 #
265 # This response indicates that the pubsub.googleapis.com API is not enabled.
266 #
267 # Example of an error that is returned when attempting to create a Spanner
268 # instance in a region that is out of stock:
269 #
270 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
271 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
272 # &quot;metadata&quot;: {
273 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
274 # }
275 # }
276 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
277 # is typically the registered service name of the tool or product that
278 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
279 # generated by some common infrastructure, the error domain must be a
280 # globally unique value that identifies the infrastructure. For Google API
281 # infrastructure, the error domain is &quot;googleapis.com&quot;.
282 &quot;metadatas&quot;: { # Additional structured details about this error.
283 #
284 # Keys must match a regular expression of `a-z+` but should
285 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
286 # length. When identifying the current value of an exceeded limit, the units
287 # should be contained in the key, not the value. For example, rather than
288 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
289 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
290 # instances that can be created in a single (batch) request.
291 &quot;a_key&quot;: &quot;A String&quot;,
292 },
293 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
294 # proximate cause of the error. Error reasons are unique within a particular
295 # domain of errors. This should be at most 63 characters and match a
296 # regular expression of `A-Z+[A-Z0-9]`, which represents
297 # UPPER_SNAKE_CASE.
298 },
299 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
300 #
301 # For example, if a quota check failed with an error indicating the calling
302 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
303 # directly to the right place in the developer console to flip the bit.
304 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
305 { # Describes a URL link.
306 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
307 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
308 },
309 ],
310 },
311 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
312 # which can be attached to an RPC error.
313 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
314 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
315 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
316 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
317 },
318 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
319 &quot;dimensions&quot;: { # The map holding related quota dimensions.
320 &quot;a_key&quot;: &quot;A String&quot;,
321 },
322 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
323 # type or metric.
324 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
325 # or metric.
326 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
327 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
328 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
329 },
330 },
331 ],
332 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
333 # This property is optional.
334 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
335 },
336 ],
337 },
338 &quot;getVersionOperationMetadata&quot;: {
339 &quot;inlineSbomInfo&quot;: {
340 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
341 # appropriate identifiers.
342 &quot;a_key&quot;: &quot;A String&quot;,
343 },
344 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
345 # identifiers.
346 &quot;a_key&quot;: &quot;A String&quot;,
347 },
348 },
349 },
350 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
351 # message that was returned, such as `NOT FOUND`.
352 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
353 # status code that was returned. For example, a `404` means the
354 # resource was not found.
355 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
356 # defined by the server.
357 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
358 # This value is inRFC3339
359 # text format.
360 &quot;instancesBulkInsertOperationMetadata&quot;: {
361 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
362 # Example key: zones/us-central1-a
363 &quot;a_key&quot;: {
364 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
365 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
366 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
367 # error.
368 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
369 # if the flow is rolling forward or rolling back.
370 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
371 },
372 },
373 },
374 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
375 # Operation resources.
376 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
377 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
378 # group of operations results from a `bulkInsert` API request.
379 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
380 # `update`, or `delete`, and so on.
381 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
382 # There is no requirement that this be linear or support any granularity of
383 # operations. This should not be used to guess when the operation will be
384 # complete. This number should monotonically increase as the operation
385 # progresses.
386 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
387 # applicable when performing regional operations.
388 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
389 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
390 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
391 # this field will contain information on all underlying zonal actions and
392 # their state.
393 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
394 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
395 # Example key: zones/us-central1-a
396 &quot;a_key&quot;: {
397 &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
398 # populated.
399 # different programming environments, including REST APIs and RPC APIs. It is
400 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
401 # three pieces of data: error code, error message, and error details.
402 #
403 # You can find out more about this error model and how to work with it in the
404 # [API Design Guide](https://cloud.google.com/apis/design/errors).
405 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
406 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
407 # message types for APIs to use.
408 {
409 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
410 },
411 ],
412 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
413 # user-facing error message should be localized and sent in the
414 # google.rpc.Status.details field, or localized by the client.
415 },
416 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
417 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
418 },
419 },
420 },
421 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
422 # This value is inRFC3339
423 # text format.
424 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
425 # following:
426 # `PENDING`, `RUNNING`, or `DONE`.
427 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
428 # operation.
429 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
430 # of the target resource.
431 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
432 # operations related to creating a snapshot, this points to the disk
433 # that the snapshot was created from.
434 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
435 # `[email protected]` or
436 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
437 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
438 # operation, this field will be populated.
439 {
440 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
441 # Engine returns NO_RESULTS_ON_PAGE if there
442 # are no results in the response.
443 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
444 # value format. For example:
445 #
446 # &quot;data&quot;: [
447 # {
448 # &quot;key&quot;: &quot;scope&quot;,
449 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
450 # }
451 {
452 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
453 # returned. For example, for warnings where there are no results in a list
454 # request for a particular zone, this key might be scope and
455 # the key value might be the zone name. Other examples might be a key
456 # indicating a deprecated resource and a suggested replacement, or a
457 # warning about invalid network settings (for example, if an instance
458 # attempts to perform IP forwarding but is not enabled for IP forwarding).
459 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
460 },
461 ],
462 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
463 },
464 ],
465 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
466 # applicable when performing per-zone operations.
467 }</pre>
468 </div>
469
470 <div class="method">
471 <code class="details" id="addPacketMirroringRule">addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</code>
472 <pre>Inserts a packet mirroring rule into a firewall policy.
473
474 Args:
475 project: string, Project ID for this request. (required)
476 firewallPolicy: string, Name of the firewall policy to update. (required)
477 body: object, The request body.
478 The object takes the form of:
479
480 { # Represents a rule that describes one or more match conditions along with
481 # the action to be taken when traffic matches this condition (allow or deny).
482 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
483 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
484 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
485 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
486 # and &quot;goto_next&quot;.
487 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
488 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
489 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
490 # the firewall policy rule is not enforced and traffic behaves as if it did
491 # not exist. If this is unspecified, the firewall policy rule will be
492 # enabled.
493 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
494 # enabled, logs will be exported to the configured export destination in
495 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
496 # cannot enable logging on &quot;goto_next&quot; rules.
497 &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.
498 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
499 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
500 # Exactly one field must be specified.
501 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
502 # Maximum number of destination address groups is 10.
503 &quot;A String&quot;,
504 ],
505 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
506 # traffic destination.
507 # Maximum number of destination fqdn allowed is 100.
508 &quot;A String&quot;,
509 ],
510 &quot;destIpRanges&quot;: [ # CIDR IP address range.
511 # Maximum number of destination CIDR IP ranges allowed is 5000.
512 &quot;A String&quot;,
513 ],
514 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
515 #
516 #
517 # - UNSPECIFIED
518 # - INTERNET
519 # - NON_INTERNET
520 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
521 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
522 #
523 #
524 # - UNSPECIFIED
525 # - INTERNET
526 # - NON_INTERNET
527 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
528 # of traffic. Should be specified as 2 letter country code defined as per
529 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
530 # Maximum number of dest region codes allowed is 5000.
531 &quot;A String&quot;,
532 ],
533 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
534 # The IPs in these lists will be matched against traffic destination.
535 &quot;A String&quot;,
536 ],
537 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
538 {
539 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
540 # required when creating a firewall rule. This value can either be
541 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
542 # protocol number.
543 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
544 # only applicable for UDP or TCP protocol. Each entry must be either
545 # an integer or a range. If not specified, this rule applies to
546 # connections through any port.
547 #
548 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
549 &quot;A String&quot;,
550 ],
551 },
552 ],
553 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
554 # Maximum number of source address groups is 10.
555 &quot;A String&quot;,
556 ],
557 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
558 # traffic source.
559 # Maximum number of source fqdn allowed is 100.
560 &quot;A String&quot;,
561 ],
562 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
563 # Maximum number of source CIDR IP ranges allowed is 5000.
564 &quot;A String&quot;,
565 ],
566 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
567 #
568 #
569 # - UNSPECIFIED
570 # - INTERNET
571 # - INTRA_VPC
572 # - NON_INTERNET
573 # - VPC_NETWORKS
574 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
575 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
576 #
577 #
578 # - UNSPECIFIED
579 # - INTERNET
580 # - INTRA_VPC
581 # - NON_INTERNET
582 # - VPC_NETWORKS
583 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
584 &quot;A String&quot;,
585 ],
586 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
587 # of traffic. Should be specified as 2 letter country code defined as per
588 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
589 # Maximum number of source region codes allowed is 5000.
590 &quot;A String&quot;,
591 ],
592 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
593 # of the traffic.
594 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
595 # and there is no srcIpRange, this rule will be ignored.
596 # Maximum number of source tag values allowed is 256.
597 {
598 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
599 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
600 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
601 # or its network is deleted.
602 },
603 ],
604 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
605 # The IPs in these lists will be matched against traffic source.
606 &quot;A String&quot;,
607 ],
608 },
609 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
610 # must be a positive value between 0 and 2147483647.
611 # Rules are evaluated from highest to lowest priority where 0 is the
612 # highest priority and 2147483647 is the lowest priority.
613 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
614 # and can be updated.
615 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
616 # rule.
617 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
618 # Example:
619 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
620 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
621 # &#x27;mirror&#x27;. Cannot be specified for other actions.
622 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
623 # This field allows you to control which load balancers get this rule.
624 # For example, the following are valid values:
625 #
626 #
627 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
628 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
629 # - projects/project/global/
630 # forwardingRules/forwardingRule
631 # - projects/project/regions/region/forwardingRules/
632 # forwardingRule
633 &quot;A String&quot;,
634 ],
635 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
636 # allows you to control which network&#x27;s VMs get this rule. If this field
637 # is left blank, all VMs within the organization will receive the rule.
638 &quot;A String&quot;,
639 ],
640 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
641 # applies to. If targetSecureTag are specified, then the
642 # firewall rule applies only to instances in the VPC network that have one
643 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
644 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
645 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
646 # to all instances on the specified network.
647 # Maximum number of target label tags allowed is 256.
648 {
649 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
650 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
651 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
652 # or its network is deleted.
653 },
654 ],
655 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
656 # applied with this rule.
657 &quot;A String&quot;,
658 ],
659 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
660 # Default value is INSTANCES.
661 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
662 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
663 # be set for other actions.
664 }
665
666 maxPriority: integer, When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority&gt;.
667 This field is exclusive with rule.priority.
668 minPriority: integer, When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority&gt;.
669 This field is exclusive with rule.priority.
670 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
671 that if you must retry your request, the server will know to ignore the
672 request if it has already been completed.
673
674 For example, consider a situation where you make an initial request and
675 the request times out. If you make the request again with the same
676 request ID, the server can check if original operation with the same
677 request ID was received, and if so, will ignore the second request. This
678 prevents clients from accidentally creating duplicate commitments.
679
680 The request ID must be
681 a valid UUID with the exception that zero UUID is not supported
682 (00000000-0000-0000-0000-000000000000).
683 x__xgafv: string, V1 error format.
684 Allowed values
685 1 - v1 error format
686 2 - v2 error format
687
688 Returns:
689 An object of the form:
690
691 { # Represents an Operation resource.
692 #
693 # Google Compute Engine has three Operation resources:
694 #
695 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
696 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
697 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
698 #
699 # You can use an operation resource to manage asynchronous API requests.
700 # For more information, readHandling
701 # API responses.
702 #
703 # Operations can be global, regional or zonal.
704 #
705 # - For global operations, use the `globalOperations`
706 # resource.
707 # - For regional operations, use the
708 # `regionOperations` resource.
709 # - For zonal operations, use
710 # the `zoneOperations` resource.
711 #
712 #
713 #
714 # For more information, read
715 # Global, Regional, and Zonal Resources.
716 #
717 # Note that completed Operation resources have a limited
718 # retention period.
719 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
720 # Not present otherwise.
721 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
722 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
723 # set when the operation is created.
724 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
725 # text format.
726 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
727 # this field will be populated.
728 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
729 # operation.
730 {
731 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
732 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
733 # details. There is a set of defined message types to use for providing
734 # details.The syntax depends on the error code. For example,
735 # QuotaExceededInfo will have details when the error code is
736 # QUOTA_EXCEEDED.
737 {
738 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
739 #
740 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
741 # is not enabled:
742 #
743 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
744 # &quot;domain&quot;: &quot;googleapis.com&quot;
745 # &quot;metadata&quot;: {
746 # &quot;resource&quot;: &quot;projects/123&quot;,
747 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
748 # }
749 # }
750 #
751 # This response indicates that the pubsub.googleapis.com API is not enabled.
752 #
753 # Example of an error that is returned when attempting to create a Spanner
754 # instance in a region that is out of stock:
755 #
756 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
757 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
758 # &quot;metadata&quot;: {
759 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
760 # }
761 # }
762 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
763 # is typically the registered service name of the tool or product that
764 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
765 # generated by some common infrastructure, the error domain must be a
766 # globally unique value that identifies the infrastructure. For Google API
767 # infrastructure, the error domain is &quot;googleapis.com&quot;.
768 &quot;metadatas&quot;: { # Additional structured details about this error.
769 #
770 # Keys must match a regular expression of `a-z+` but should
771 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
772 # length. When identifying the current value of an exceeded limit, the units
773 # should be contained in the key, not the value. For example, rather than
774 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
775 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
776 # instances that can be created in a single (batch) request.
777 &quot;a_key&quot;: &quot;A String&quot;,
778 },
779 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
780 # proximate cause of the error. Error reasons are unique within a particular
781 # domain of errors. This should be at most 63 characters and match a
782 # regular expression of `A-Z+[A-Z0-9]`, which represents
783 # UPPER_SNAKE_CASE.
784 },
785 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
786 #
787 # For example, if a quota check failed with an error indicating the calling
788 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
789 # directly to the right place in the developer console to flip the bit.
790 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
791 { # Describes a URL link.
792 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
793 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
794 },
795 ],
796 },
797 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
798 # which can be attached to an RPC error.
799 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
800 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
801 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
802 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
803 },
804 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
805 &quot;dimensions&quot;: { # The map holding related quota dimensions.
806 &quot;a_key&quot;: &quot;A String&quot;,
807 },
808 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
809 # type or metric.
810 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
811 # or metric.
812 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
813 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
814 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
815 },
816 },
817 ],
818 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
819 # This property is optional.
820 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
821 },
822 ],
823 },
824 &quot;getVersionOperationMetadata&quot;: {
825 &quot;inlineSbomInfo&quot;: {
826 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
827 # appropriate identifiers.
828 &quot;a_key&quot;: &quot;A String&quot;,
829 },
830 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
831 # identifiers.
832 &quot;a_key&quot;: &quot;A String&quot;,
833 },
834 },
835 },
836 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
837 # message that was returned, such as `NOT FOUND`.
838 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
839 # status code that was returned. For example, a `404` means the
840 # resource was not found.
841 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
842 # defined by the server.
843 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
844 # This value is inRFC3339
845 # text format.
846 &quot;instancesBulkInsertOperationMetadata&quot;: {
847 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
848 # Example key: zones/us-central1-a
849 &quot;a_key&quot;: {
850 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
851 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
852 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
853 # error.
854 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
855 # if the flow is rolling forward or rolling back.
856 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
857 },
858 },
859 },
860 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
861 # Operation resources.
862 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
863 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
864 # group of operations results from a `bulkInsert` API request.
865 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
866 # `update`, or `delete`, and so on.
867 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
868 # There is no requirement that this be linear or support any granularity of
869 # operations. This should not be used to guess when the operation will be
870 # complete. This number should monotonically increase as the operation
871 # progresses.
872 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
873 # applicable when performing regional operations.
874 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
875 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
876 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
877 # this field will contain information on all underlying zonal actions and
878 # their state.
879 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
880 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
881 # Example key: zones/us-central1-a
882 &quot;a_key&quot;: {
883 &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
884 # populated.
885 # different programming environments, including REST APIs and RPC APIs. It is
886 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
887 # three pieces of data: error code, error message, and error details.
888 #
889 # You can find out more about this error model and how to work with it in the
890 # [API Design Guide](https://cloud.google.com/apis/design/errors).
891 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
892 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
893 # message types for APIs to use.
894 {
895 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
896 },
897 ],
898 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
899 # user-facing error message should be localized and sent in the
900 # google.rpc.Status.details field, or localized by the client.
901 },
902 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
903 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
904 },
905 },
906 },
907 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
908 # This value is inRFC3339
909 # text format.
910 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
911 # following:
912 # `PENDING`, `RUNNING`, or `DONE`.
913 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
914 # operation.
915 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
916 # of the target resource.
917 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
918 # operations related to creating a snapshot, this points to the disk
919 # that the snapshot was created from.
920 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
921 # `[email protected]` or
922 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
923 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
924 # operation, this field will be populated.
925 {
926 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
927 # Engine returns NO_RESULTS_ON_PAGE if there
928 # are no results in the response.
929 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
930 # value format. For example:
931 #
932 # &quot;data&quot;: [
933 # {
934 # &quot;key&quot;: &quot;scope&quot;,
935 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
936 # }
937 {
938 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
939 # returned. For example, for warnings where there are no results in a list
940 # request for a particular zone, this key might be scope and
941 # the key value might be the zone name. Other examples might be a key
942 # indicating a deprecated resource and a suggested replacement, or a
943 # warning about invalid network settings (for example, if an instance
944 # attempts to perform IP forwarding but is not enabled for IP forwarding).
945 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
946 },
947 ],
948 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
949 },
950 ],
951 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
952 # applicable when performing per-zone operations.
953 }</pre>
954 </div>
955
956 <div class="method">
957 <code class="details" id="addRule">addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</code>
958 <pre>Inserts a rule into a firewall policy.
959
960 Args:
961 project: string, Project ID for this request. (required)
962 firewallPolicy: string, Name of the firewall policy to update. (required)
963 body: object, The request body.
964 The object takes the form of:
965
966 { # Represents a rule that describes one or more match conditions along with
967 # the action to be taken when traffic matches this condition (allow or deny).
968 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
969 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
970 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
971 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
972 # and &quot;goto_next&quot;.
973 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
974 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
975 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
976 # the firewall policy rule is not enforced and traffic behaves as if it did
977 # not exist. If this is unspecified, the firewall policy rule will be
978 # enabled.
979 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
980 # enabled, logs will be exported to the configured export destination in
981 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
982 # cannot enable logging on &quot;goto_next&quot; rules.
983 &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.
984 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
985 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
986 # Exactly one field must be specified.
987 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
988 # Maximum number of destination address groups is 10.
989 &quot;A String&quot;,
990 ],
991 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
992 # traffic destination.
993 # Maximum number of destination fqdn allowed is 100.
994 &quot;A String&quot;,
995 ],
996 &quot;destIpRanges&quot;: [ # CIDR IP address range.
997 # Maximum number of destination CIDR IP ranges allowed is 5000.
998 &quot;A String&quot;,
999 ],
1000 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
1001 #
1002 #
1003 # - UNSPECIFIED
1004 # - INTERNET
1005 # - NON_INTERNET
1006 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
1007 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
1008 #
1009 #
1010 # - UNSPECIFIED
1011 # - INTERNET
1012 # - NON_INTERNET
1013 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
1014 # of traffic. Should be specified as 2 letter country code defined as per
1015 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1016 # Maximum number of dest region codes allowed is 5000.
1017 &quot;A String&quot;,
1018 ],
1019 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1020 # The IPs in these lists will be matched against traffic destination.
1021 &quot;A String&quot;,
1022 ],
1023 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1024 {
1025 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1026 # required when creating a firewall rule. This value can either be
1027 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1028 # protocol number.
1029 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1030 # only applicable for UDP or TCP protocol. Each entry must be either
1031 # an integer or a range. If not specified, this rule applies to
1032 # connections through any port.
1033 #
1034 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1035 &quot;A String&quot;,
1036 ],
1037 },
1038 ],
1039 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1040 # Maximum number of source address groups is 10.
1041 &quot;A String&quot;,
1042 ],
1043 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1044 # traffic source.
1045 # Maximum number of source fqdn allowed is 100.
1046 &quot;A String&quot;,
1047 ],
1048 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1049 # Maximum number of source CIDR IP ranges allowed is 5000.
1050 &quot;A String&quot;,
1051 ],
1052 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1053 #
1054 #
1055 # - UNSPECIFIED
1056 # - INTERNET
1057 # - INTRA_VPC
1058 # - NON_INTERNET
1059 # - VPC_NETWORKS
1060 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1061 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1062 #
1063 #
1064 # - UNSPECIFIED
1065 # - INTERNET
1066 # - INTRA_VPC
1067 # - NON_INTERNET
1068 # - VPC_NETWORKS
1069 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1070 &quot;A String&quot;,
1071 ],
1072 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1073 # of traffic. Should be specified as 2 letter country code defined as per
1074 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1075 # Maximum number of source region codes allowed is 5000.
1076 &quot;A String&quot;,
1077 ],
1078 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1079 # of the traffic.
1080 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1081 # and there is no srcIpRange, this rule will be ignored.
1082 # Maximum number of source tag values allowed is 256.
1083 {
1084 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1085 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1086 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1087 # or its network is deleted.
1088 },
1089 ],
1090 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1091 # The IPs in these lists will be matched against traffic source.
1092 &quot;A String&quot;,
1093 ],
1094 },
1095 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1096 # must be a positive value between 0 and 2147483647.
1097 # Rules are evaluated from highest to lowest priority where 0 is the
1098 # highest priority and 2147483647 is the lowest priority.
1099 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1100 # and can be updated.
1101 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1102 # rule.
1103 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1104 # Example:
1105 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1106 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1107 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1108 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
1109 # This field allows you to control which load balancers get this rule.
1110 # For example, the following are valid values:
1111 #
1112 #
1113 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
1114 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1115 # - projects/project/global/
1116 # forwardingRules/forwardingRule
1117 # - projects/project/regions/region/forwardingRules/
1118 # forwardingRule
1119 &quot;A String&quot;,
1120 ],
1121 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
1122 # allows you to control which network&#x27;s VMs get this rule. If this field
1123 # is left blank, all VMs within the organization will receive the rule.
1124 &quot;A String&quot;,
1125 ],
1126 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
1127 # applies to. If targetSecureTag are specified, then the
1128 # firewall rule applies only to instances in the VPC network that have one
1129 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
1130 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
1131 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
1132 # to all instances on the specified network.
1133 # Maximum number of target label tags allowed is 256.
1134 {
1135 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1136 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1137 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1138 # or its network is deleted.
1139 },
1140 ],
1141 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
1142 # applied with this rule.
1143 &quot;A String&quot;,
1144 ],
1145 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
1146 # Default value is INSTANCES.
1147 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
1148 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
1149 # be set for other actions.
1150 }
1151
1152 maxPriority: integer, When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority&gt;.
1153 This field is exclusive with rule.priority.
1154 minPriority: integer, When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority&gt;.
1155 This field is exclusive with rule.priority.
1156 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1157 that if you must retry your request, the server will know to ignore the
1158 request if it has already been completed.
1159
1160 For example, consider a situation where you make an initial request and
1161 the request times out. If you make the request again with the same
1162 request ID, the server can check if original operation with the same
1163 request ID was received, and if so, will ignore the second request. This
1164 prevents clients from accidentally creating duplicate commitments.
1165
1166 The request ID must be
1167 a valid UUID with the exception that zero UUID is not supported
1168 (00000000-0000-0000-0000-000000000000).
1169 x__xgafv: string, V1 error format.
1170 Allowed values
1171 1 - v1 error format
1172 2 - v2 error format
1173
1174 Returns:
1175 An object of the form:
1176
1177 { # Represents an Operation resource.
1178 #
1179 # Google Compute Engine has three Operation resources:
1180 #
1181 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1182 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1183 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1184 #
1185 # You can use an operation resource to manage asynchronous API requests.
1186 # For more information, readHandling
1187 # API responses.
1188 #
1189 # Operations can be global, regional or zonal.
1190 #
1191 # - For global operations, use the `globalOperations`
1192 # resource.
1193 # - For regional operations, use the
1194 # `regionOperations` resource.
1195 # - For zonal operations, use
1196 # the `zoneOperations` resource.
1197 #
1198 #
1199 #
1200 # For more information, read
1201 # Global, Regional, and Zonal Resources.
1202 #
1203 # Note that completed Operation resources have a limited
1204 # retention period.
1205 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1206 # Not present otherwise.
1207 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1208 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1209 # set when the operation is created.
1210 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1211 # text format.
1212 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1213 # this field will be populated.
1214 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1215 # operation.
1216 {
1217 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1218 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1219 # details. There is a set of defined message types to use for providing
1220 # details.The syntax depends on the error code. For example,
1221 # QuotaExceededInfo will have details when the error code is
1222 # QUOTA_EXCEEDED.
1223 {
1224 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1225 #
1226 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1227 # is not enabled:
1228 #
1229 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1230 # &quot;domain&quot;: &quot;googleapis.com&quot;
1231 # &quot;metadata&quot;: {
1232 # &quot;resource&quot;: &quot;projects/123&quot;,
1233 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1234 # }
1235 # }
1236 #
1237 # This response indicates that the pubsub.googleapis.com API is not enabled.
1238 #
1239 # Example of an error that is returned when attempting to create a Spanner
1240 # instance in a region that is out of stock:
1241 #
1242 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1243 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1244 # &quot;metadata&quot;: {
1245 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1246 # }
1247 # }
1248 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1249 # is typically the registered service name of the tool or product that
1250 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1251 # generated by some common infrastructure, the error domain must be a
1252 # globally unique value that identifies the infrastructure. For Google API
1253 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1254 &quot;metadatas&quot;: { # Additional structured details about this error.
1255 #
1256 # Keys must match a regular expression of `a-z+` but should
1257 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1258 # length. When identifying the current value of an exceeded limit, the units
1259 # should be contained in the key, not the value. For example, rather than
1260 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1261 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1262 # instances that can be created in a single (batch) request.
1263 &quot;a_key&quot;: &quot;A String&quot;,
1264 },
1265 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1266 # proximate cause of the error. Error reasons are unique within a particular
1267 # domain of errors. This should be at most 63 characters and match a
1268 # regular expression of `A-Z+[A-Z0-9]`, which represents
1269 # UPPER_SNAKE_CASE.
1270 },
1271 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1272 #
1273 # For example, if a quota check failed with an error indicating the calling
1274 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1275 # directly to the right place in the developer console to flip the bit.
1276 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1277 { # Describes a URL link.
1278 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1279 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1280 },
1281 ],
1282 },
1283 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1284 # which can be attached to an RPC error.
1285 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1286 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1287 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1288 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1289 },
1290 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1291 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1292 &quot;a_key&quot;: &quot;A String&quot;,
1293 },
1294 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1295 # type or metric.
1296 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1297 # or metric.
1298 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1299 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1300 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1301 },
1302 },
1303 ],
1304 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1305 # This property is optional.
1306 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1307 },
1308 ],
1309 },
1310 &quot;getVersionOperationMetadata&quot;: {
1311 &quot;inlineSbomInfo&quot;: {
1312 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1313 # appropriate identifiers.
1314 &quot;a_key&quot;: &quot;A String&quot;,
1315 },
1316 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1317 # identifiers.
1318 &quot;a_key&quot;: &quot;A String&quot;,
1319 },
1320 },
1321 },
1322 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1323 # message that was returned, such as `NOT FOUND`.
1324 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1325 # status code that was returned. For example, a `404` means the
1326 # resource was not found.
1327 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1328 # defined by the server.
1329 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1330 # This value is inRFC3339
1331 # text format.
1332 &quot;instancesBulkInsertOperationMetadata&quot;: {
1333 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1334 # Example key: zones/us-central1-a
1335 &quot;a_key&quot;: {
1336 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1337 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1338 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1339 # error.
1340 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1341 # if the flow is rolling forward or rolling back.
1342 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1343 },
1344 },
1345 },
1346 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1347 # Operation resources.
1348 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1349 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1350 # group of operations results from a `bulkInsert` API request.
1351 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1352 # `update`, or `delete`, and so on.
1353 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1354 # There is no requirement that this be linear or support any granularity of
1355 # operations. This should not be used to guess when the operation will be
1356 # complete. This number should monotonically increase as the operation
1357 # progresses.
1358 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1359 # applicable when performing regional operations.
1360 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1361 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1362 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1363 # this field will contain information on all underlying zonal actions and
1364 # their state.
1365 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1366 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1367 # Example key: zones/us-central1-a
1368 &quot;a_key&quot;: {
1369 &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
1370 # populated.
1371 # different programming environments, including REST APIs and RPC APIs. It is
1372 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1373 # three pieces of data: error code, error message, and error details.
1374 #
1375 # You can find out more about this error model and how to work with it in the
1376 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1377 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1378 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1379 # message types for APIs to use.
1380 {
1381 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1382 },
1383 ],
1384 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1385 # user-facing error message should be localized and sent in the
1386 # google.rpc.Status.details field, or localized by the client.
1387 },
1388 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1389 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1390 },
1391 },
1392 },
1393 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1394 # This value is inRFC3339
1395 # text format.
1396 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1397 # following:
1398 # `PENDING`, `RUNNING`, or `DONE`.
1399 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1400 # operation.
1401 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1402 # of the target resource.
1403 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1404 # operations related to creating a snapshot, this points to the disk
1405 # that the snapshot was created from.
1406 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1407 # `[email protected]` or
1408 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1409 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1410 # operation, this field will be populated.
1411 {
1412 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1413 # Engine returns NO_RESULTS_ON_PAGE if there
1414 # are no results in the response.
1415 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1416 # value format. For example:
1417 #
1418 # &quot;data&quot;: [
1419 # {
1420 # &quot;key&quot;: &quot;scope&quot;,
1421 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1422 # }
1423 {
1424 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1425 # returned. For example, for warnings where there are no results in a list
1426 # request for a particular zone, this key might be scope and
1427 # the key value might be the zone name. Other examples might be a key
1428 # indicating a deprecated resource and a suggested replacement, or a
1429 # warning about invalid network settings (for example, if an instance
1430 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1431 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1432 },
1433 ],
1434 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1435 },
1436 ],
1437 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1438 # applicable when performing per-zone operations.
1439 }</pre>
1440 </div>
1441
1442 <div class="method">
1443 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
1444 <pre>Retrieves an aggregated list of network firewall policies, listing network
1445 firewall policies from all applicable scopes (global and regional) and
1446 grouping the results per scope.
1447
1448 To prevent failure, it is recommended that you set the
1449 `returnPartialSuccess` parameter to `true`.
1450
1451 Args:
1452 project: string, Project ID for this request. (required)
1453 filter: string, A filter expression that filters resources listed in the response. Most
1454 Compute resources support two types of filter expressions:
1455 expressions that support regular expressions and expressions that follow
1456 API improvement proposal AIP-160.
1457 These two types of filter expressions cannot be mixed in one request.
1458
1459 If you want to use AIP-160, your expression must specify the field name, an
1460 operator, and the value that you want to use for filtering. The value
1461 must be a string, a number, or a boolean. The operator
1462 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1463
1464 For example, if you are filtering Compute Engine instances, you can
1465 exclude instances named `example-instance` by specifying
1466 `name != example-instance`.
1467
1468 The `:*` comparison can be used to test whether a key has been defined.
1469 For example, to find all objects with `owner` label use:
1470 ```
1471 labels.owner:*
1472 ```
1473
1474 You can also filter nested fields. For example, you could specify
1475 `scheduling.automaticRestart = false` to include instances only
1476 if they are not scheduled for automatic restarts. You can use filtering
1477 on nested fields to filter based onresource labels.
1478
1479 To filter on multiple expressions, provide each separate expression within
1480 parentheses. For example:
1481 ```
1482 (scheduling.automaticRestart = true)
1483 (cpuPlatform = &quot;Intel Skylake&quot;)
1484 ```
1485 By default, each expression is an `AND` expression. However, you
1486 can include `AND` and `OR` expressions explicitly.
1487 For example:
1488 ```
1489 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1490 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1491 (scheduling.automaticRestart = true)
1492 ```
1493
1494 If you want to use a regular expression, use the `eq` (equal) or `ne`
1495 (not equal) operator against a single un-parenthesized expression with or
1496 without quotes or against multiple parenthesized expressions. Examples:
1497
1498 `fieldname eq unquoted literal`
1499 `fieldname eq &#x27;single quoted literal&#x27;`
1500 `fieldname eq &quot;double quoted literal&quot;`
1501 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1502
1503 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1504 The literal value must match the entire field.
1505
1506 For example, to filter for instances that do not end with name &quot;instance&quot;,
1507 you would use `name ne .*instance`.
1508
1509 You cannot combine constraints on multiple fields using regular
1510 expressions.
1511 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
1512 global) should be included in the response. For new resource types added
1513 after this field, the flag has no effect as new resource types will always
1514 include every visible scope for each scope type in response. For resource
1515 types which predate this field, if this flag is omitted or false, only
1516 scopes of the scope types where the resource type is expected to be found
1517 will be included.
1518 maxResults: integer, The maximum number of results per page that should be returned.
1519 If the number of available results is larger than `maxResults`,
1520 Compute Engine returns a `nextPageToken` that can be used to get
1521 the next page of results in subsequent list requests. Acceptable values are
1522 `0` to `500`, inclusive. (Default: `500`)
1523 orderBy: string, Sorts list results by a certain order. By default, results
1524 are returned in alphanumerical order based on the resource name.
1525
1526 You can also sort results in descending order based on the creation
1527 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1528 results based on the `creationTimestamp` field in
1529 reverse chronological order (newest result first). Use this to sort
1530 resources like operations so that the newest operation is returned first.
1531
1532 Currently, only sorting by `name` or
1533 `creationTimestamp desc` is supported.
1534 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1535 `nextPageToken` returned by a previous list request to get
1536 the next page of results.
1537 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1538 of failure. The default value is false.
1539
1540 For example, when partial success behavior is enabled, aggregatedList for a
1541 single zone scope either returns all resources in the zone or no resources,
1542 with an error code.
1543 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
1544 aggregated list request is invoked for subnetworks list-usable api.
1545 x__xgafv: string, V1 error format.
1546 Allowed values
1547 1 - v1 error format
1548 2 - v2 error format
1549
1550 Returns:
1551 An object of the form:
1552
1553 {
1554 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1555 &quot;items&quot;: { # A list of FirewallPoliciesScopedList resources.
1556 &quot;a_key&quot;: { # Name of the scope containing this set of addresses.
1557 &quot;firewallPolicies&quot;: [ # A list of firewall policies contained in this scope.
1558 { # Represents a Firewall Policy resource.
1559 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
1560 {
1561 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
1562 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
1563 # of the firewall policy of the association.
1564 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
1565 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
1566 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
1567 # must be a positive value between 1 and 2147483647.
1568 # Firewall Policies are evaluated from highest to lowest priority where 1
1569 # is the highest priority and 2147483647 is the lowest priority.
1570 # The default value is `1000`. If two associations have the same priority
1571 # then lexicographical order on association names is applied.
1572 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
1573 },
1574 ],
1575 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1576 # text format.
1577 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1578 # create the resource.
1579 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
1580 # Organization firewall policy. The name should be unique in the organization
1581 # in which the firewall policy is created.
1582 # This field is not applicable to network firewall policies.
1583 # This name must be set on creation and cannot be changed.
1584 # The name must be 1-63 characters long, and comply
1585 # with RFC1035. Specifically, the name must be 1-63 characters
1586 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
1587 # means the first character must be a lowercase letter, and all following
1588 # characters must be a dash, lowercase letter, or digit, except the last
1589 # character, which cannot be a dash.
1590 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
1591 # the metadata&#x27;s contents and used for optimistic locking. The
1592 # fingerprint is initially generated by Compute Engine and changes after
1593 # every request to modify or update metadata. You must always provide an
1594 # up-to-date fingerprint hash in order to update or change metadata,
1595 # otherwise the request will fail with error412 conditionNotMet.
1596 #
1597 # To see the latest fingerprint, make get() request to the
1598 # firewall policy.
1599 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1600 # defined by the server.
1601 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
1602 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
1603 # [Output Only] numeric ID allocated by Google Cloud which uniquely
1604 # identifies the Organization Firewall Policy.
1605 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
1606 { # Represents a rule that describes one or more match conditions along with
1607 # the action to be taken when traffic matches this condition (allow or deny).
1608 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
1609 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
1610 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
1611 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
1612 # and &quot;goto_next&quot;.
1613 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
1614 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
1615 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
1616 # the firewall policy rule is not enforced and traffic behaves as if it did
1617 # not exist. If this is unspecified, the firewall policy rule will be
1618 # enabled.
1619 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
1620 # enabled, logs will be exported to the configured export destination in
1621 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
1622 # cannot enable logging on &quot;goto_next&quot; rules.
1623 &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.
1624 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
1625 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
1626 # Exactly one field must be specified.
1627 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
1628 # Maximum number of destination address groups is 10.
1629 &quot;A String&quot;,
1630 ],
1631 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1632 # traffic destination.
1633 # Maximum number of destination fqdn allowed is 100.
1634 &quot;A String&quot;,
1635 ],
1636 &quot;destIpRanges&quot;: [ # CIDR IP address range.
1637 # Maximum number of destination CIDR IP ranges allowed is 5000.
1638 &quot;A String&quot;,
1639 ],
1640 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
1641 #
1642 #
1643 # - UNSPECIFIED
1644 # - INTERNET
1645 # - NON_INTERNET
1646 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
1647 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
1648 #
1649 #
1650 # - UNSPECIFIED
1651 # - INTERNET
1652 # - NON_INTERNET
1653 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
1654 # of traffic. Should be specified as 2 letter country code defined as per
1655 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1656 # Maximum number of dest region codes allowed is 5000.
1657 &quot;A String&quot;,
1658 ],
1659 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1660 # The IPs in these lists will be matched against traffic destination.
1661 &quot;A String&quot;,
1662 ],
1663 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1664 {
1665 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1666 # required when creating a firewall rule. This value can either be
1667 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1668 # protocol number.
1669 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1670 # only applicable for UDP or TCP protocol. Each entry must be either
1671 # an integer or a range. If not specified, this rule applies to
1672 # connections through any port.
1673 #
1674 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1675 &quot;A String&quot;,
1676 ],
1677 },
1678 ],
1679 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1680 # Maximum number of source address groups is 10.
1681 &quot;A String&quot;,
1682 ],
1683 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1684 # traffic source.
1685 # Maximum number of source fqdn allowed is 100.
1686 &quot;A String&quot;,
1687 ],
1688 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1689 # Maximum number of source CIDR IP ranges allowed is 5000.
1690 &quot;A String&quot;,
1691 ],
1692 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1693 #
1694 #
1695 # - UNSPECIFIED
1696 # - INTERNET
1697 # - INTRA_VPC
1698 # - NON_INTERNET
1699 # - VPC_NETWORKS
1700 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1701 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1702 #
1703 #
1704 # - UNSPECIFIED
1705 # - INTERNET
1706 # - INTRA_VPC
1707 # - NON_INTERNET
1708 # - VPC_NETWORKS
1709 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1710 &quot;A String&quot;,
1711 ],
1712 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1713 # of traffic. Should be specified as 2 letter country code defined as per
1714 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1715 # Maximum number of source region codes allowed is 5000.
1716 &quot;A String&quot;,
1717 ],
1718 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1719 # of the traffic.
1720 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1721 # and there is no srcIpRange, this rule will be ignored.
1722 # Maximum number of source tag values allowed is 256.
1723 {
1724 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1725 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1726 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1727 # or its network is deleted.
1728 },
1729 ],
1730 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1731 # The IPs in these lists will be matched against traffic source.
1732 &quot;A String&quot;,
1733 ],
1734 },
1735 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1736 # must be a positive value between 0 and 2147483647.
1737 # Rules are evaluated from highest to lowest priority where 0 is the
1738 # highest priority and 2147483647 is the lowest priority.
1739 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1740 # and can be updated.
1741 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1742 # rule.
1743 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1744 # Example:
1745 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1746 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1747 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1748 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
1749 # This field allows you to control which load balancers get this rule.
1750 # For example, the following are valid values:
1751 #
1752 #
1753 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
1754 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1755 # - projects/project/global/
1756 # forwardingRules/forwardingRule
1757 # - projects/project/regions/region/forwardingRules/
1758 # forwardingRule
1759 &quot;A String&quot;,
1760 ],
1761 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
1762 # allows you to control which network&#x27;s VMs get this rule. If this field
1763 # is left blank, all VMs within the organization will receive the rule.
1764 &quot;A String&quot;,
1765 ],
1766 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
1767 # applies to. If targetSecureTag are specified, then the
1768 # firewall rule applies only to instances in the VPC network that have one
1769 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
1770 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
1771 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
1772 # to all instances on the specified network.
1773 # Maximum number of target label tags allowed is 256.
1774 {
1775 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1776 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1777 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1778 # or its network is deleted.
1779 },
1780 ],
1781 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
1782 # applied with this rule.
1783 &quot;A String&quot;,
1784 ],
1785 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
1786 # Default value is INSTANCES.
1787 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
1788 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
1789 # be set for other actions.
1790 },
1791 ],
1792 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
1793 # This field is not applicable to network firewall policies.
1794 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
1795 # creation and defaults to USER_DEFINED.
1796 #
1797 # The USER_DEFINED value indicates a regular firewall policy.
1798 #
1799 # The SYSTEM value indicates a system-level policy managed by an
1800 # internal service like GKE. This SYSTEM value is reserved for
1801 # internal services and cannot be set by users during policy creation.
1802 # Policies with a SYSTEM source cannot be modified or deleted by
1803 # users.
1804 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
1805 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
1806 #
1807 # Note: if not specified then VPC_POLICY will be used.
1808 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
1809 # This field is not applicable to global firewall policies.
1810 # You must specify this field as part of the HTTP request URL. It is
1811 # not settable as a field in the request body.
1812 &quot;rolloutOperation&quot;: { # Represents progressive rollout input parameters and current status. # Configuration and status of the progressive rollout of this resource.
1813 &quot;rolloutInput&quot;: { # Represents progressive rollout input parameters. # Input parameters to be used by the next not yet scheduled rollout.
1814 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan. Ex.
1815 # organizations//locations/global/rolloutPlans/.
1816 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
1817 &quot;retryUuid&quot;: &quot;A String&quot;, # The UUID of the retry action. Only needed if this is a retry for an
1818 # existing rollout. This can be used after the user canceled a rollout
1819 # and want to retry it with no changes.
1820 },
1821 &quot;rolloutStatus&quot;: { # Represents progressive rollout current status. # [Output only] Current status of the rollout.
1822 &quot;nextRollout&quot;: { # [Output only] The next rollout.
1823 &quot;rolloutId&quot;: &quot;A String&quot;, # Output only. [Output only] The id of the next rollout.
1824 &quot;rolloutPlan&quot;: &quot;A String&quot;, # The name of the rollout plan to be used by the next not yet started
1825 # rollout. This field is auto populated based on RolloutInput when a
1826 # new rollout is scheduled. This can be manually changed before the
1827 # scheduled rollout starts.
1828 # Ex.
1829 # organizations//locations/global/rolloutPlans/
1830 },
1831 &quot;ongoingRollouts&quot;: [ # [Output only] The ongoing rollout.
1832 { # Represents the status of the progressive rollout instance, either
1833 # completed or ongoing.
1834 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
1835 # organizations//locations/global/rollouts/
1836 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
1837 # organizations//locations/global/rolloutPlans/
1838 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
1839 },
1840 ],
1841 &quot;previousRollout&quot;: { # Represents the status of the progressive rollout instance, either # [Output only] The last previously executed rollout.
1842 # completed or ongoing.
1843 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
1844 # organizations//locations/global/rollouts/
1845 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
1846 # organizations//locations/global/rolloutPlans/
1847 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
1848 },
1849 },
1850 },
1851 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
1852 # policy can not exceed a set number of tuples.
1853 &quot;rules&quot;: [ # A list of rules that belong to this policy.
1854 # There must always be a default rule (rule with priority 2147483647 and
1855 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
1856 # default rule with action &quot;allow&quot; will be added.
1857 { # Represents a rule that describes one or more match conditions along with
1858 # the action to be taken when traffic matches this condition (allow or deny).
1859 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
1860 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
1861 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
1862 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
1863 # and &quot;goto_next&quot;.
1864 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
1865 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
1866 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
1867 # the firewall policy rule is not enforced and traffic behaves as if it did
1868 # not exist. If this is unspecified, the firewall policy rule will be
1869 # enabled.
1870 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
1871 # enabled, logs will be exported to the configured export destination in
1872 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
1873 # cannot enable logging on &quot;goto_next&quot; rules.
1874 &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.
1875 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
1876 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
1877 # Exactly one field must be specified.
1878 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
1879 # Maximum number of destination address groups is 10.
1880 &quot;A String&quot;,
1881 ],
1882 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1883 # traffic destination.
1884 # Maximum number of destination fqdn allowed is 100.
1885 &quot;A String&quot;,
1886 ],
1887 &quot;destIpRanges&quot;: [ # CIDR IP address range.
1888 # Maximum number of destination CIDR IP ranges allowed is 5000.
1889 &quot;A String&quot;,
1890 ],
1891 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
1892 #
1893 #
1894 # - UNSPECIFIED
1895 # - INTERNET
1896 # - NON_INTERNET
1897 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
1898 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
1899 #
1900 #
1901 # - UNSPECIFIED
1902 # - INTERNET
1903 # - NON_INTERNET
1904 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
1905 # of traffic. Should be specified as 2 letter country code defined as per
1906 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1907 # Maximum number of dest region codes allowed is 5000.
1908 &quot;A String&quot;,
1909 ],
1910 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1911 # The IPs in these lists will be matched against traffic destination.
1912 &quot;A String&quot;,
1913 ],
1914 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1915 {
1916 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1917 # required when creating a firewall rule. This value can either be
1918 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1919 # protocol number.
1920 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1921 # only applicable for UDP or TCP protocol. Each entry must be either
1922 # an integer or a range. If not specified, this rule applies to
1923 # connections through any port.
1924 #
1925 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1926 &quot;A String&quot;,
1927 ],
1928 },
1929 ],
1930 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1931 # Maximum number of source address groups is 10.
1932 &quot;A String&quot;,
1933 ],
1934 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1935 # traffic source.
1936 # Maximum number of source fqdn allowed is 100.
1937 &quot;A String&quot;,
1938 ],
1939 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1940 # Maximum number of source CIDR IP ranges allowed is 5000.
1941 &quot;A String&quot;,
1942 ],
1943 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1944 #
1945 #
1946 # - UNSPECIFIED
1947 # - INTERNET
1948 # - INTRA_VPC
1949 # - NON_INTERNET
1950 # - VPC_NETWORKS
1951 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1952 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1953 #
1954 #
1955 # - UNSPECIFIED
1956 # - INTERNET
1957 # - INTRA_VPC
1958 # - NON_INTERNET
1959 # - VPC_NETWORKS
1960 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1961 &quot;A String&quot;,
1962 ],
1963 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1964 # of traffic. Should be specified as 2 letter country code defined as per
1965 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1966 # Maximum number of source region codes allowed is 5000.
1967 &quot;A String&quot;,
1968 ],
1969 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1970 # of the traffic.
1971 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1972 # and there is no srcIpRange, this rule will be ignored.
1973 # Maximum number of source tag values allowed is 256.
1974 {
1975 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1976 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1977 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1978 # or its network is deleted.
1979 },
1980 ],
1981 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1982 # The IPs in these lists will be matched against traffic source.
1983 &quot;A String&quot;,
1984 ],
1985 },
1986 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1987 # must be a positive value between 0 and 2147483647.
1988 # Rules are evaluated from highest to lowest priority where 0 is the
1989 # highest priority and 2147483647 is the lowest priority.
1990 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1991 # and can be updated.
1992 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1993 # rule.
1994 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1995 # Example:
1996 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1997 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1998 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1999 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
2000 # This field allows you to control which load balancers get this rule.
2001 # For example, the following are valid values:
2002 #
2003 #
2004 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
2005 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2006 # - projects/project/global/
2007 # forwardingRules/forwardingRule
2008 # - projects/project/regions/region/forwardingRules/
2009 # forwardingRule
2010 &quot;A String&quot;,
2011 ],
2012 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
2013 # allows you to control which network&#x27;s VMs get this rule. If this field
2014 # is left blank, all VMs within the organization will receive the rule.
2015 &quot;A String&quot;,
2016 ],
2017 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
2018 # applies to. If targetSecureTag are specified, then the
2019 # firewall rule applies only to instances in the VPC network that have one
2020 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
2021 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
2022 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
2023 # to all instances on the specified network.
2024 # Maximum number of target label tags allowed is 256.
2025 {
2026 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2027 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2028 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2029 # or its network is deleted.
2030 },
2031 ],
2032 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
2033 # applied with this rule.
2034 &quot;A String&quot;,
2035 ],
2036 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
2037 # Default value is INSTANCES.
2038 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
2039 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
2040 # be set for other actions.
2041 },
2042 ],
2043 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2044 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2045 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
2046 # unique in the organization in which the firewall policy is created.
2047 # This field is not applicable to network firewall policies.
2048 # This name must be set on creation and cannot be changed. The name must be
2049 # 1-63 characters long, and comply with RFC1035.
2050 # Specifically, the name must be 1-63 characters long and match the regular
2051 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2052 # character must be a lowercase letter, and all following characters must
2053 # be a dash, lowercase letter, or digit, except the last character, which
2054 # cannot be a dash.
2055 &quot;vpcNetworkScope&quot;: &quot;A String&quot;, # The scope of networks allowed to be associated with the firewall
2056 # policy. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.
2057 #
2058 # A firewall policy with the VPC scope set to GLOBAL_VPC_NETWORK
2059 # is allowed to be attached only to global networks.
2060 #
2061 # When the VPC scope is set to REGIONAL_VPC_NETWORK the firewall
2062 # policy is allowed to be attached only to regional networks in the same
2063 # scope as the firewall policy.
2064 #
2065 # Note: if not specified then GLOBAL_VPC_NETWORK will be used.
2066 },
2067 ],
2068 &quot;warning&quot;: { # Informational warning which replaces the list of firewall policies when
2069 # the list is empty.
2070 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2071 # Engine returns NO_RESULTS_ON_PAGE if there
2072 # are no results in the response.
2073 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2074 # value format. For example:
2075 #
2076 # &quot;data&quot;: [
2077 # {
2078 # &quot;key&quot;: &quot;scope&quot;,
2079 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2080 # }
2081 {
2082 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2083 # returned. For example, for warnings where there are no results in a list
2084 # request for a particular zone, this key might be scope and
2085 # the key value might be the zone name. Other examples might be a key
2086 # indicating a deprecated resource and a suggested replacement, or a
2087 # warning about invalid network settings (for example, if an instance
2088 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2089 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2090 },
2091 ],
2092 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2093 },
2094 },
2095 },
2096 &quot;kind&quot;: &quot;compute#networkFirewallPolicyAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#networkFirewallPoliciesAggregatedList for lists of
2097 # network firewall policies.
2098 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2099 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2100 # the query parameter pageToken in the next list request.
2101 # Subsequent list requests will have their own nextPageToken to
2102 # continue paging through the results.
2103 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2104 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
2105 &quot;A String&quot;,
2106 ],
2107 &quot;warning&quot;: { # [Output Only] Informational warning message.
2108 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2109 # Engine returns NO_RESULTS_ON_PAGE if there
2110 # are no results in the response.
2111 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2112 # value format. For example:
2113 #
2114 # &quot;data&quot;: [
2115 # {
2116 # &quot;key&quot;: &quot;scope&quot;,
2117 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2118 # }
2119 {
2120 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2121 # returned. For example, for warnings where there are no results in a list
2122 # request for a particular zone, this key might be scope and
2123 # the key value might be the zone name. Other examples might be a key
2124 # indicating a deprecated resource and a suggested replacement, or a
2125 # warning about invalid network settings (for example, if an instance
2126 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2127 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2128 },
2129 ],
2130 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2131 },
2132 }</pre>
2133 </div>
2134
2135 <div class="method">
2136 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
2137 <pre>Retrieves the next page of results.
2138
2139 Args:
2140 previous_request: The request for the previous page. (required)
2141 previous_response: The response from the request for the previous page. (required)
2142
2143 Returns:
2144 A request object that you can call &#x27;execute()&#x27; on to request the next
2145 page. Returns None if there are no more items in the collection.
2146 </pre>
2147 </div>
2148
2149 <div class="method">
2150 <code class="details" id="cloneRules">cloneRules(project, firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</code>
2151 <pre>Copies rules to the specified firewall policy.
2152
2153 Args:
2154 project: string, Project ID for this request. (required)
2155 firewallPolicy: string, Name of the firewall policy to update. (required)
2156 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2157 that if you must retry your request, the server will know to ignore the
2158 request if it has already been completed.
2159
2160 For example, consider a situation where you make an initial request and
2161 the request times out. If you make the request again with the same
2162 request ID, the server can check if original operation with the same
2163 request ID was received, and if so, will ignore the second request. This
2164 prevents clients from accidentally creating duplicate commitments.
2165
2166 The request ID must be
2167 a valid UUID with the exception that zero UUID is not supported
2168 (00000000-0000-0000-0000-000000000000).
2169 sourceFirewallPolicy: string, The firewall policy from which to copy rules.
2170 x__xgafv: string, V1 error format.
2171 Allowed values
2172 1 - v1 error format
2173 2 - v2 error format
2174
2175 Returns:
2176 An object of the form:
2177
2178 { # Represents an Operation resource.
2179 #
2180 # Google Compute Engine has three Operation resources:
2181 #
2182 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2183 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2184 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2185 #
2186 # You can use an operation resource to manage asynchronous API requests.
2187 # For more information, readHandling
2188 # API responses.
2189 #
2190 # Operations can be global, regional or zonal.
2191 #
2192 # - For global operations, use the `globalOperations`
2193 # resource.
2194 # - For regional operations, use the
2195 # `regionOperations` resource.
2196 # - For zonal operations, use
2197 # the `zoneOperations` resource.
2198 #
2199 #
2200 #
2201 # For more information, read
2202 # Global, Regional, and Zonal Resources.
2203 #
2204 # Note that completed Operation resources have a limited
2205 # retention period.
2206 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2207 # Not present otherwise.
2208 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2209 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2210 # set when the operation is created.
2211 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2212 # text format.
2213 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2214 # this field will be populated.
2215 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2216 # operation.
2217 {
2218 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2219 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2220 # details. There is a set of defined message types to use for providing
2221 # details.The syntax depends on the error code. For example,
2222 # QuotaExceededInfo will have details when the error code is
2223 # QUOTA_EXCEEDED.
2224 {
2225 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2226 #
2227 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2228 # is not enabled:
2229 #
2230 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2231 # &quot;domain&quot;: &quot;googleapis.com&quot;
2232 # &quot;metadata&quot;: {
2233 # &quot;resource&quot;: &quot;projects/123&quot;,
2234 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2235 # }
2236 # }
2237 #
2238 # This response indicates that the pubsub.googleapis.com API is not enabled.
2239 #
2240 # Example of an error that is returned when attempting to create a Spanner
2241 # instance in a region that is out of stock:
2242 #
2243 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2244 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2245 # &quot;metadata&quot;: {
2246 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2247 # }
2248 # }
2249 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2250 # is typically the registered service name of the tool or product that
2251 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2252 # generated by some common infrastructure, the error domain must be a
2253 # globally unique value that identifies the infrastructure. For Google API
2254 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2255 &quot;metadatas&quot;: { # Additional structured details about this error.
2256 #
2257 # Keys must match a regular expression of `a-z+` but should
2258 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2259 # length. When identifying the current value of an exceeded limit, the units
2260 # should be contained in the key, not the value. For example, rather than
2261 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2262 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2263 # instances that can be created in a single (batch) request.
2264 &quot;a_key&quot;: &quot;A String&quot;,
2265 },
2266 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2267 # proximate cause of the error. Error reasons are unique within a particular
2268 # domain of errors. This should be at most 63 characters and match a
2269 # regular expression of `A-Z+[A-Z0-9]`, which represents
2270 # UPPER_SNAKE_CASE.
2271 },
2272 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2273 #
2274 # For example, if a quota check failed with an error indicating the calling
2275 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2276 # directly to the right place in the developer console to flip the bit.
2277 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2278 { # Describes a URL link.
2279 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2280 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2281 },
2282 ],
2283 },
2284 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2285 # which can be attached to an RPC error.
2286 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2287 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2288 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2289 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2290 },
2291 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2292 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2293 &quot;a_key&quot;: &quot;A String&quot;,
2294 },
2295 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2296 # type or metric.
2297 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2298 # or metric.
2299 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2300 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2301 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2302 },
2303 },
2304 ],
2305 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2306 # This property is optional.
2307 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2308 },
2309 ],
2310 },
2311 &quot;getVersionOperationMetadata&quot;: {
2312 &quot;inlineSbomInfo&quot;: {
2313 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2314 # appropriate identifiers.
2315 &quot;a_key&quot;: &quot;A String&quot;,
2316 },
2317 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2318 # identifiers.
2319 &quot;a_key&quot;: &quot;A String&quot;,
2320 },
2321 },
2322 },
2323 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2324 # message that was returned, such as `NOT FOUND`.
2325 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2326 # status code that was returned. For example, a `404` means the
2327 # resource was not found.
2328 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2329 # defined by the server.
2330 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2331 # This value is inRFC3339
2332 # text format.
2333 &quot;instancesBulkInsertOperationMetadata&quot;: {
2334 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2335 # Example key: zones/us-central1-a
2336 &quot;a_key&quot;: {
2337 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2338 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2339 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2340 # error.
2341 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2342 # if the flow is rolling forward or rolling back.
2343 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2344 },
2345 },
2346 },
2347 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2348 # Operation resources.
2349 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2350 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2351 # group of operations results from a `bulkInsert` API request.
2352 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2353 # `update`, or `delete`, and so on.
2354 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2355 # There is no requirement that this be linear or support any granularity of
2356 # operations. This should not be used to guess when the operation will be
2357 # complete. This number should monotonically increase as the operation
2358 # progresses.
2359 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2360 # applicable when performing regional operations.
2361 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2362 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2363 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2364 # this field will contain information on all underlying zonal actions and
2365 # their state.
2366 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2367 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2368 # Example key: zones/us-central1-a
2369 &quot;a_key&quot;: {
2370 &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
2371 # populated.
2372 # different programming environments, including REST APIs and RPC APIs. It is
2373 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2374 # three pieces of data: error code, error message, and error details.
2375 #
2376 # You can find out more about this error model and how to work with it in the
2377 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2378 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2379 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2380 # message types for APIs to use.
2381 {
2382 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2383 },
2384 ],
2385 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2386 # user-facing error message should be localized and sent in the
2387 # google.rpc.Status.details field, or localized by the client.
2388 },
2389 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2390 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2391 },
2392 },
2393 },
2394 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2395 # This value is inRFC3339
2396 # text format.
2397 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2398 # following:
2399 # `PENDING`, `RUNNING`, or `DONE`.
2400 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2401 # operation.
2402 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2403 # of the target resource.
2404 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2405 # operations related to creating a snapshot, this points to the disk
2406 # that the snapshot was created from.
2407 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2408 # `[email protected]` or
2409 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2410 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2411 # operation, this field will be populated.
2412 {
2413 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2414 # Engine returns NO_RESULTS_ON_PAGE if there
2415 # are no results in the response.
2416 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2417 # value format. For example:
2418 #
2419 # &quot;data&quot;: [
2420 # {
2421 # &quot;key&quot;: &quot;scope&quot;,
2422 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2423 # }
2424 {
2425 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2426 # returned. For example, for warnings where there are no results in a list
2427 # request for a particular zone, this key might be scope and
2428 # the key value might be the zone name. Other examples might be a key
2429 # indicating a deprecated resource and a suggested replacement, or a
2430 # warning about invalid network settings (for example, if an instance
2431 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2432 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2433 },
2434 ],
2435 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2436 },
2437 ],
2438 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2439 # applicable when performing per-zone operations.
2440 }</pre>
2441 </div>
2442
2443 <div class="method">
2444 <code class="details" id="close">close()</code>
2445 <pre>Close httplib2 connections.</pre>
2446 </div>
2447
2448 <div class="method">
2449 <code class="details" id="delete">delete(project, firewallPolicy, requestId=None, x__xgafv=None)</code>
2450 <pre>Deletes the specified policy.
2451
2452 Args:
2453 project: string, Project ID for this request. (required)
2454 firewallPolicy: string, Name of the firewall policy to delete. (required)
2455 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2456 that if you must retry your request, the server will know to ignore the
2457 request if it has already been completed.
2458
2459 For example, consider a situation where you make an initial request and
2460 the request times out. If you make the request again with the same
2461 request ID, the server can check if original operation with the same
2462 request ID was received, and if so, will ignore the second request. This
2463 prevents clients from accidentally creating duplicate commitments.
2464
2465 The request ID must be
2466 a valid UUID with the exception that zero UUID is not supported
2467 (00000000-0000-0000-0000-000000000000).
2468 x__xgafv: string, V1 error format.
2469 Allowed values
2470 1 - v1 error format
2471 2 - v2 error format
2472
2473 Returns:
2474 An object of the form:
2475
2476 { # Represents an Operation resource.
2477 #
2478 # Google Compute Engine has three Operation resources:
2479 #
2480 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2481 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2482 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2483 #
2484 # You can use an operation resource to manage asynchronous API requests.
2485 # For more information, readHandling
2486 # API responses.
2487 #
2488 # Operations can be global, regional or zonal.
2489 #
2490 # - For global operations, use the `globalOperations`
2491 # resource.
2492 # - For regional operations, use the
2493 # `regionOperations` resource.
2494 # - For zonal operations, use
2495 # the `zoneOperations` resource.
2496 #
2497 #
2498 #
2499 # For more information, read
2500 # Global, Regional, and Zonal Resources.
2501 #
2502 # Note that completed Operation resources have a limited
2503 # retention period.
2504 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2505 # Not present otherwise.
2506 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2507 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2508 # set when the operation is created.
2509 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2510 # text format.
2511 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2512 # this field will be populated.
2513 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2514 # operation.
2515 {
2516 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2517 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2518 # details. There is a set of defined message types to use for providing
2519 # details.The syntax depends on the error code. For example,
2520 # QuotaExceededInfo will have details when the error code is
2521 # QUOTA_EXCEEDED.
2522 {
2523 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2524 #
2525 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2526 # is not enabled:
2527 #
2528 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2529 # &quot;domain&quot;: &quot;googleapis.com&quot;
2530 # &quot;metadata&quot;: {
2531 # &quot;resource&quot;: &quot;projects/123&quot;,
2532 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2533 # }
2534 # }
2535 #
2536 # This response indicates that the pubsub.googleapis.com API is not enabled.
2537 #
2538 # Example of an error that is returned when attempting to create a Spanner
2539 # instance in a region that is out of stock:
2540 #
2541 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2542 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2543 # &quot;metadata&quot;: {
2544 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2545 # }
2546 # }
2547 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2548 # is typically the registered service name of the tool or product that
2549 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2550 # generated by some common infrastructure, the error domain must be a
2551 # globally unique value that identifies the infrastructure. For Google API
2552 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2553 &quot;metadatas&quot;: { # Additional structured details about this error.
2554 #
2555 # Keys must match a regular expression of `a-z+` but should
2556 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2557 # length. When identifying the current value of an exceeded limit, the units
2558 # should be contained in the key, not the value. For example, rather than
2559 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2560 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2561 # instances that can be created in a single (batch) request.
2562 &quot;a_key&quot;: &quot;A String&quot;,
2563 },
2564 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2565 # proximate cause of the error. Error reasons are unique within a particular
2566 # domain of errors. This should be at most 63 characters and match a
2567 # regular expression of `A-Z+[A-Z0-9]`, which represents
2568 # UPPER_SNAKE_CASE.
2569 },
2570 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2571 #
2572 # For example, if a quota check failed with an error indicating the calling
2573 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2574 # directly to the right place in the developer console to flip the bit.
2575 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2576 { # Describes a URL link.
2577 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2578 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2579 },
2580 ],
2581 },
2582 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2583 # which can be attached to an RPC error.
2584 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2585 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2586 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2587 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2588 },
2589 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2590 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2591 &quot;a_key&quot;: &quot;A String&quot;,
2592 },
2593 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2594 # type or metric.
2595 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2596 # or metric.
2597 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2598 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2599 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2600 },
2601 },
2602 ],
2603 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2604 # This property is optional.
2605 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2606 },
2607 ],
2608 },
2609 &quot;getVersionOperationMetadata&quot;: {
2610 &quot;inlineSbomInfo&quot;: {
2611 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2612 # appropriate identifiers.
2613 &quot;a_key&quot;: &quot;A String&quot;,
2614 },
2615 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2616 # identifiers.
2617 &quot;a_key&quot;: &quot;A String&quot;,
2618 },
2619 },
2620 },
2621 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2622 # message that was returned, such as `NOT FOUND`.
2623 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2624 # status code that was returned. For example, a `404` means the
2625 # resource was not found.
2626 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2627 # defined by the server.
2628 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2629 # This value is inRFC3339
2630 # text format.
2631 &quot;instancesBulkInsertOperationMetadata&quot;: {
2632 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2633 # Example key: zones/us-central1-a
2634 &quot;a_key&quot;: {
2635 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2636 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2637 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2638 # error.
2639 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2640 # if the flow is rolling forward or rolling back.
2641 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2642 },
2643 },
2644 },
2645 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2646 # Operation resources.
2647 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2648 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2649 # group of operations results from a `bulkInsert` API request.
2650 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2651 # `update`, or `delete`, and so on.
2652 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2653 # There is no requirement that this be linear or support any granularity of
2654 # operations. This should not be used to guess when the operation will be
2655 # complete. This number should monotonically increase as the operation
2656 # progresses.
2657 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2658 # applicable when performing regional operations.
2659 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2660 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2661 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2662 # this field will contain information on all underlying zonal actions and
2663 # their state.
2664 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2665 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2666 # Example key: zones/us-central1-a
2667 &quot;a_key&quot;: {
2668 &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
2669 # populated.
2670 # different programming environments, including REST APIs and RPC APIs. It is
2671 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2672 # three pieces of data: error code, error message, and error details.
2673 #
2674 # You can find out more about this error model and how to work with it in the
2675 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2676 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2677 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2678 # message types for APIs to use.
2679 {
2680 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2681 },
2682 ],
2683 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2684 # user-facing error message should be localized and sent in the
2685 # google.rpc.Status.details field, or localized by the client.
2686 },
2687 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2688 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2689 },
2690 },
2691 },
2692 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2693 # This value is inRFC3339
2694 # text format.
2695 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2696 # following:
2697 # `PENDING`, `RUNNING`, or `DONE`.
2698 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2699 # operation.
2700 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2701 # of the target resource.
2702 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2703 # operations related to creating a snapshot, this points to the disk
2704 # that the snapshot was created from.
2705 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2706 # `[email protected]` or
2707 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2708 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2709 # operation, this field will be populated.
2710 {
2711 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2712 # Engine returns NO_RESULTS_ON_PAGE if there
2713 # are no results in the response.
2714 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2715 # value format. For example:
2716 #
2717 # &quot;data&quot;: [
2718 # {
2719 # &quot;key&quot;: &quot;scope&quot;,
2720 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2721 # }
2722 {
2723 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2724 # returned. For example, for warnings where there are no results in a list
2725 # request for a particular zone, this key might be scope and
2726 # the key value might be the zone name. Other examples might be a key
2727 # indicating a deprecated resource and a suggested replacement, or a
2728 # warning about invalid network settings (for example, if an instance
2729 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2730 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2731 },
2732 ],
2733 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2734 },
2735 ],
2736 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2737 # applicable when performing per-zone operations.
2738 }</pre>
2739 </div>
2740
2741 <div class="method">
2742 <code class="details" id="get">get(project, firewallPolicy, x__xgafv=None)</code>
2743 <pre>Returns the specified network firewall policy.
2744
2745 Args:
2746 project: string, Project ID for this request. (required)
2747 firewallPolicy: string, Name of the firewall policy to get. (required)
2748 x__xgafv: string, V1 error format.
2749 Allowed values
2750 1 - v1 error format
2751 2 - v2 error format
2752
2753 Returns:
2754 An object of the form:
2755
2756 { # Represents a Firewall Policy resource.
2757 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
2758 {
2759 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
2760 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
2761 # of the firewall policy of the association.
2762 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
2763 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
2764 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
2765 # must be a positive value between 1 and 2147483647.
2766 # Firewall Policies are evaluated from highest to lowest priority where 1
2767 # is the highest priority and 2147483647 is the lowest priority.
2768 # The default value is `1000`. If two associations have the same priority
2769 # then lexicographical order on association names is applied.
2770 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
2771 },
2772 ],
2773 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2774 # text format.
2775 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2776 # create the resource.
2777 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
2778 # Organization firewall policy. The name should be unique in the organization
2779 # in which the firewall policy is created.
2780 # This field is not applicable to network firewall policies.
2781 # This name must be set on creation and cannot be changed.
2782 # The name must be 1-63 characters long, and comply
2783 # with RFC1035. Specifically, the name must be 1-63 characters
2784 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
2785 # means the first character must be a lowercase letter, and all following
2786 # characters must be a dash, lowercase letter, or digit, except the last
2787 # character, which cannot be a dash.
2788 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
2789 # the metadata&#x27;s contents and used for optimistic locking. The
2790 # fingerprint is initially generated by Compute Engine and changes after
2791 # every request to modify or update metadata. You must always provide an
2792 # up-to-date fingerprint hash in order to update or change metadata,
2793 # otherwise the request will fail with error412 conditionNotMet.
2794 #
2795 # To see the latest fingerprint, make get() request to the
2796 # firewall policy.
2797 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2798 # defined by the server.
2799 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
2800 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
2801 # [Output Only] numeric ID allocated by Google Cloud which uniquely
2802 # identifies the Organization Firewall Policy.
2803 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
2804 { # Represents a rule that describes one or more match conditions along with
2805 # the action to be taken when traffic matches this condition (allow or deny).
2806 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
2807 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
2808 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
2809 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
2810 # and &quot;goto_next&quot;.
2811 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
2812 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
2813 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
2814 # the firewall policy rule is not enforced and traffic behaves as if it did
2815 # not exist. If this is unspecified, the firewall policy rule will be
2816 # enabled.
2817 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
2818 # enabled, logs will be exported to the configured export destination in
2819 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
2820 # cannot enable logging on &quot;goto_next&quot; rules.
2821 &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.
2822 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
2823 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
2824 # Exactly one field must be specified.
2825 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
2826 # Maximum number of destination address groups is 10.
2827 &quot;A String&quot;,
2828 ],
2829 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2830 # traffic destination.
2831 # Maximum number of destination fqdn allowed is 100.
2832 &quot;A String&quot;,
2833 ],
2834 &quot;destIpRanges&quot;: [ # CIDR IP address range.
2835 # Maximum number of destination CIDR IP ranges allowed is 5000.
2836 &quot;A String&quot;,
2837 ],
2838 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
2839 #
2840 #
2841 # - UNSPECIFIED
2842 # - INTERNET
2843 # - NON_INTERNET
2844 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
2845 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
2846 #
2847 #
2848 # - UNSPECIFIED
2849 # - INTERNET
2850 # - NON_INTERNET
2851 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
2852 # of traffic. Should be specified as 2 letter country code defined as per
2853 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2854 # Maximum number of dest region codes allowed is 5000.
2855 &quot;A String&quot;,
2856 ],
2857 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2858 # The IPs in these lists will be matched against traffic destination.
2859 &quot;A String&quot;,
2860 ],
2861 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
2862 {
2863 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
2864 # required when creating a firewall rule. This value can either be
2865 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
2866 # protocol number.
2867 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
2868 # only applicable for UDP or TCP protocol. Each entry must be either
2869 # an integer or a range. If not specified, this rule applies to
2870 # connections through any port.
2871 #
2872 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
2873 &quot;A String&quot;,
2874 ],
2875 },
2876 ],
2877 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
2878 # Maximum number of source address groups is 10.
2879 &quot;A String&quot;,
2880 ],
2881 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2882 # traffic source.
2883 # Maximum number of source fqdn allowed is 100.
2884 &quot;A String&quot;,
2885 ],
2886 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
2887 # Maximum number of source CIDR IP ranges allowed is 5000.
2888 &quot;A String&quot;,
2889 ],
2890 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
2891 #
2892 #
2893 # - UNSPECIFIED
2894 # - INTERNET
2895 # - INTRA_VPC
2896 # - NON_INTERNET
2897 # - VPC_NETWORKS
2898 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
2899 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
2900 #
2901 #
2902 # - UNSPECIFIED
2903 # - INTERNET
2904 # - INTRA_VPC
2905 # - NON_INTERNET
2906 # - VPC_NETWORKS
2907 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
2908 &quot;A String&quot;,
2909 ],
2910 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
2911 # of traffic. Should be specified as 2 letter country code defined as per
2912 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2913 # Maximum number of source region codes allowed is 5000.
2914 &quot;A String&quot;,
2915 ],
2916 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
2917 # of the traffic.
2918 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
2919 # and there is no srcIpRange, this rule will be ignored.
2920 # Maximum number of source tag values allowed is 256.
2921 {
2922 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2923 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2924 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2925 # or its network is deleted.
2926 },
2927 ],
2928 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2929 # The IPs in these lists will be matched against traffic source.
2930 &quot;A String&quot;,
2931 ],
2932 },
2933 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
2934 # must be a positive value between 0 and 2147483647.
2935 # Rules are evaluated from highest to lowest priority where 0 is the
2936 # highest priority and 2147483647 is the lowest priority.
2937 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
2938 # and can be updated.
2939 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
2940 # rule.
2941 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
2942 # Example:
2943 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
2944 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
2945 # &#x27;mirror&#x27;. Cannot be specified for other actions.
2946 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
2947 # This field allows you to control which load balancers get this rule.
2948 # For example, the following are valid values:
2949 #
2950 #
2951 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
2952 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2953 # - projects/project/global/
2954 # forwardingRules/forwardingRule
2955 # - projects/project/regions/region/forwardingRules/
2956 # forwardingRule
2957 &quot;A String&quot;,
2958 ],
2959 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
2960 # allows you to control which network&#x27;s VMs get this rule. If this field
2961 # is left blank, all VMs within the organization will receive the rule.
2962 &quot;A String&quot;,
2963 ],
2964 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
2965 # applies to. If targetSecureTag are specified, then the
2966 # firewall rule applies only to instances in the VPC network that have one
2967 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
2968 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
2969 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
2970 # to all instances on the specified network.
2971 # Maximum number of target label tags allowed is 256.
2972 {
2973 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2974 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2975 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2976 # or its network is deleted.
2977 },
2978 ],
2979 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
2980 # applied with this rule.
2981 &quot;A String&quot;,
2982 ],
2983 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
2984 # Default value is INSTANCES.
2985 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
2986 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
2987 # be set for other actions.
2988 },
2989 ],
2990 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
2991 # This field is not applicable to network firewall policies.
2992 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
2993 # creation and defaults to USER_DEFINED.
2994 #
2995 # The USER_DEFINED value indicates a regular firewall policy.
2996 #
2997 # The SYSTEM value indicates a system-level policy managed by an
2998 # internal service like GKE. This SYSTEM value is reserved for
2999 # internal services and cannot be set by users during policy creation.
3000 # Policies with a SYSTEM source cannot be modified or deleted by
3001 # users.
3002 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
3003 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
3004 #
3005 # Note: if not specified then VPC_POLICY will be used.
3006 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
3007 # This field is not applicable to global firewall policies.
3008 # You must specify this field as part of the HTTP request URL. It is
3009 # not settable as a field in the request body.
3010 &quot;rolloutOperation&quot;: { # Represents progressive rollout input parameters and current status. # Configuration and status of the progressive rollout of this resource.
3011 &quot;rolloutInput&quot;: { # Represents progressive rollout input parameters. # Input parameters to be used by the next not yet scheduled rollout.
3012 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan. Ex.
3013 # organizations//locations/global/rolloutPlans/.
3014 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
3015 &quot;retryUuid&quot;: &quot;A String&quot;, # The UUID of the retry action. Only needed if this is a retry for an
3016 # existing rollout. This can be used after the user canceled a rollout
3017 # and want to retry it with no changes.
3018 },
3019 &quot;rolloutStatus&quot;: { # Represents progressive rollout current status. # [Output only] Current status of the rollout.
3020 &quot;nextRollout&quot;: { # [Output only] The next rollout.
3021 &quot;rolloutId&quot;: &quot;A String&quot;, # Output only. [Output only] The id of the next rollout.
3022 &quot;rolloutPlan&quot;: &quot;A String&quot;, # The name of the rollout plan to be used by the next not yet started
3023 # rollout. This field is auto populated based on RolloutInput when a
3024 # new rollout is scheduled. This can be manually changed before the
3025 # scheduled rollout starts.
3026 # Ex.
3027 # organizations//locations/global/rolloutPlans/
3028 },
3029 &quot;ongoingRollouts&quot;: [ # [Output only] The ongoing rollout.
3030 { # Represents the status of the progressive rollout instance, either
3031 # completed or ongoing.
3032 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
3033 # organizations//locations/global/rollouts/
3034 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
3035 # organizations//locations/global/rolloutPlans/
3036 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
3037 },
3038 ],
3039 &quot;previousRollout&quot;: { # Represents the status of the progressive rollout instance, either # [Output only] The last previously executed rollout.
3040 # completed or ongoing.
3041 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
3042 # organizations//locations/global/rollouts/
3043 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
3044 # organizations//locations/global/rolloutPlans/
3045 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
3046 },
3047 },
3048 },
3049 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
3050 # policy can not exceed a set number of tuples.
3051 &quot;rules&quot;: [ # A list of rules that belong to this policy.
3052 # There must always be a default rule (rule with priority 2147483647 and
3053 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
3054 # default rule with action &quot;allow&quot; will be added.
3055 { # Represents a rule that describes one or more match conditions along with
3056 # the action to be taken when traffic matches this condition (allow or deny).
3057 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3058 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3059 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3060 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3061 # and &quot;goto_next&quot;.
3062 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3063 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3064 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3065 # the firewall policy rule is not enforced and traffic behaves as if it did
3066 # not exist. If this is unspecified, the firewall policy rule will be
3067 # enabled.
3068 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3069 # enabled, logs will be exported to the configured export destination in
3070 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3071 # cannot enable logging on &quot;goto_next&quot; rules.
3072 &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.
3073 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3074 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3075 # Exactly one field must be specified.
3076 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3077 # Maximum number of destination address groups is 10.
3078 &quot;A String&quot;,
3079 ],
3080 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3081 # traffic destination.
3082 # Maximum number of destination fqdn allowed is 100.
3083 &quot;A String&quot;,
3084 ],
3085 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3086 # Maximum number of destination CIDR IP ranges allowed is 5000.
3087 &quot;A String&quot;,
3088 ],
3089 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3090 #
3091 #
3092 # - UNSPECIFIED
3093 # - INTERNET
3094 # - NON_INTERNET
3095 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3096 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3097 #
3098 #
3099 # - UNSPECIFIED
3100 # - INTERNET
3101 # - NON_INTERNET
3102 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3103 # of traffic. Should be specified as 2 letter country code defined as per
3104 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3105 # Maximum number of dest region codes allowed is 5000.
3106 &quot;A String&quot;,
3107 ],
3108 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3109 # The IPs in these lists will be matched against traffic destination.
3110 &quot;A String&quot;,
3111 ],
3112 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3113 {
3114 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3115 # required when creating a firewall rule. This value can either be
3116 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3117 # protocol number.
3118 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3119 # only applicable for UDP or TCP protocol. Each entry must be either
3120 # an integer or a range. If not specified, this rule applies to
3121 # connections through any port.
3122 #
3123 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3124 &quot;A String&quot;,
3125 ],
3126 },
3127 ],
3128 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3129 # Maximum number of source address groups is 10.
3130 &quot;A String&quot;,
3131 ],
3132 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3133 # traffic source.
3134 # Maximum number of source fqdn allowed is 100.
3135 &quot;A String&quot;,
3136 ],
3137 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3138 # Maximum number of source CIDR IP ranges allowed is 5000.
3139 &quot;A String&quot;,
3140 ],
3141 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3142 #
3143 #
3144 # - UNSPECIFIED
3145 # - INTERNET
3146 # - INTRA_VPC
3147 # - NON_INTERNET
3148 # - VPC_NETWORKS
3149 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3150 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3151 #
3152 #
3153 # - UNSPECIFIED
3154 # - INTERNET
3155 # - INTRA_VPC
3156 # - NON_INTERNET
3157 # - VPC_NETWORKS
3158 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3159 &quot;A String&quot;,
3160 ],
3161 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3162 # of traffic. Should be specified as 2 letter country code defined as per
3163 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3164 # Maximum number of source region codes allowed is 5000.
3165 &quot;A String&quot;,
3166 ],
3167 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3168 # of the traffic.
3169 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3170 # and there is no srcIpRange, this rule will be ignored.
3171 # Maximum number of source tag values allowed is 256.
3172 {
3173 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3174 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3175 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3176 # or its network is deleted.
3177 },
3178 ],
3179 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3180 # The IPs in these lists will be matched against traffic source.
3181 &quot;A String&quot;,
3182 ],
3183 },
3184 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3185 # must be a positive value between 0 and 2147483647.
3186 # Rules are evaluated from highest to lowest priority where 0 is the
3187 # highest priority and 2147483647 is the lowest priority.
3188 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3189 # and can be updated.
3190 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3191 # rule.
3192 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3193 # Example:
3194 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3195 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3196 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3197 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3198 # This field allows you to control which load balancers get this rule.
3199 # For example, the following are valid values:
3200 #
3201 #
3202 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3203 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3204 # - projects/project/global/
3205 # forwardingRules/forwardingRule
3206 # - projects/project/regions/region/forwardingRules/
3207 # forwardingRule
3208 &quot;A String&quot;,
3209 ],
3210 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3211 # allows you to control which network&#x27;s VMs get this rule. If this field
3212 # is left blank, all VMs within the organization will receive the rule.
3213 &quot;A String&quot;,
3214 ],
3215 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3216 # applies to. If targetSecureTag are specified, then the
3217 # firewall rule applies only to instances in the VPC network that have one
3218 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3219 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3220 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3221 # to all instances on the specified network.
3222 # Maximum number of target label tags allowed is 256.
3223 {
3224 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3225 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3226 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3227 # or its network is deleted.
3228 },
3229 ],
3230 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3231 # applied with this rule.
3232 &quot;A String&quot;,
3233 ],
3234 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3235 # Default value is INSTANCES.
3236 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3237 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3238 # be set for other actions.
3239 },
3240 ],
3241 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3242 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3243 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
3244 # unique in the organization in which the firewall policy is created.
3245 # This field is not applicable to network firewall policies.
3246 # This name must be set on creation and cannot be changed. The name must be
3247 # 1-63 characters long, and comply with RFC1035.
3248 # Specifically, the name must be 1-63 characters long and match the regular
3249 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3250 # character must be a lowercase letter, and all following characters must
3251 # be a dash, lowercase letter, or digit, except the last character, which
3252 # cannot be a dash.
3253 &quot;vpcNetworkScope&quot;: &quot;A String&quot;, # The scope of networks allowed to be associated with the firewall
3254 # policy. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.
3255 #
3256 # A firewall policy with the VPC scope set to GLOBAL_VPC_NETWORK
3257 # is allowed to be attached only to global networks.
3258 #
3259 # When the VPC scope is set to REGIONAL_VPC_NETWORK the firewall
3260 # policy is allowed to be attached only to regional networks in the same
3261 # scope as the firewall policy.
3262 #
3263 # Note: if not specified then GLOBAL_VPC_NETWORK will be used.
3264 }</pre>
3265 </div>
3266
3267 <div class="method">
3268 <code class="details" id="getAssociation">getAssociation(project, firewallPolicy, name=None, x__xgafv=None)</code>
3269 <pre>Gets an association with the specified name.
3270
3271 Args:
3272 project: string, Project ID for this request. (required)
3273 firewallPolicy: string, Name of the firewall policy to which the queried association belongs. (required)
3274 name: string, The name of the association to get from the firewall policy.
3275 x__xgafv: string, V1 error format.
3276 Allowed values
3277 1 - v1 error format
3278 2 - v2 error format
3279
3280 Returns:
3281 An object of the form:
3282
3283 {
3284 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
3285 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
3286 # of the firewall policy of the association.
3287 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
3288 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
3289 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
3290 # must be a positive value between 1 and 2147483647.
3291 # Firewall Policies are evaluated from highest to lowest priority where 1
3292 # is the highest priority and 2147483647 is the lowest priority.
3293 # The default value is `1000`. If two associations have the same priority
3294 # then lexicographical order on association names is applied.
3295 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
3296 }</pre>
3297 </div>
3298
3299 <div class="method">
3300 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
3301 <pre>Gets the access control policy for a resource. May be empty if no such
3302 policy or resource exists.
3303
3304 Args:
3305 project: string, Project ID for this request. (required)
3306 resource: string, Name or id of the resource for this request. (required)
3307 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
3308 x__xgafv: string, V1 error format.
3309 Allowed values
3310 1 - v1 error format
3311 2 - v2 error format
3312
3313 Returns:
3314 An object of the form:
3315
3316 { # An Identity and Access Management (IAM) policy, which specifies access
3317 # controls for Google Cloud resources.
3318 #
3319 #
3320 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3321 # `members`, or principals, to a single `role`. Principals can be user
3322 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3323 # `role` is a named list of permissions; each `role` can be an IAM predefined
3324 # role or a user-created custom role.
3325 #
3326 # For some types of Google Cloud resources, a `binding` can also specify a
3327 # `condition`, which is a logical expression that allows access to a resource
3328 # only if the expression evaluates to `true`. A condition can add constraints
3329 # based on attributes of the request, the resource, or both. To learn which
3330 # resources support conditions in their IAM policies, see the
3331 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3332 #
3333 # **JSON example:**
3334 #
3335 # ```
3336 # {
3337 # &quot;bindings&quot;: [
3338 # {
3339 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3340 # &quot;members&quot;: [
3341 # &quot;user:[email protected]&quot;,
3342 # &quot;group:[email protected]&quot;,
3343 # &quot;domain:google.com&quot;,
3344 # &quot;serviceAccount:[email protected]&quot;
3345 # ]
3346 # },
3347 # {
3348 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3349 # &quot;members&quot;: [
3350 # &quot;user:[email protected]&quot;
3351 # ],
3352 # &quot;condition&quot;: {
3353 # &quot;title&quot;: &quot;expirable access&quot;,
3354 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3355 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3356 # }
3357 # }
3358 # ],
3359 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3360 # &quot;version&quot;: 3
3361 # }
3362 # ```
3363 #
3364 # **YAML example:**
3365 #
3366 # ```
3367 # bindings:
3368 # - members:
3369 # - user:[email protected]
3370 # - group:[email protected]
3371 # - domain:google.com
3372 # - serviceAccount:[email protected]
3373 # role: roles/resourcemanager.organizationAdmin
3374 # - members:
3375 # - user:[email protected]
3376 # role: roles/resourcemanager.organizationViewer
3377 # condition:
3378 # title: expirable access
3379 # description: Does not grant access after Sep 2020
3380 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3381 # etag: BwWWja0YfJA=
3382 # version: 3
3383 # ```
3384 #
3385 # For a description of IAM and its features, see the
3386 # [IAM documentation](https://cloud.google.com/iam/docs/).
3387 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3388 { # Specifies the audit configuration for a service.
3389 # The configuration determines which permission types are logged, and what
3390 # identities, if any, are exempted from logging.
3391 # An AuditConfig must have one or more AuditLogConfigs.
3392 #
3393 # If there are AuditConfigs for both `allServices` and a specific service,
3394 # the union of the two AuditConfigs is used for that service: the log_types
3395 # specified in each AuditConfig are enabled, and the exempted_members in each
3396 # AuditLogConfig are exempted.
3397 #
3398 # Example Policy with multiple AuditConfigs:
3399 #
3400 # {
3401 # &quot;audit_configs&quot;: [
3402 # {
3403 # &quot;service&quot;: &quot;allServices&quot;,
3404 # &quot;audit_log_configs&quot;: [
3405 # {
3406 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3407 # &quot;exempted_members&quot;: [
3408 # &quot;user:[email protected]&quot;
3409 # ]
3410 # },
3411 # {
3412 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3413 # },
3414 # {
3415 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3416 # }
3417 # ]
3418 # },
3419 # {
3420 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3421 # &quot;audit_log_configs&quot;: [
3422 # {
3423 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3424 # },
3425 # {
3426 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3427 # &quot;exempted_members&quot;: [
3428 # &quot;user:[email protected]&quot;
3429 # ]
3430 # }
3431 # ]
3432 # }
3433 # ]
3434 # }
3435 #
3436 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3437 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3438 # `[email protected]` from DATA_WRITE logging.
3439 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3440 { # Provides the configuration for logging a type of permissions.
3441 # Example:
3442 #
3443 # {
3444 # &quot;audit_log_configs&quot;: [
3445 # {
3446 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3447 # &quot;exempted_members&quot;: [
3448 # &quot;user:[email protected]&quot;
3449 # ]
3450 # },
3451 # {
3452 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3453 # }
3454 # ]
3455 # }
3456 #
3457 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3458 # [email protected] from DATA_READ logging.
3459 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3460 # permission.
3461 # Follows the same format of Binding.members.
3462 &quot;A String&quot;,
3463 ],
3464 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3465 },
3466 ],
3467 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3468 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3469 # `allServices` is a special value that covers all services.
3470 },
3471 ],
3472 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3473 # may specify a `condition` that determines how and when the `bindings` are
3474 # applied. Each of the `bindings` must contain at least one principal.
3475 #
3476 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3477 # of these principals can be Google groups. Each occurrence of a principal
3478 # counts towards these limits. For example, if the `bindings` grant 50
3479 # different roles to `user:[email protected]`, and not to any other
3480 # principal, then you can add another 1,450 principals to the `bindings` in
3481 # the `Policy`.
3482 { # Associates `members`, or principals, with a `role`.
3483 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3484 #
3485 # If the condition evaluates to `true`, then this binding applies to the
3486 # current request.
3487 #
3488 # If the condition evaluates to `false`, then this binding does not apply to
3489 # the current request. However, a different role binding might grant the same
3490 # role to one or more of the principals in this binding.
3491 #
3492 # To learn which resources support conditions in their IAM policies, see the
3493 # [IAM
3494 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3495 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3496 # are documented at https://github.com/google/cel-spec.
3497 #
3498 # Example (Comparison):
3499 #
3500 # title: &quot;Summary size limit&quot;
3501 # description: &quot;Determines if a summary is less than 100 chars&quot;
3502 # expression: &quot;document.summary.size() &lt; 100&quot;
3503 #
3504 # Example (Equality):
3505 #
3506 # title: &quot;Requestor is owner&quot;
3507 # description: &quot;Determines if requestor is the document owner&quot;
3508 # expression: &quot;document.owner == request.auth.claims.email&quot;
3509 #
3510 # Example (Logic):
3511 #
3512 # title: &quot;Public documents&quot;
3513 # description: &quot;Determine whether the document should be publicly visible&quot;
3514 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3515 #
3516 # Example (Data Manipulation):
3517 #
3518 # title: &quot;Notification string&quot;
3519 # description: &quot;Create a notification string with a timestamp.&quot;
3520 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3521 #
3522 # The exact variables and functions that may be referenced within an expression
3523 # are determined by the service that evaluates it. See the service
3524 # documentation for additional information.
3525 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3526 # describes the expression, e.g. when hovered over it in a UI.
3527 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3528 # syntax.
3529 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3530 # reporting, e.g. a file name and a position in the file.
3531 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3532 # its purpose. This can be used e.g. in UIs which allow to enter the
3533 # expression.
3534 },
3535 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3536 # `members` can have the following values:
3537 #
3538 # * `allUsers`: A special identifier that represents anyone who is
3539 # on the internet; with or without a Google account.
3540 #
3541 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3542 # who is authenticated with a Google account or a service account.
3543 # Does not include identities that come from external identity providers
3544 # (IdPs) through identity federation.
3545 #
3546 # * `user:{emailid}`: An email address that represents a specific Google
3547 # account. For example, `[email protected]` .
3548 #
3549 #
3550 # * `serviceAccount:{emailid}`: An email address that represents a Google
3551 # service account. For example,
3552 # `[email protected]`.
3553 #
3554 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3555 # identifier for a
3556 # [Kubernetes service
3557 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3558 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3559 #
3560 # * `group:{emailid}`: An email address that represents a Google group.
3561 # For example, `[email protected]`.
3562 #
3563 #
3564 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3565 # users of that domain. For example, `google.com` or `example.com`.
3566 #
3567 #
3568 #
3569 #
3570 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3571 # A single identity in a workforce identity pool.
3572 #
3573 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3574 # All workforce identities in a group.
3575 #
3576 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3577 # All workforce identities with a specific attribute value.
3578 #
3579 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3580 # All identities in a workforce identity pool.
3581 #
3582 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3583 # A single identity in a workload identity pool.
3584 #
3585 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3586 # A workload identity pool group.
3587 #
3588 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3589 # All identities in a workload identity pool with a certain attribute.
3590 #
3591 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3592 # All identities in a workload identity pool.
3593 #
3594 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3595 # identifier) representing a user that has been recently deleted. For
3596 # example, `[email protected]?uid=123456789012345678901`. If the user is
3597 # recovered, this value reverts to `user:{emailid}` and the recovered user
3598 # retains the role in the binding.
3599 #
3600 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3601 # unique identifier) representing a service account that has been recently
3602 # deleted. For example,
3603 # `[email protected]?uid=123456789012345678901`.
3604 # If the service account is undeleted, this value reverts to
3605 # `serviceAccount:{emailid}` and the undeleted service account retains the
3606 # role in the binding.
3607 #
3608 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3609 # identifier) representing a Google group that has been recently
3610 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3611 # the group is recovered, this value reverts to `group:{emailid}` and the
3612 # recovered group retains the role in the binding.
3613 #
3614 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3615 # Deleted single identity in a workforce identity pool. For example,
3616 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3617 &quot;A String&quot;,
3618 ],
3619 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3620 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3621 #
3622 # For an overview of the IAM roles and permissions, see the
3623 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3624 # a list of the available pre-defined roles, see
3625 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3626 },
3627 ],
3628 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3629 # prevent simultaneous updates of a policy from overwriting each other.
3630 # It is strongly suggested that systems make use of the `etag` in the
3631 # read-modify-write cycle to perform policy updates in order to avoid race
3632 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3633 # systems are expected to put that etag in the request to `setIamPolicy` to
3634 # ensure that their change will be applied to the same version of the policy.
3635 #
3636 # **Important:** If you use IAM Conditions, you must include the `etag` field
3637 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3638 # you to overwrite a version `3` policy with a version `1` policy, and all of
3639 # the conditions in the version `3` policy are lost.
3640 &quot;version&quot;: 42, # Specifies the format of the policy.
3641 #
3642 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3643 # are rejected.
3644 #
3645 # Any operation that affects conditional role bindings must specify version
3646 # `3`. This requirement applies to the following operations:
3647 #
3648 # * Getting a policy that includes a conditional role binding
3649 # * Adding a conditional role binding to a policy
3650 # * Changing a conditional role binding in a policy
3651 # * Removing any role binding, with or without a condition, from a policy
3652 # that includes conditions
3653 #
3654 # **Important:** If you use IAM Conditions, you must include the `etag` field
3655 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3656 # you to overwrite a version `3` policy with a version `1` policy, and all of
3657 # the conditions in the version `3` policy are lost.
3658 #
3659 # If a policy does not include any conditions, operations on that policy may
3660 # specify any valid version or leave the field unset.
3661 #
3662 # To learn which resources support conditions in their IAM policies, see the
3663 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3664 }</pre>
3665 </div>
3666
3667 <div class="method">
3668 <code class="details" id="getPacketMirroringRule">getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None)</code>
3669 <pre>Gets a packet mirroring rule of the specified priority.
3670
3671 Args:
3672 project: string, Project ID for this request. (required)
3673 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
3674 priority: integer, The priority of the rule to get from the firewall policy.
3675 x__xgafv: string, V1 error format.
3676 Allowed values
3677 1 - v1 error format
3678 2 - v2 error format
3679
3680 Returns:
3681 An object of the form:
3682
3683 { # Represents a rule that describes one or more match conditions along with
3684 # the action to be taken when traffic matches this condition (allow or deny).
3685 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3686 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3687 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3688 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3689 # and &quot;goto_next&quot;.
3690 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3691 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3692 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3693 # the firewall policy rule is not enforced and traffic behaves as if it did
3694 # not exist. If this is unspecified, the firewall policy rule will be
3695 # enabled.
3696 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3697 # enabled, logs will be exported to the configured export destination in
3698 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3699 # cannot enable logging on &quot;goto_next&quot; rules.
3700 &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.
3701 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3702 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3703 # Exactly one field must be specified.
3704 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3705 # Maximum number of destination address groups is 10.
3706 &quot;A String&quot;,
3707 ],
3708 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3709 # traffic destination.
3710 # Maximum number of destination fqdn allowed is 100.
3711 &quot;A String&quot;,
3712 ],
3713 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3714 # Maximum number of destination CIDR IP ranges allowed is 5000.
3715 &quot;A String&quot;,
3716 ],
3717 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3718 #
3719 #
3720 # - UNSPECIFIED
3721 # - INTERNET
3722 # - NON_INTERNET
3723 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3724 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3725 #
3726 #
3727 # - UNSPECIFIED
3728 # - INTERNET
3729 # - NON_INTERNET
3730 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3731 # of traffic. Should be specified as 2 letter country code defined as per
3732 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3733 # Maximum number of dest region codes allowed is 5000.
3734 &quot;A String&quot;,
3735 ],
3736 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3737 # The IPs in these lists will be matched against traffic destination.
3738 &quot;A String&quot;,
3739 ],
3740 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3741 {
3742 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3743 # required when creating a firewall rule. This value can either be
3744 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3745 # protocol number.
3746 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3747 # only applicable for UDP or TCP protocol. Each entry must be either
3748 # an integer or a range. If not specified, this rule applies to
3749 # connections through any port.
3750 #
3751 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3752 &quot;A String&quot;,
3753 ],
3754 },
3755 ],
3756 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3757 # Maximum number of source address groups is 10.
3758 &quot;A String&quot;,
3759 ],
3760 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3761 # traffic source.
3762 # Maximum number of source fqdn allowed is 100.
3763 &quot;A String&quot;,
3764 ],
3765 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3766 # Maximum number of source CIDR IP ranges allowed is 5000.
3767 &quot;A String&quot;,
3768 ],
3769 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3770 #
3771 #
3772 # - UNSPECIFIED
3773 # - INTERNET
3774 # - INTRA_VPC
3775 # - NON_INTERNET
3776 # - VPC_NETWORKS
3777 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3778 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3779 #
3780 #
3781 # - UNSPECIFIED
3782 # - INTERNET
3783 # - INTRA_VPC
3784 # - NON_INTERNET
3785 # - VPC_NETWORKS
3786 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3787 &quot;A String&quot;,
3788 ],
3789 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3790 # of traffic. Should be specified as 2 letter country code defined as per
3791 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3792 # Maximum number of source region codes allowed is 5000.
3793 &quot;A String&quot;,
3794 ],
3795 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3796 # of the traffic.
3797 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3798 # and there is no srcIpRange, this rule will be ignored.
3799 # Maximum number of source tag values allowed is 256.
3800 {
3801 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3802 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3803 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3804 # or its network is deleted.
3805 },
3806 ],
3807 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3808 # The IPs in these lists will be matched against traffic source.
3809 &quot;A String&quot;,
3810 ],
3811 },
3812 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3813 # must be a positive value between 0 and 2147483647.
3814 # Rules are evaluated from highest to lowest priority where 0 is the
3815 # highest priority and 2147483647 is the lowest priority.
3816 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3817 # and can be updated.
3818 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3819 # rule.
3820 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3821 # Example:
3822 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3823 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3824 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3825 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3826 # This field allows you to control which load balancers get this rule.
3827 # For example, the following are valid values:
3828 #
3829 #
3830 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3831 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3832 # - projects/project/global/
3833 # forwardingRules/forwardingRule
3834 # - projects/project/regions/region/forwardingRules/
3835 # forwardingRule
3836 &quot;A String&quot;,
3837 ],
3838 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3839 # allows you to control which network&#x27;s VMs get this rule. If this field
3840 # is left blank, all VMs within the organization will receive the rule.
3841 &quot;A String&quot;,
3842 ],
3843 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3844 # applies to. If targetSecureTag are specified, then the
3845 # firewall rule applies only to instances in the VPC network that have one
3846 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3847 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3848 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3849 # to all instances on the specified network.
3850 # Maximum number of target label tags allowed is 256.
3851 {
3852 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3853 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3854 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3855 # or its network is deleted.
3856 },
3857 ],
3858 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3859 # applied with this rule.
3860 &quot;A String&quot;,
3861 ],
3862 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3863 # Default value is INSTANCES.
3864 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3865 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3866 # be set for other actions.
3867 }</pre>
3868 </div>
3869
3870 <div class="method">
3871 <code class="details" id="getRule">getRule(project, firewallPolicy, priority=None, x__xgafv=None)</code>
3872 <pre>Gets a rule of the specified priority.
3873
3874 Args:
3875 project: string, Project ID for this request. (required)
3876 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
3877 priority: integer, The priority of the rule to get from the firewall policy.
3878 x__xgafv: string, V1 error format.
3879 Allowed values
3880 1 - v1 error format
3881 2 - v2 error format
3882
3883 Returns:
3884 An object of the form:
3885
3886 { # Represents a rule that describes one or more match conditions along with
3887 # the action to be taken when traffic matches this condition (allow or deny).
3888 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3889 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3890 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3891 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3892 # and &quot;goto_next&quot;.
3893 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3894 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3895 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3896 # the firewall policy rule is not enforced and traffic behaves as if it did
3897 # not exist. If this is unspecified, the firewall policy rule will be
3898 # enabled.
3899 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3900 # enabled, logs will be exported to the configured export destination in
3901 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3902 # cannot enable logging on &quot;goto_next&quot; rules.
3903 &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.
3904 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3905 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3906 # Exactly one field must be specified.
3907 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3908 # Maximum number of destination address groups is 10.
3909 &quot;A String&quot;,
3910 ],
3911 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3912 # traffic destination.
3913 # Maximum number of destination fqdn allowed is 100.
3914 &quot;A String&quot;,
3915 ],
3916 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3917 # Maximum number of destination CIDR IP ranges allowed is 5000.
3918 &quot;A String&quot;,
3919 ],
3920 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3921 #
3922 #
3923 # - UNSPECIFIED
3924 # - INTERNET
3925 # - NON_INTERNET
3926 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3927 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3928 #
3929 #
3930 # - UNSPECIFIED
3931 # - INTERNET
3932 # - NON_INTERNET
3933 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3934 # of traffic. Should be specified as 2 letter country code defined as per
3935 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3936 # Maximum number of dest region codes allowed is 5000.
3937 &quot;A String&quot;,
3938 ],
3939 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3940 # The IPs in these lists will be matched against traffic destination.
3941 &quot;A String&quot;,
3942 ],
3943 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3944 {
3945 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3946 # required when creating a firewall rule. This value can either be
3947 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3948 # protocol number.
3949 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3950 # only applicable for UDP or TCP protocol. Each entry must be either
3951 # an integer or a range. If not specified, this rule applies to
3952 # connections through any port.
3953 #
3954 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3955 &quot;A String&quot;,
3956 ],
3957 },
3958 ],
3959 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3960 # Maximum number of source address groups is 10.
3961 &quot;A String&quot;,
3962 ],
3963 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3964 # traffic source.
3965 # Maximum number of source fqdn allowed is 100.
3966 &quot;A String&quot;,
3967 ],
3968 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3969 # Maximum number of source CIDR IP ranges allowed is 5000.
3970 &quot;A String&quot;,
3971 ],
3972 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3973 #
3974 #
3975 # - UNSPECIFIED
3976 # - INTERNET
3977 # - INTRA_VPC
3978 # - NON_INTERNET
3979 # - VPC_NETWORKS
3980 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3981 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3982 #
3983 #
3984 # - UNSPECIFIED
3985 # - INTERNET
3986 # - INTRA_VPC
3987 # - NON_INTERNET
3988 # - VPC_NETWORKS
3989 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3990 &quot;A String&quot;,
3991 ],
3992 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3993 # of traffic. Should be specified as 2 letter country code defined as per
3994 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3995 # Maximum number of source region codes allowed is 5000.
3996 &quot;A String&quot;,
3997 ],
3998 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3999 # of the traffic.
4000 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4001 # and there is no srcIpRange, this rule will be ignored.
4002 # Maximum number of source tag values allowed is 256.
4003 {
4004 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4005 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4006 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4007 # or its network is deleted.
4008 },
4009 ],
4010 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4011 # The IPs in these lists will be matched against traffic source.
4012 &quot;A String&quot;,
4013 ],
4014 },
4015 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4016 # must be a positive value between 0 and 2147483647.
4017 # Rules are evaluated from highest to lowest priority where 0 is the
4018 # highest priority and 2147483647 is the lowest priority.
4019 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4020 # and can be updated.
4021 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4022 # rule.
4023 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4024 # Example:
4025 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4026 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4027 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4028 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4029 # This field allows you to control which load balancers get this rule.
4030 # For example, the following are valid values:
4031 #
4032 #
4033 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4034 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4035 # - projects/project/global/
4036 # forwardingRules/forwardingRule
4037 # - projects/project/regions/region/forwardingRules/
4038 # forwardingRule
4039 &quot;A String&quot;,
4040 ],
4041 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4042 # allows you to control which network&#x27;s VMs get this rule. If this field
4043 # is left blank, all VMs within the organization will receive the rule.
4044 &quot;A String&quot;,
4045 ],
4046 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4047 # applies to. If targetSecureTag are specified, then the
4048 # firewall rule applies only to instances in the VPC network that have one
4049 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4050 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
4051 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
4052 # to all instances on the specified network.
4053 # Maximum number of target label tags allowed is 256.
4054 {
4055 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4056 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4057 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4058 # or its network is deleted.
4059 },
4060 ],
4061 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4062 # applied with this rule.
4063 &quot;A String&quot;,
4064 ],
4065 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
4066 # Default value is INSTANCES.
4067 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
4068 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
4069 # be set for other actions.
4070 }</pre>
4071 </div>
4072
4073 <div class="method">
4074 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
4075 <pre>Creates a new policy in the specified project using the data included in
4076 the request.
4077
4078 Args:
4079 project: string, Project ID for this request. (required)
4080 body: object, The request body.
4081 The object takes the form of:
4082
4083 { # Represents a Firewall Policy resource.
4084 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
4085 {
4086 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
4087 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
4088 # of the firewall policy of the association.
4089 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
4090 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
4091 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
4092 # must be a positive value between 1 and 2147483647.
4093 # Firewall Policies are evaluated from highest to lowest priority where 1
4094 # is the highest priority and 2147483647 is the lowest priority.
4095 # The default value is `1000`. If two associations have the same priority
4096 # then lexicographical order on association names is applied.
4097 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
4098 },
4099 ],
4100 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4101 # text format.
4102 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4103 # create the resource.
4104 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
4105 # Organization firewall policy. The name should be unique in the organization
4106 # in which the firewall policy is created.
4107 # This field is not applicable to network firewall policies.
4108 # This name must be set on creation and cannot be changed.
4109 # The name must be 1-63 characters long, and comply
4110 # with RFC1035. Specifically, the name must be 1-63 characters
4111 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
4112 # means the first character must be a lowercase letter, and all following
4113 # characters must be a dash, lowercase letter, or digit, except the last
4114 # character, which cannot be a dash.
4115 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
4116 # the metadata&#x27;s contents and used for optimistic locking. The
4117 # fingerprint is initially generated by Compute Engine and changes after
4118 # every request to modify or update metadata. You must always provide an
4119 # up-to-date fingerprint hash in order to update or change metadata,
4120 # otherwise the request will fail with error412 conditionNotMet.
4121 #
4122 # To see the latest fingerprint, make get() request to the
4123 # firewall policy.
4124 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4125 # defined by the server.
4126 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
4127 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
4128 # [Output Only] numeric ID allocated by Google Cloud which uniquely
4129 # identifies the Organization Firewall Policy.
4130 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
4131 { # Represents a rule that describes one or more match conditions along with
4132 # the action to be taken when traffic matches this condition (allow or deny).
4133 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
4134 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
4135 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
4136 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
4137 # and &quot;goto_next&quot;.
4138 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
4139 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
4140 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
4141 # the firewall policy rule is not enforced and traffic behaves as if it did
4142 # not exist. If this is unspecified, the firewall policy rule will be
4143 # enabled.
4144 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4145 # enabled, logs will be exported to the configured export destination in
4146 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4147 # cannot enable logging on &quot;goto_next&quot; rules.
4148 &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.
4149 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4150 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4151 # Exactly one field must be specified.
4152 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
4153 # Maximum number of destination address groups is 10.
4154 &quot;A String&quot;,
4155 ],
4156 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4157 # traffic destination.
4158 # Maximum number of destination fqdn allowed is 100.
4159 &quot;A String&quot;,
4160 ],
4161 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4162 # Maximum number of destination CIDR IP ranges allowed is 5000.
4163 &quot;A String&quot;,
4164 ],
4165 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
4166 #
4167 #
4168 # - UNSPECIFIED
4169 # - INTERNET
4170 # - NON_INTERNET
4171 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
4172 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
4173 #
4174 #
4175 # - UNSPECIFIED
4176 # - INTERNET
4177 # - NON_INTERNET
4178 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
4179 # of traffic. Should be specified as 2 letter country code defined as per
4180 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4181 # Maximum number of dest region codes allowed is 5000.
4182 &quot;A String&quot;,
4183 ],
4184 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4185 # The IPs in these lists will be matched against traffic destination.
4186 &quot;A String&quot;,
4187 ],
4188 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4189 {
4190 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4191 # required when creating a firewall rule. This value can either be
4192 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4193 # protocol number.
4194 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4195 # only applicable for UDP or TCP protocol. Each entry must be either
4196 # an integer or a range. If not specified, this rule applies to
4197 # connections through any port.
4198 #
4199 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4200 &quot;A String&quot;,
4201 ],
4202 },
4203 ],
4204 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4205 # Maximum number of source address groups is 10.
4206 &quot;A String&quot;,
4207 ],
4208 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4209 # traffic source.
4210 # Maximum number of source fqdn allowed is 100.
4211 &quot;A String&quot;,
4212 ],
4213 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4214 # Maximum number of source CIDR IP ranges allowed is 5000.
4215 &quot;A String&quot;,
4216 ],
4217 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4218 #
4219 #
4220 # - UNSPECIFIED
4221 # - INTERNET
4222 # - INTRA_VPC
4223 # - NON_INTERNET
4224 # - VPC_NETWORKS
4225 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4226 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4227 #
4228 #
4229 # - UNSPECIFIED
4230 # - INTERNET
4231 # - INTRA_VPC
4232 # - NON_INTERNET
4233 # - VPC_NETWORKS
4234 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4235 &quot;A String&quot;,
4236 ],
4237 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4238 # of traffic. Should be specified as 2 letter country code defined as per
4239 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4240 # Maximum number of source region codes allowed is 5000.
4241 &quot;A String&quot;,
4242 ],
4243 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4244 # of the traffic.
4245 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4246 # and there is no srcIpRange, this rule will be ignored.
4247 # Maximum number of source tag values allowed is 256.
4248 {
4249 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4250 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4251 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4252 # or its network is deleted.
4253 },
4254 ],
4255 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4256 # The IPs in these lists will be matched against traffic source.
4257 &quot;A String&quot;,
4258 ],
4259 },
4260 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4261 # must be a positive value between 0 and 2147483647.
4262 # Rules are evaluated from highest to lowest priority where 0 is the
4263 # highest priority and 2147483647 is the lowest priority.
4264 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4265 # and can be updated.
4266 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4267 # rule.
4268 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4269 # Example:
4270 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4271 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4272 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4273 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4274 # This field allows you to control which load balancers get this rule.
4275 # For example, the following are valid values:
4276 #
4277 #
4278 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4279 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4280 # - projects/project/global/
4281 # forwardingRules/forwardingRule
4282 # - projects/project/regions/region/forwardingRules/
4283 # forwardingRule
4284 &quot;A String&quot;,
4285 ],
4286 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4287 # allows you to control which network&#x27;s VMs get this rule. If this field
4288 # is left blank, all VMs within the organization will receive the rule.
4289 &quot;A String&quot;,
4290 ],
4291 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4292 # applies to. If targetSecureTag are specified, then the
4293 # firewall rule applies only to instances in the VPC network that have one
4294 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4295 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
4296 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
4297 # to all instances on the specified network.
4298 # Maximum number of target label tags allowed is 256.
4299 {
4300 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4301 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4302 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4303 # or its network is deleted.
4304 },
4305 ],
4306 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4307 # applied with this rule.
4308 &quot;A String&quot;,
4309 ],
4310 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
4311 # Default value is INSTANCES.
4312 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
4313 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
4314 # be set for other actions.
4315 },
4316 ],
4317 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
4318 # This field is not applicable to network firewall policies.
4319 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
4320 # creation and defaults to USER_DEFINED.
4321 #
4322 # The USER_DEFINED value indicates a regular firewall policy.
4323 #
4324 # The SYSTEM value indicates a system-level policy managed by an
4325 # internal service like GKE. This SYSTEM value is reserved for
4326 # internal services and cannot be set by users during policy creation.
4327 # Policies with a SYSTEM source cannot be modified or deleted by
4328 # users.
4329 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
4330 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
4331 #
4332 # Note: if not specified then VPC_POLICY will be used.
4333 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
4334 # This field is not applicable to global firewall policies.
4335 # You must specify this field as part of the HTTP request URL. It is
4336 # not settable as a field in the request body.
4337 &quot;rolloutOperation&quot;: { # Represents progressive rollout input parameters and current status. # Configuration and status of the progressive rollout of this resource.
4338 &quot;rolloutInput&quot;: { # Represents progressive rollout input parameters. # Input parameters to be used by the next not yet scheduled rollout.
4339 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan. Ex.
4340 # organizations//locations/global/rolloutPlans/.
4341 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
4342 &quot;retryUuid&quot;: &quot;A String&quot;, # The UUID of the retry action. Only needed if this is a retry for an
4343 # existing rollout. This can be used after the user canceled a rollout
4344 # and want to retry it with no changes.
4345 },
4346 &quot;rolloutStatus&quot;: { # Represents progressive rollout current status. # [Output only] Current status of the rollout.
4347 &quot;nextRollout&quot;: { # [Output only] The next rollout.
4348 &quot;rolloutId&quot;: &quot;A String&quot;, # Output only. [Output only] The id of the next rollout.
4349 &quot;rolloutPlan&quot;: &quot;A String&quot;, # The name of the rollout plan to be used by the next not yet started
4350 # rollout. This field is auto populated based on RolloutInput when a
4351 # new rollout is scheduled. This can be manually changed before the
4352 # scheduled rollout starts.
4353 # Ex.
4354 # organizations//locations/global/rolloutPlans/
4355 },
4356 &quot;ongoingRollouts&quot;: [ # [Output only] The ongoing rollout.
4357 { # Represents the status of the progressive rollout instance, either
4358 # completed or ongoing.
4359 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
4360 # organizations//locations/global/rollouts/
4361 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
4362 # organizations//locations/global/rolloutPlans/
4363 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
4364 },
4365 ],
4366 &quot;previousRollout&quot;: { # Represents the status of the progressive rollout instance, either # [Output only] The last previously executed rollout.
4367 # completed or ongoing.
4368 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
4369 # organizations//locations/global/rollouts/
4370 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
4371 # organizations//locations/global/rolloutPlans/
4372 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
4373 },
4374 },
4375 },
4376 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
4377 # policy can not exceed a set number of tuples.
4378 &quot;rules&quot;: [ # A list of rules that belong to this policy.
4379 # There must always be a default rule (rule with priority 2147483647 and
4380 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
4381 # default rule with action &quot;allow&quot; will be added.
4382 { # Represents a rule that describes one or more match conditions along with
4383 # the action to be taken when traffic matches this condition (allow or deny).
4384 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
4385 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
4386 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
4387 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
4388 # and &quot;goto_next&quot;.
4389 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
4390 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
4391 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
4392 # the firewall policy rule is not enforced and traffic behaves as if it did
4393 # not exist. If this is unspecified, the firewall policy rule will be
4394 # enabled.
4395 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4396 # enabled, logs will be exported to the configured export destination in
4397 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4398 # cannot enable logging on &quot;goto_next&quot; rules.
4399 &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.
4400 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4401 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4402 # Exactly one field must be specified.
4403 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
4404 # Maximum number of destination address groups is 10.
4405 &quot;A String&quot;,
4406 ],
4407 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4408 # traffic destination.
4409 # Maximum number of destination fqdn allowed is 100.
4410 &quot;A String&quot;,
4411 ],
4412 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4413 # Maximum number of destination CIDR IP ranges allowed is 5000.
4414 &quot;A String&quot;,
4415 ],
4416 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
4417 #
4418 #
4419 # - UNSPECIFIED
4420 # - INTERNET
4421 # - NON_INTERNET
4422 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
4423 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
4424 #
4425 #
4426 # - UNSPECIFIED
4427 # - INTERNET
4428 # - NON_INTERNET
4429 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
4430 # of traffic. Should be specified as 2 letter country code defined as per
4431 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4432 # Maximum number of dest region codes allowed is 5000.
4433 &quot;A String&quot;,
4434 ],
4435 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4436 # The IPs in these lists will be matched against traffic destination.
4437 &quot;A String&quot;,
4438 ],
4439 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4440 {
4441 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4442 # required when creating a firewall rule. This value can either be
4443 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4444 # protocol number.
4445 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4446 # only applicable for UDP or TCP protocol. Each entry must be either
4447 # an integer or a range. If not specified, this rule applies to
4448 # connections through any port.
4449 #
4450 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4451 &quot;A String&quot;,
4452 ],
4453 },
4454 ],
4455 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4456 # Maximum number of source address groups is 10.
4457 &quot;A String&quot;,
4458 ],
4459 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4460 # traffic source.
4461 # Maximum number of source fqdn allowed is 100.
4462 &quot;A String&quot;,
4463 ],
4464 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4465 # Maximum number of source CIDR IP ranges allowed is 5000.
4466 &quot;A String&quot;,
4467 ],
4468 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4469 #
4470 #
4471 # - UNSPECIFIED
4472 # - INTERNET
4473 # - INTRA_VPC
4474 # - NON_INTERNET
4475 # - VPC_NETWORKS
4476 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4477 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4478 #
4479 #
4480 # - UNSPECIFIED
4481 # - INTERNET
4482 # - INTRA_VPC
4483 # - NON_INTERNET
4484 # - VPC_NETWORKS
4485 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4486 &quot;A String&quot;,
4487 ],
4488 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4489 # of traffic. Should be specified as 2 letter country code defined as per
4490 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4491 # Maximum number of source region codes allowed is 5000.
4492 &quot;A String&quot;,
4493 ],
4494 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4495 # of the traffic.
4496 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4497 # and there is no srcIpRange, this rule will be ignored.
4498 # Maximum number of source tag values allowed is 256.
4499 {
4500 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4501 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4502 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4503 # or its network is deleted.
4504 },
4505 ],
4506 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4507 # The IPs in these lists will be matched against traffic source.
4508 &quot;A String&quot;,
4509 ],
4510 },
4511 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4512 # must be a positive value between 0 and 2147483647.
4513 # Rules are evaluated from highest to lowest priority where 0 is the
4514 # highest priority and 2147483647 is the lowest priority.
4515 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4516 # and can be updated.
4517 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4518 # rule.
4519 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4520 # Example:
4521 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4522 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4523 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4524 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4525 # This field allows you to control which load balancers get this rule.
4526 # For example, the following are valid values:
4527 #
4528 #
4529 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4530 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4531 # - projects/project/global/
4532 # forwardingRules/forwardingRule
4533 # - projects/project/regions/region/forwardingRules/
4534 # forwardingRule
4535 &quot;A String&quot;,
4536 ],
4537 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4538 # allows you to control which network&#x27;s VMs get this rule. If this field
4539 # is left blank, all VMs within the organization will receive the rule.
4540 &quot;A String&quot;,
4541 ],
4542 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4543 # applies to. If targetSecureTag are specified, then the
4544 # firewall rule applies only to instances in the VPC network that have one
4545 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4546 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
4547 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
4548 # to all instances on the specified network.
4549 # Maximum number of target label tags allowed is 256.
4550 {
4551 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4552 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4553 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4554 # or its network is deleted.
4555 },
4556 ],
4557 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4558 # applied with this rule.
4559 &quot;A String&quot;,
4560 ],
4561 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
4562 # Default value is INSTANCES.
4563 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
4564 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
4565 # be set for other actions.
4566 },
4567 ],
4568 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4569 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4570 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
4571 # unique in the organization in which the firewall policy is created.
4572 # This field is not applicable to network firewall policies.
4573 # This name must be set on creation and cannot be changed. The name must be
4574 # 1-63 characters long, and comply with RFC1035.
4575 # Specifically, the name must be 1-63 characters long and match the regular
4576 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4577 # character must be a lowercase letter, and all following characters must
4578 # be a dash, lowercase letter, or digit, except the last character, which
4579 # cannot be a dash.
4580 &quot;vpcNetworkScope&quot;: &quot;A String&quot;, # The scope of networks allowed to be associated with the firewall
4581 # policy. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.
4582 #
4583 # A firewall policy with the VPC scope set to GLOBAL_VPC_NETWORK
4584 # is allowed to be attached only to global networks.
4585 #
4586 # When the VPC scope is set to REGIONAL_VPC_NETWORK the firewall
4587 # policy is allowed to be attached only to regional networks in the same
4588 # scope as the firewall policy.
4589 #
4590 # Note: if not specified then GLOBAL_VPC_NETWORK will be used.
4591 }
4592
4593 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4594 that if you must retry your request, the server will know to ignore the
4595 request if it has already been completed.
4596
4597 For example, consider a situation where you make an initial request and
4598 the request times out. If you make the request again with the same
4599 request ID, the server can check if original operation with the same
4600 request ID was received, and if so, will ignore the second request. This
4601 prevents clients from accidentally creating duplicate commitments.
4602
4603 The request ID must be
4604 a valid UUID with the exception that zero UUID is not supported
4605 (00000000-0000-0000-0000-000000000000).
4606 x__xgafv: string, V1 error format.
4607 Allowed values
4608 1 - v1 error format
4609 2 - v2 error format
4610
4611 Returns:
4612 An object of the form:
4613
4614 { # Represents an Operation resource.
4615 #
4616 # Google Compute Engine has three Operation resources:
4617 #
4618 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4619 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4620 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4621 #
4622 # You can use an operation resource to manage asynchronous API requests.
4623 # For more information, readHandling
4624 # API responses.
4625 #
4626 # Operations can be global, regional or zonal.
4627 #
4628 # - For global operations, use the `globalOperations`
4629 # resource.
4630 # - For regional operations, use the
4631 # `regionOperations` resource.
4632 # - For zonal operations, use
4633 # the `zoneOperations` resource.
4634 #
4635 #
4636 #
4637 # For more information, read
4638 # Global, Regional, and Zonal Resources.
4639 #
4640 # Note that completed Operation resources have a limited
4641 # retention period.
4642 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4643 # Not present otherwise.
4644 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4645 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4646 # set when the operation is created.
4647 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4648 # text format.
4649 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4650 # this field will be populated.
4651 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4652 # operation.
4653 {
4654 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4655 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4656 # details. There is a set of defined message types to use for providing
4657 # details.The syntax depends on the error code. For example,
4658 # QuotaExceededInfo will have details when the error code is
4659 # QUOTA_EXCEEDED.
4660 {
4661 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4662 #
4663 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4664 # is not enabled:
4665 #
4666 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4667 # &quot;domain&quot;: &quot;googleapis.com&quot;
4668 # &quot;metadata&quot;: {
4669 # &quot;resource&quot;: &quot;projects/123&quot;,
4670 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4671 # }
4672 # }
4673 #
4674 # This response indicates that the pubsub.googleapis.com API is not enabled.
4675 #
4676 # Example of an error that is returned when attempting to create a Spanner
4677 # instance in a region that is out of stock:
4678 #
4679 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4680 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4681 # &quot;metadata&quot;: {
4682 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4683 # }
4684 # }
4685 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4686 # is typically the registered service name of the tool or product that
4687 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4688 # generated by some common infrastructure, the error domain must be a
4689 # globally unique value that identifies the infrastructure. For Google API
4690 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4691 &quot;metadatas&quot;: { # Additional structured details about this error.
4692 #
4693 # Keys must match a regular expression of `a-z+` but should
4694 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4695 # length. When identifying the current value of an exceeded limit, the units
4696 # should be contained in the key, not the value. For example, rather than
4697 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4698 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4699 # instances that can be created in a single (batch) request.
4700 &quot;a_key&quot;: &quot;A String&quot;,
4701 },
4702 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4703 # proximate cause of the error. Error reasons are unique within a particular
4704 # domain of errors. This should be at most 63 characters and match a
4705 # regular expression of `A-Z+[A-Z0-9]`, which represents
4706 # UPPER_SNAKE_CASE.
4707 },
4708 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4709 #
4710 # For example, if a quota check failed with an error indicating the calling
4711 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4712 # directly to the right place in the developer console to flip the bit.
4713 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4714 { # Describes a URL link.
4715 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4716 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4717 },
4718 ],
4719 },
4720 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4721 # which can be attached to an RPC error.
4722 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4723 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4724 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4725 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4726 },
4727 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4728 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4729 &quot;a_key&quot;: &quot;A String&quot;,
4730 },
4731 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4732 # type or metric.
4733 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4734 # or metric.
4735 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4736 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4737 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4738 },
4739 },
4740 ],
4741 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4742 # This property is optional.
4743 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4744 },
4745 ],
4746 },
4747 &quot;getVersionOperationMetadata&quot;: {
4748 &quot;inlineSbomInfo&quot;: {
4749 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4750 # appropriate identifiers.
4751 &quot;a_key&quot;: &quot;A String&quot;,
4752 },
4753 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4754 # identifiers.
4755 &quot;a_key&quot;: &quot;A String&quot;,
4756 },
4757 },
4758 },
4759 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4760 # message that was returned, such as `NOT FOUND`.
4761 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4762 # status code that was returned. For example, a `404` means the
4763 # resource was not found.
4764 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4765 # defined by the server.
4766 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4767 # This value is inRFC3339
4768 # text format.
4769 &quot;instancesBulkInsertOperationMetadata&quot;: {
4770 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4771 # Example key: zones/us-central1-a
4772 &quot;a_key&quot;: {
4773 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4774 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4775 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4776 # error.
4777 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4778 # if the flow is rolling forward or rolling back.
4779 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4780 },
4781 },
4782 },
4783 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4784 # Operation resources.
4785 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4786 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4787 # group of operations results from a `bulkInsert` API request.
4788 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4789 # `update`, or `delete`, and so on.
4790 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4791 # There is no requirement that this be linear or support any granularity of
4792 # operations. This should not be used to guess when the operation will be
4793 # complete. This number should monotonically increase as the operation
4794 # progresses.
4795 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4796 # applicable when performing regional operations.
4797 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4798 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4799 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4800 # this field will contain information on all underlying zonal actions and
4801 # their state.
4802 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4803 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4804 # Example key: zones/us-central1-a
4805 &quot;a_key&quot;: {
4806 &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
4807 # populated.
4808 # different programming environments, including REST APIs and RPC APIs. It is
4809 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4810 # three pieces of data: error code, error message, and error details.
4811 #
4812 # You can find out more about this error model and how to work with it in the
4813 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4814 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4815 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4816 # message types for APIs to use.
4817 {
4818 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4819 },
4820 ],
4821 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4822 # user-facing error message should be localized and sent in the
4823 # google.rpc.Status.details field, or localized by the client.
4824 },
4825 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4826 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4827 },
4828 },
4829 },
4830 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4831 # This value is inRFC3339
4832 # text format.
4833 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4834 # following:
4835 # `PENDING`, `RUNNING`, or `DONE`.
4836 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4837 # operation.
4838 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4839 # of the target resource.
4840 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4841 # operations related to creating a snapshot, this points to the disk
4842 # that the snapshot was created from.
4843 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4844 # `[email protected]` or
4845 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4846 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4847 # operation, this field will be populated.
4848 {
4849 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4850 # Engine returns NO_RESULTS_ON_PAGE if there
4851 # are no results in the response.
4852 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4853 # value format. For example:
4854 #
4855 # &quot;data&quot;: [
4856 # {
4857 # &quot;key&quot;: &quot;scope&quot;,
4858 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4859 # }
4860 {
4861 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4862 # returned. For example, for warnings where there are no results in a list
4863 # request for a particular zone, this key might be scope and
4864 # the key value might be the zone name. Other examples might be a key
4865 # indicating a deprecated resource and a suggested replacement, or a
4866 # warning about invalid network settings (for example, if an instance
4867 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4868 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4869 },
4870 ],
4871 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4872 },
4873 ],
4874 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4875 # applicable when performing per-zone operations.
4876 }</pre>
4877 </div>
4878
4879 <div class="method">
4880 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4881 <pre>Lists all the policies that have been configured for the specified project.
4882
4883 Args:
4884 project: string, Project ID for this request. (required)
4885 filter: string, A filter expression that filters resources listed in the response. Most
4886 Compute resources support two types of filter expressions:
4887 expressions that support regular expressions and expressions that follow
4888 API improvement proposal AIP-160.
4889 These two types of filter expressions cannot be mixed in one request.
4890
4891 If you want to use AIP-160, your expression must specify the field name, an
4892 operator, and the value that you want to use for filtering. The value
4893 must be a string, a number, or a boolean. The operator
4894 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4895
4896 For example, if you are filtering Compute Engine instances, you can
4897 exclude instances named `example-instance` by specifying
4898 `name != example-instance`.
4899
4900 The `:*` comparison can be used to test whether a key has been defined.
4901 For example, to find all objects with `owner` label use:
4902 ```
4903 labels.owner:*
4904 ```
4905
4906 You can also filter nested fields. For example, you could specify
4907 `scheduling.automaticRestart = false` to include instances only
4908 if they are not scheduled for automatic restarts. You can use filtering
4909 on nested fields to filter based onresource labels.
4910
4911 To filter on multiple expressions, provide each separate expression within
4912 parentheses. For example:
4913 ```
4914 (scheduling.automaticRestart = true)
4915 (cpuPlatform = &quot;Intel Skylake&quot;)
4916 ```
4917 By default, each expression is an `AND` expression. However, you
4918 can include `AND` and `OR` expressions explicitly.
4919 For example:
4920 ```
4921 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4922 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4923 (scheduling.automaticRestart = true)
4924 ```
4925
4926 If you want to use a regular expression, use the `eq` (equal) or `ne`
4927 (not equal) operator against a single un-parenthesized expression with or
4928 without quotes or against multiple parenthesized expressions. Examples:
4929
4930 `fieldname eq unquoted literal`
4931 `fieldname eq &#x27;single quoted literal&#x27;`
4932 `fieldname eq &quot;double quoted literal&quot;`
4933 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4934
4935 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4936 The literal value must match the entire field.
4937
4938 For example, to filter for instances that do not end with name &quot;instance&quot;,
4939 you would use `name ne .*instance`.
4940
4941 You cannot combine constraints on multiple fields using regular
4942 expressions.
4943 maxResults: integer, The maximum number of results per page that should be returned.
4944 If the number of available results is larger than `maxResults`,
4945 Compute Engine returns a `nextPageToken` that can be used to get
4946 the next page of results in subsequent list requests. Acceptable values are
4947 `0` to `500`, inclusive. (Default: `500`)
4948 orderBy: string, Sorts list results by a certain order. By default, results
4949 are returned in alphanumerical order based on the resource name.
4950
4951 You can also sort results in descending order based on the creation
4952 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4953 results based on the `creationTimestamp` field in
4954 reverse chronological order (newest result first). Use this to sort
4955 resources like operations so that the newest operation is returned first.
4956
4957 Currently, only sorting by `name` or
4958 `creationTimestamp desc` is supported.
4959 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4960 `nextPageToken` returned by a previous list request to get
4961 the next page of results.
4962 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4963 of failure. The default value is false.
4964
4965 For example, when partial success behavior is enabled, aggregatedList for a
4966 single zone scope either returns all resources in the zone or no resources,
4967 with an error code.
4968 x__xgafv: string, V1 error format.
4969 Allowed values
4970 1 - v1 error format
4971 2 - v2 error format
4972
4973 Returns:
4974 An object of the form:
4975
4976 {
4977 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4978 &quot;items&quot;: [ # A list of FirewallPolicy resources.
4979 { # Represents a Firewall Policy resource.
4980 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
4981 {
4982 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
4983 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
4984 # of the firewall policy of the association.
4985 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
4986 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
4987 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
4988 # must be a positive value between 1 and 2147483647.
4989 # Firewall Policies are evaluated from highest to lowest priority where 1
4990 # is the highest priority and 2147483647 is the lowest priority.
4991 # The default value is `1000`. If two associations have the same priority
4992 # then lexicographical order on association names is applied.
4993 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
4994 },
4995 ],
4996 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4997 # text format.
4998 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4999 # create the resource.
5000 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
5001 # Organization firewall policy. The name should be unique in the organization
5002 # in which the firewall policy is created.
5003 # This field is not applicable to network firewall policies.
5004 # This name must be set on creation and cannot be changed.
5005 # The name must be 1-63 characters long, and comply
5006 # with RFC1035. Specifically, the name must be 1-63 characters
5007 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
5008 # means the first character must be a lowercase letter, and all following
5009 # characters must be a dash, lowercase letter, or digit, except the last
5010 # character, which cannot be a dash.
5011 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
5012 # the metadata&#x27;s contents and used for optimistic locking. The
5013 # fingerprint is initially generated by Compute Engine and changes after
5014 # every request to modify or update metadata. You must always provide an
5015 # up-to-date fingerprint hash in order to update or change metadata,
5016 # otherwise the request will fail with error412 conditionNotMet.
5017 #
5018 # To see the latest fingerprint, make get() request to the
5019 # firewall policy.
5020 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5021 # defined by the server.
5022 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
5023 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
5024 # [Output Only] numeric ID allocated by Google Cloud which uniquely
5025 # identifies the Organization Firewall Policy.
5026 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
5027 { # Represents a rule that describes one or more match conditions along with
5028 # the action to be taken when traffic matches this condition (allow or deny).
5029 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5030 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5031 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5032 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5033 # and &quot;goto_next&quot;.
5034 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5035 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5036 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5037 # the firewall policy rule is not enforced and traffic behaves as if it did
5038 # not exist. If this is unspecified, the firewall policy rule will be
5039 # enabled.
5040 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5041 # enabled, logs will be exported to the configured export destination in
5042 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5043 # cannot enable logging on &quot;goto_next&quot; rules.
5044 &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.
5045 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5046 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5047 # Exactly one field must be specified.
5048 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5049 # Maximum number of destination address groups is 10.
5050 &quot;A String&quot;,
5051 ],
5052 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5053 # traffic destination.
5054 # Maximum number of destination fqdn allowed is 100.
5055 &quot;A String&quot;,
5056 ],
5057 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5058 # Maximum number of destination CIDR IP ranges allowed is 5000.
5059 &quot;A String&quot;,
5060 ],
5061 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5062 #
5063 #
5064 # - UNSPECIFIED
5065 # - INTERNET
5066 # - NON_INTERNET
5067 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5068 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5069 #
5070 #
5071 # - UNSPECIFIED
5072 # - INTERNET
5073 # - NON_INTERNET
5074 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5075 # of traffic. Should be specified as 2 letter country code defined as per
5076 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5077 # Maximum number of dest region codes allowed is 5000.
5078 &quot;A String&quot;,
5079 ],
5080 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5081 # The IPs in these lists will be matched against traffic destination.
5082 &quot;A String&quot;,
5083 ],
5084 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5085 {
5086 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5087 # required when creating a firewall rule. This value can either be
5088 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5089 # protocol number.
5090 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5091 # only applicable for UDP or TCP protocol. Each entry must be either
5092 # an integer or a range. If not specified, this rule applies to
5093 # connections through any port.
5094 #
5095 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5096 &quot;A String&quot;,
5097 ],
5098 },
5099 ],
5100 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5101 # Maximum number of source address groups is 10.
5102 &quot;A String&quot;,
5103 ],
5104 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5105 # traffic source.
5106 # Maximum number of source fqdn allowed is 100.
5107 &quot;A String&quot;,
5108 ],
5109 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5110 # Maximum number of source CIDR IP ranges allowed is 5000.
5111 &quot;A String&quot;,
5112 ],
5113 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5114 #
5115 #
5116 # - UNSPECIFIED
5117 # - INTERNET
5118 # - INTRA_VPC
5119 # - NON_INTERNET
5120 # - VPC_NETWORKS
5121 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5122 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5123 #
5124 #
5125 # - UNSPECIFIED
5126 # - INTERNET
5127 # - INTRA_VPC
5128 # - NON_INTERNET
5129 # - VPC_NETWORKS
5130 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5131 &quot;A String&quot;,
5132 ],
5133 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5134 # of traffic. Should be specified as 2 letter country code defined as per
5135 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5136 # Maximum number of source region codes allowed is 5000.
5137 &quot;A String&quot;,
5138 ],
5139 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5140 # of the traffic.
5141 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5142 # and there is no srcIpRange, this rule will be ignored.
5143 # Maximum number of source tag values allowed is 256.
5144 {
5145 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5146 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5147 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5148 # or its network is deleted.
5149 },
5150 ],
5151 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5152 # The IPs in these lists will be matched against traffic source.
5153 &quot;A String&quot;,
5154 ],
5155 },
5156 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5157 # must be a positive value between 0 and 2147483647.
5158 # Rules are evaluated from highest to lowest priority where 0 is the
5159 # highest priority and 2147483647 is the lowest priority.
5160 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5161 # and can be updated.
5162 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5163 # rule.
5164 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5165 # Example:
5166 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5167 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5168 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5169 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5170 # This field allows you to control which load balancers get this rule.
5171 # For example, the following are valid values:
5172 #
5173 #
5174 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5175 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5176 # - projects/project/global/
5177 # forwardingRules/forwardingRule
5178 # - projects/project/regions/region/forwardingRules/
5179 # forwardingRule
5180 &quot;A String&quot;,
5181 ],
5182 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5183 # allows you to control which network&#x27;s VMs get this rule. If this field
5184 # is left blank, all VMs within the organization will receive the rule.
5185 &quot;A String&quot;,
5186 ],
5187 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5188 # applies to. If targetSecureTag are specified, then the
5189 # firewall rule applies only to instances in the VPC network that have one
5190 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5191 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5192 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5193 # to all instances on the specified network.
5194 # Maximum number of target label tags allowed is 256.
5195 {
5196 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5197 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5198 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5199 # or its network is deleted.
5200 },
5201 ],
5202 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5203 # applied with this rule.
5204 &quot;A String&quot;,
5205 ],
5206 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5207 # Default value is INSTANCES.
5208 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5209 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5210 # be set for other actions.
5211 },
5212 ],
5213 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
5214 # This field is not applicable to network firewall policies.
5215 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
5216 # creation and defaults to USER_DEFINED.
5217 #
5218 # The USER_DEFINED value indicates a regular firewall policy.
5219 #
5220 # The SYSTEM value indicates a system-level policy managed by an
5221 # internal service like GKE. This SYSTEM value is reserved for
5222 # internal services and cannot be set by users during policy creation.
5223 # Policies with a SYSTEM source cannot be modified or deleted by
5224 # users.
5225 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
5226 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
5227 #
5228 # Note: if not specified then VPC_POLICY will be used.
5229 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
5230 # This field is not applicable to global firewall policies.
5231 # You must specify this field as part of the HTTP request URL. It is
5232 # not settable as a field in the request body.
5233 &quot;rolloutOperation&quot;: { # Represents progressive rollout input parameters and current status. # Configuration and status of the progressive rollout of this resource.
5234 &quot;rolloutInput&quot;: { # Represents progressive rollout input parameters. # Input parameters to be used by the next not yet scheduled rollout.
5235 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan. Ex.
5236 # organizations//locations/global/rolloutPlans/.
5237 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
5238 &quot;retryUuid&quot;: &quot;A String&quot;, # The UUID of the retry action. Only needed if this is a retry for an
5239 # existing rollout. This can be used after the user canceled a rollout
5240 # and want to retry it with no changes.
5241 },
5242 &quot;rolloutStatus&quot;: { # Represents progressive rollout current status. # [Output only] Current status of the rollout.
5243 &quot;nextRollout&quot;: { # [Output only] The next rollout.
5244 &quot;rolloutId&quot;: &quot;A String&quot;, # Output only. [Output only] The id of the next rollout.
5245 &quot;rolloutPlan&quot;: &quot;A String&quot;, # The name of the rollout plan to be used by the next not yet started
5246 # rollout. This field is auto populated based on RolloutInput when a
5247 # new rollout is scheduled. This can be manually changed before the
5248 # scheduled rollout starts.
5249 # Ex.
5250 # organizations//locations/global/rolloutPlans/
5251 },
5252 &quot;ongoingRollouts&quot;: [ # [Output only] The ongoing rollout.
5253 { # Represents the status of the progressive rollout instance, either
5254 # completed or ongoing.
5255 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
5256 # organizations//locations/global/rollouts/
5257 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
5258 # organizations//locations/global/rolloutPlans/
5259 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
5260 },
5261 ],
5262 &quot;previousRollout&quot;: { # Represents the status of the progressive rollout instance, either # [Output only] The last previously executed rollout.
5263 # completed or ongoing.
5264 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
5265 # organizations//locations/global/rollouts/
5266 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
5267 # organizations//locations/global/rolloutPlans/
5268 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
5269 },
5270 },
5271 },
5272 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
5273 # policy can not exceed a set number of tuples.
5274 &quot;rules&quot;: [ # A list of rules that belong to this policy.
5275 # There must always be a default rule (rule with priority 2147483647 and
5276 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
5277 # default rule with action &quot;allow&quot; will be added.
5278 { # Represents a rule that describes one or more match conditions along with
5279 # the action to be taken when traffic matches this condition (allow or deny).
5280 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5281 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5282 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5283 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5284 # and &quot;goto_next&quot;.
5285 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5286 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5287 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5288 # the firewall policy rule is not enforced and traffic behaves as if it did
5289 # not exist. If this is unspecified, the firewall policy rule will be
5290 # enabled.
5291 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5292 # enabled, logs will be exported to the configured export destination in
5293 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5294 # cannot enable logging on &quot;goto_next&quot; rules.
5295 &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.
5296 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5297 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5298 # Exactly one field must be specified.
5299 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5300 # Maximum number of destination address groups is 10.
5301 &quot;A String&quot;,
5302 ],
5303 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5304 # traffic destination.
5305 # Maximum number of destination fqdn allowed is 100.
5306 &quot;A String&quot;,
5307 ],
5308 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5309 # Maximum number of destination CIDR IP ranges allowed is 5000.
5310 &quot;A String&quot;,
5311 ],
5312 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5313 #
5314 #
5315 # - UNSPECIFIED
5316 # - INTERNET
5317 # - NON_INTERNET
5318 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5319 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5320 #
5321 #
5322 # - UNSPECIFIED
5323 # - INTERNET
5324 # - NON_INTERNET
5325 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5326 # of traffic. Should be specified as 2 letter country code defined as per
5327 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5328 # Maximum number of dest region codes allowed is 5000.
5329 &quot;A String&quot;,
5330 ],
5331 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5332 # The IPs in these lists will be matched against traffic destination.
5333 &quot;A String&quot;,
5334 ],
5335 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5336 {
5337 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5338 # required when creating a firewall rule. This value can either be
5339 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5340 # protocol number.
5341 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5342 # only applicable for UDP or TCP protocol. Each entry must be either
5343 # an integer or a range. If not specified, this rule applies to
5344 # connections through any port.
5345 #
5346 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5347 &quot;A String&quot;,
5348 ],
5349 },
5350 ],
5351 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5352 # Maximum number of source address groups is 10.
5353 &quot;A String&quot;,
5354 ],
5355 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5356 # traffic source.
5357 # Maximum number of source fqdn allowed is 100.
5358 &quot;A String&quot;,
5359 ],
5360 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5361 # Maximum number of source CIDR IP ranges allowed is 5000.
5362 &quot;A String&quot;,
5363 ],
5364 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5365 #
5366 #
5367 # - UNSPECIFIED
5368 # - INTERNET
5369 # - INTRA_VPC
5370 # - NON_INTERNET
5371 # - VPC_NETWORKS
5372 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5373 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5374 #
5375 #
5376 # - UNSPECIFIED
5377 # - INTERNET
5378 # - INTRA_VPC
5379 # - NON_INTERNET
5380 # - VPC_NETWORKS
5381 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5382 &quot;A String&quot;,
5383 ],
5384 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5385 # of traffic. Should be specified as 2 letter country code defined as per
5386 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5387 # Maximum number of source region codes allowed is 5000.
5388 &quot;A String&quot;,
5389 ],
5390 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5391 # of the traffic.
5392 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5393 # and there is no srcIpRange, this rule will be ignored.
5394 # Maximum number of source tag values allowed is 256.
5395 {
5396 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5397 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5398 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5399 # or its network is deleted.
5400 },
5401 ],
5402 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5403 # The IPs in these lists will be matched against traffic source.
5404 &quot;A String&quot;,
5405 ],
5406 },
5407 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5408 # must be a positive value between 0 and 2147483647.
5409 # Rules are evaluated from highest to lowest priority where 0 is the
5410 # highest priority and 2147483647 is the lowest priority.
5411 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5412 # and can be updated.
5413 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5414 # rule.
5415 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5416 # Example:
5417 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5418 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5419 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5420 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5421 # This field allows you to control which load balancers get this rule.
5422 # For example, the following are valid values:
5423 #
5424 #
5425 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5426 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5427 # - projects/project/global/
5428 # forwardingRules/forwardingRule
5429 # - projects/project/regions/region/forwardingRules/
5430 # forwardingRule
5431 &quot;A String&quot;,
5432 ],
5433 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5434 # allows you to control which network&#x27;s VMs get this rule. If this field
5435 # is left blank, all VMs within the organization will receive the rule.
5436 &quot;A String&quot;,
5437 ],
5438 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5439 # applies to. If targetSecureTag are specified, then the
5440 # firewall rule applies only to instances in the VPC network that have one
5441 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5442 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5443 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5444 # to all instances on the specified network.
5445 # Maximum number of target label tags allowed is 256.
5446 {
5447 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5448 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5449 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5450 # or its network is deleted.
5451 },
5452 ],
5453 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5454 # applied with this rule.
5455 &quot;A String&quot;,
5456 ],
5457 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5458 # Default value is INSTANCES.
5459 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5460 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5461 # be set for other actions.
5462 },
5463 ],
5464 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5465 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5466 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
5467 # unique in the organization in which the firewall policy is created.
5468 # This field is not applicable to network firewall policies.
5469 # This name must be set on creation and cannot be changed. The name must be
5470 # 1-63 characters long, and comply with RFC1035.
5471 # Specifically, the name must be 1-63 characters long and match the regular
5472 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5473 # character must be a lowercase letter, and all following characters must
5474 # be a dash, lowercase letter, or digit, except the last character, which
5475 # cannot be a dash.
5476 &quot;vpcNetworkScope&quot;: &quot;A String&quot;, # The scope of networks allowed to be associated with the firewall
5477 # policy. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.
5478 #
5479 # A firewall policy with the VPC scope set to GLOBAL_VPC_NETWORK
5480 # is allowed to be attached only to global networks.
5481 #
5482 # When the VPC scope is set to REGIONAL_VPC_NETWORK the firewall
5483 # policy is allowed to be attached only to regional networks in the same
5484 # scope as the firewall policy.
5485 #
5486 # Note: if not specified then GLOBAL_VPC_NETWORK will be used.
5487 },
5488 ],
5489 &quot;kind&quot;: &quot;compute#firewallPolicyList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#firewallPolicyList for listsof FirewallPolicies
5490 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5491 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5492 # the query parameter pageToken in the next list request.
5493 # Subsequent list requests will have their own nextPageToken to
5494 # continue paging through the results.
5495 &quot;warning&quot;: { # [Output Only] Informational warning message.
5496 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5497 # Engine returns NO_RESULTS_ON_PAGE if there
5498 # are no results in the response.
5499 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5500 # value format. For example:
5501 #
5502 # &quot;data&quot;: [
5503 # {
5504 # &quot;key&quot;: &quot;scope&quot;,
5505 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5506 # }
5507 {
5508 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5509 # returned. For example, for warnings where there are no results in a list
5510 # request for a particular zone, this key might be scope and
5511 # the key value might be the zone name. Other examples might be a key
5512 # indicating a deprecated resource and a suggested replacement, or a
5513 # warning about invalid network settings (for example, if an instance
5514 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5515 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5516 },
5517 ],
5518 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5519 },
5520 }</pre>
5521 </div>
5522
5523 <div class="method">
5524 <code class="details" id="list_next">list_next()</code>
5525 <pre>Retrieves the next page of results.
5526
5527 Args:
5528 previous_request: The request for the previous page. (required)
5529 previous_response: The response from the request for the previous page. (required)
5530
5531 Returns:
5532 A request object that you can call &#x27;execute()&#x27; on to request the next
5533 page. Returns None if there are no more items in the collection.
5534 </pre>
5535 </div>
5536
5537 <div class="method">
5538 <code class="details" id="patch">patch(project, firewallPolicy, body=None, requestId=None, x__xgafv=None)</code>
5539 <pre>Patches the specified policy with the data included in the request.
5540
5541 Args:
5542 project: string, Project ID for this request. (required)
5543 firewallPolicy: string, Name of the firewall policy to update. (required)
5544 body: object, The request body.
5545 The object takes the form of:
5546
5547 { # Represents a Firewall Policy resource.
5548 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
5549 {
5550 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
5551 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
5552 # of the firewall policy of the association.
5553 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
5554 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
5555 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
5556 # must be a positive value between 1 and 2147483647.
5557 # Firewall Policies are evaluated from highest to lowest priority where 1
5558 # is the highest priority and 2147483647 is the lowest priority.
5559 # The default value is `1000`. If two associations have the same priority
5560 # then lexicographical order on association names is applied.
5561 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
5562 },
5563 ],
5564 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5565 # text format.
5566 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5567 # create the resource.
5568 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
5569 # Organization firewall policy. The name should be unique in the organization
5570 # in which the firewall policy is created.
5571 # This field is not applicable to network firewall policies.
5572 # This name must be set on creation and cannot be changed.
5573 # The name must be 1-63 characters long, and comply
5574 # with RFC1035. Specifically, the name must be 1-63 characters
5575 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
5576 # means the first character must be a lowercase letter, and all following
5577 # characters must be a dash, lowercase letter, or digit, except the last
5578 # character, which cannot be a dash.
5579 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
5580 # the metadata&#x27;s contents and used for optimistic locking. The
5581 # fingerprint is initially generated by Compute Engine and changes after
5582 # every request to modify or update metadata. You must always provide an
5583 # up-to-date fingerprint hash in order to update or change metadata,
5584 # otherwise the request will fail with error412 conditionNotMet.
5585 #
5586 # To see the latest fingerprint, make get() request to the
5587 # firewall policy.
5588 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5589 # defined by the server.
5590 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
5591 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
5592 # [Output Only] numeric ID allocated by Google Cloud which uniquely
5593 # identifies the Organization Firewall Policy.
5594 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
5595 { # Represents a rule that describes one or more match conditions along with
5596 # the action to be taken when traffic matches this condition (allow or deny).
5597 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5598 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5599 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5600 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5601 # and &quot;goto_next&quot;.
5602 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5603 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5604 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5605 # the firewall policy rule is not enforced and traffic behaves as if it did
5606 # not exist. If this is unspecified, the firewall policy rule will be
5607 # enabled.
5608 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5609 # enabled, logs will be exported to the configured export destination in
5610 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5611 # cannot enable logging on &quot;goto_next&quot; rules.
5612 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
5613 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5614 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5615 # Exactly one field must be specified.
5616 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5617 # Maximum number of destination address groups is 10.
5618 &quot;A String&quot;,
5619 ],
5620 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5621 # traffic destination.
5622 # Maximum number of destination fqdn allowed is 100.
5623 &quot;A String&quot;,
5624 ],
5625 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5626 # Maximum number of destination CIDR IP ranges allowed is 5000.
5627 &quot;A String&quot;,
5628 ],
5629 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5630 #
5631 #
5632 # - UNSPECIFIED
5633 # - INTERNET
5634 # - NON_INTERNET
5635 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5636 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5637 #
5638 #
5639 # - UNSPECIFIED
5640 # - INTERNET
5641 # - NON_INTERNET
5642 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5643 # of traffic. Should be specified as 2 letter country code defined as per
5644 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5645 # Maximum number of dest region codes allowed is 5000.
5646 &quot;A String&quot;,
5647 ],
5648 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5649 # The IPs in these lists will be matched against traffic destination.
5650 &quot;A String&quot;,
5651 ],
5652 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5653 {
5654 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5655 # required when creating a firewall rule. This value can either be
5656 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5657 # protocol number.
5658 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5659 # only applicable for UDP or TCP protocol. Each entry must be either
5660 # an integer or a range. If not specified, this rule applies to
5661 # connections through any port.
5662 #
5663 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5664 &quot;A String&quot;,
5665 ],
5666 },
5667 ],
5668 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5669 # Maximum number of source address groups is 10.
5670 &quot;A String&quot;,
5671 ],
5672 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5673 # traffic source.
5674 # Maximum number of source fqdn allowed is 100.
5675 &quot;A String&quot;,
5676 ],
5677 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5678 # Maximum number of source CIDR IP ranges allowed is 5000.
5679 &quot;A String&quot;,
5680 ],
5681 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5682 #
5683 #
5684 # - UNSPECIFIED
5685 # - INTERNET
5686 # - INTRA_VPC
5687 # - NON_INTERNET
5688 # - VPC_NETWORKS
5689 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5690 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5691 #
5692 #
5693 # - UNSPECIFIED
5694 # - INTERNET
5695 # - INTRA_VPC
5696 # - NON_INTERNET
5697 # - VPC_NETWORKS
5698 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5699 &quot;A String&quot;,
5700 ],
5701 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5702 # of traffic. Should be specified as 2 letter country code defined as per
5703 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5704 # Maximum number of source region codes allowed is 5000.
5705 &quot;A String&quot;,
5706 ],
5707 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5708 # of the traffic.
5709 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5710 # and there is no srcIpRange, this rule will be ignored.
5711 # Maximum number of source tag values allowed is 256.
5712 {
5713 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5714 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5715 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5716 # or its network is deleted.
5717 },
5718 ],
5719 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5720 # The IPs in these lists will be matched against traffic source.
5721 &quot;A String&quot;,
5722 ],
5723 },
5724 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5725 # must be a positive value between 0 and 2147483647.
5726 # Rules are evaluated from highest to lowest priority where 0 is the
5727 # highest priority and 2147483647 is the lowest priority.
5728 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5729 # and can be updated.
5730 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5731 # rule.
5732 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5733 # Example:
5734 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5735 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5736 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5737 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5738 # This field allows you to control which load balancers get this rule.
5739 # For example, the following are valid values:
5740 #
5741 #
5742 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5743 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5744 # - projects/project/global/
5745 # forwardingRules/forwardingRule
5746 # - projects/project/regions/region/forwardingRules/
5747 # forwardingRule
5748 &quot;A String&quot;,
5749 ],
5750 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5751 # allows you to control which network&#x27;s VMs get this rule. If this field
5752 # is left blank, all VMs within the organization will receive the rule.
5753 &quot;A String&quot;,
5754 ],
5755 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5756 # applies to. If targetSecureTag are specified, then the
5757 # firewall rule applies only to instances in the VPC network that have one
5758 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5759 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5760 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5761 # to all instances on the specified network.
5762 # Maximum number of target label tags allowed is 256.
5763 {
5764 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5765 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5766 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5767 # or its network is deleted.
5768 },
5769 ],
5770 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5771 # applied with this rule.
5772 &quot;A String&quot;,
5773 ],
5774 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5775 # Default value is INSTANCES.
5776 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5777 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5778 # be set for other actions.
5779 },
5780 ],
5781 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
5782 # This field is not applicable to network firewall policies.
5783 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
5784 # creation and defaults to USER_DEFINED.
5785 #
5786 # The USER_DEFINED value indicates a regular firewall policy.
5787 #
5788 # The SYSTEM value indicates a system-level policy managed by an
5789 # internal service like GKE. This SYSTEM value is reserved for
5790 # internal services and cannot be set by users during policy creation.
5791 # Policies with a SYSTEM source cannot be modified or deleted by
5792 # users.
5793 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
5794 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
5795 #
5796 # Note: if not specified then VPC_POLICY will be used.
5797 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
5798 # This field is not applicable to global firewall policies.
5799 # You must specify this field as part of the HTTP request URL. It is
5800 # not settable as a field in the request body.
5801 &quot;rolloutOperation&quot;: { # Represents progressive rollout input parameters and current status. # Configuration and status of the progressive rollout of this resource.
5802 &quot;rolloutInput&quot;: { # Represents progressive rollout input parameters. # Input parameters to be used by the next not yet scheduled rollout.
5803 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan. Ex.
5804 # organizations//locations/global/rolloutPlans/.
5805 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
5806 &quot;retryUuid&quot;: &quot;A String&quot;, # The UUID of the retry action. Only needed if this is a retry for an
5807 # existing rollout. This can be used after the user canceled a rollout
5808 # and want to retry it with no changes.
5809 },
5810 &quot;rolloutStatus&quot;: { # Represents progressive rollout current status. # [Output only] Current status of the rollout.
5811 &quot;nextRollout&quot;: { # [Output only] The next rollout.
5812 &quot;rolloutId&quot;: &quot;A String&quot;, # Output only. [Output only] The id of the next rollout.
5813 &quot;rolloutPlan&quot;: &quot;A String&quot;, # The name of the rollout plan to be used by the next not yet started
5814 # rollout. This field is auto populated based on RolloutInput when a
5815 # new rollout is scheduled. This can be manually changed before the
5816 # scheduled rollout starts.
5817 # Ex.
5818 # organizations//locations/global/rolloutPlans/
5819 },
5820 &quot;ongoingRollouts&quot;: [ # [Output only] The ongoing rollout.
5821 { # Represents the status of the progressive rollout instance, either
5822 # completed or ongoing.
5823 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
5824 # organizations//locations/global/rollouts/
5825 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
5826 # organizations//locations/global/rolloutPlans/
5827 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
5828 },
5829 ],
5830 &quot;previousRollout&quot;: { # Represents the status of the progressive rollout instance, either # [Output only] The last previously executed rollout.
5831 # completed or ongoing.
5832 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
5833 # organizations//locations/global/rollouts/
5834 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
5835 # organizations//locations/global/rolloutPlans/
5836 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
5837 },
5838 },
5839 },
5840 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
5841 # policy can not exceed a set number of tuples.
5842 &quot;rules&quot;: [ # A list of rules that belong to this policy.
5843 # There must always be a default rule (rule with priority 2147483647 and
5844 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
5845 # default rule with action &quot;allow&quot; will be added.
5846 { # Represents a rule that describes one or more match conditions along with
5847 # the action to be taken when traffic matches this condition (allow or deny).
5848 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5849 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5850 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5851 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5852 # and &quot;goto_next&quot;.
5853 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5854 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5855 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5856 # the firewall policy rule is not enforced and traffic behaves as if it did
5857 # not exist. If this is unspecified, the firewall policy rule will be
5858 # enabled.
5859 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5860 # enabled, logs will be exported to the configured export destination in
5861 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5862 # cannot enable logging on &quot;goto_next&quot; rules.
5863 &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.
5864 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5865 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5866 # Exactly one field must be specified.
5867 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5868 # Maximum number of destination address groups is 10.
5869 &quot;A String&quot;,
5870 ],
5871 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5872 # traffic destination.
5873 # Maximum number of destination fqdn allowed is 100.
5874 &quot;A String&quot;,
5875 ],
5876 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5877 # Maximum number of destination CIDR IP ranges allowed is 5000.
5878 &quot;A String&quot;,
5879 ],
5880 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5881 #
5882 #
5883 # - UNSPECIFIED
5884 # - INTERNET
5885 # - NON_INTERNET
5886 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5887 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5888 #
5889 #
5890 # - UNSPECIFIED
5891 # - INTERNET
5892 # - NON_INTERNET
5893 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5894 # of traffic. Should be specified as 2 letter country code defined as per
5895 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5896 # Maximum number of dest region codes allowed is 5000.
5897 &quot;A String&quot;,
5898 ],
5899 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5900 # The IPs in these lists will be matched against traffic destination.
5901 &quot;A String&quot;,
5902 ],
5903 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5904 {
5905 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5906 # required when creating a firewall rule. This value can either be
5907 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5908 # protocol number.
5909 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5910 # only applicable for UDP or TCP protocol. Each entry must be either
5911 # an integer or a range. If not specified, this rule applies to
5912 # connections through any port.
5913 #
5914 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5915 &quot;A String&quot;,
5916 ],
5917 },
5918 ],
5919 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5920 # Maximum number of source address groups is 10.
5921 &quot;A String&quot;,
5922 ],
5923 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5924 # traffic source.
5925 # Maximum number of source fqdn allowed is 100.
5926 &quot;A String&quot;,
5927 ],
5928 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5929 # Maximum number of source CIDR IP ranges allowed is 5000.
5930 &quot;A String&quot;,
5931 ],
5932 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5933 #
5934 #
5935 # - UNSPECIFIED
5936 # - INTERNET
5937 # - INTRA_VPC
5938 # - NON_INTERNET
5939 # - VPC_NETWORKS
5940 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5941 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5942 #
5943 #
5944 # - UNSPECIFIED
5945 # - INTERNET
5946 # - INTRA_VPC
5947 # - NON_INTERNET
5948 # - VPC_NETWORKS
5949 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5950 &quot;A String&quot;,
5951 ],
5952 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5953 # of traffic. Should be specified as 2 letter country code defined as per
5954 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5955 # Maximum number of source region codes allowed is 5000.
5956 &quot;A String&quot;,
5957 ],
5958 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5959 # of the traffic.
5960 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5961 # and there is no srcIpRange, this rule will be ignored.
5962 # Maximum number of source tag values allowed is 256.
5963 {
5964 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5965 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5966 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5967 # or its network is deleted.
5968 },
5969 ],
5970 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5971 # The IPs in these lists will be matched against traffic source.
5972 &quot;A String&quot;,
5973 ],
5974 },
5975 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5976 # must be a positive value between 0 and 2147483647.
5977 # Rules are evaluated from highest to lowest priority where 0 is the
5978 # highest priority and 2147483647 is the lowest priority.
5979 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5980 # and can be updated.
5981 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5982 # rule.
5983 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5984 # Example:
5985 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5986 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5987 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5988 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5989 # This field allows you to control which load balancers get this rule.
5990 # For example, the following are valid values:
5991 #
5992 #
5993 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5994 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5995 # - projects/project/global/
5996 # forwardingRules/forwardingRule
5997 # - projects/project/regions/region/forwardingRules/
5998 # forwardingRule
5999 &quot;A String&quot;,
6000 ],
6001 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
6002 # allows you to control which network&#x27;s VMs get this rule. If this field
6003 # is left blank, all VMs within the organization will receive the rule.
6004 &quot;A String&quot;,
6005 ],
6006 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
6007 # applies to. If targetSecureTag are specified, then the
6008 # firewall rule applies only to instances in the VPC network that have one
6009 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
6010 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
6011 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
6012 # to all instances on the specified network.
6013 # Maximum number of target label tags allowed is 256.
6014 {
6015 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6016 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6017 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6018 # or its network is deleted.
6019 },
6020 ],
6021 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
6022 # applied with this rule.
6023 &quot;A String&quot;,
6024 ],
6025 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
6026 # Default value is INSTANCES.
6027 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
6028 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
6029 # be set for other actions.
6030 },
6031 ],
6032 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6033 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6034 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
6035 # unique in the organization in which the firewall policy is created.
6036 # This field is not applicable to network firewall policies.
6037 # This name must be set on creation and cannot be changed. The name must be
6038 # 1-63 characters long, and comply with RFC1035.
6039 # Specifically, the name must be 1-63 characters long and match the regular
6040 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
6041 # character must be a lowercase letter, and all following characters must
6042 # be a dash, lowercase letter, or digit, except the last character, which
6043 # cannot be a dash.
6044 &quot;vpcNetworkScope&quot;: &quot;A String&quot;, # The scope of networks allowed to be associated with the firewall
6045 # policy. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.
6046 #
6047 # A firewall policy with the VPC scope set to GLOBAL_VPC_NETWORK
6048 # is allowed to be attached only to global networks.
6049 #
6050 # When the VPC scope is set to REGIONAL_VPC_NETWORK the firewall
6051 # policy is allowed to be attached only to regional networks in the same
6052 # scope as the firewall policy.
6053 #
6054 # Note: if not specified then GLOBAL_VPC_NETWORK will be used.
6055 }
6056
6057 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6058 that if you must retry your request, the server will know to ignore the
6059 request if it has already been completed.
6060
6061 For example, consider a situation where you make an initial request and
6062 the request times out. If you make the request again with the same
6063 request ID, the server can check if original operation with the same
6064 request ID was received, and if so, will ignore the second request. This
6065 prevents clients from accidentally creating duplicate commitments.
6066
6067 The request ID must be
6068 a valid UUID with the exception that zero UUID is not supported
6069 (00000000-0000-0000-0000-000000000000).
6070 x__xgafv: string, V1 error format.
6071 Allowed values
6072 1 - v1 error format
6073 2 - v2 error format
6074
6075 Returns:
6076 An object of the form:
6077
6078 { # Represents an Operation resource.
6079 #
6080 # Google Compute Engine has three Operation resources:
6081 #
6082 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6083 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6084 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6085 #
6086 # You can use an operation resource to manage asynchronous API requests.
6087 # For more information, readHandling
6088 # API responses.
6089 #
6090 # Operations can be global, regional or zonal.
6091 #
6092 # - For global operations, use the `globalOperations`
6093 # resource.
6094 # - For regional operations, use the
6095 # `regionOperations` resource.
6096 # - For zonal operations, use
6097 # the `zoneOperations` resource.
6098 #
6099 #
6100 #
6101 # For more information, read
6102 # Global, Regional, and Zonal Resources.
6103 #
6104 # Note that completed Operation resources have a limited
6105 # retention period.
6106 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6107 # Not present otherwise.
6108 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6109 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6110 # set when the operation is created.
6111 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6112 # text format.
6113 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6114 # this field will be populated.
6115 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6116 # operation.
6117 {
6118 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6119 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6120 # details. There is a set of defined message types to use for providing
6121 # details.The syntax depends on the error code. For example,
6122 # QuotaExceededInfo will have details when the error code is
6123 # QUOTA_EXCEEDED.
6124 {
6125 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6126 #
6127 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6128 # is not enabled:
6129 #
6130 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6131 # &quot;domain&quot;: &quot;googleapis.com&quot;
6132 # &quot;metadata&quot;: {
6133 # &quot;resource&quot;: &quot;projects/123&quot;,
6134 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6135 # }
6136 # }
6137 #
6138 # This response indicates that the pubsub.googleapis.com API is not enabled.
6139 #
6140 # Example of an error that is returned when attempting to create a Spanner
6141 # instance in a region that is out of stock:
6142 #
6143 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6144 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6145 # &quot;metadata&quot;: {
6146 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6147 # }
6148 # }
6149 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6150 # is typically the registered service name of the tool or product that
6151 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6152 # generated by some common infrastructure, the error domain must be a
6153 # globally unique value that identifies the infrastructure. For Google API
6154 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6155 &quot;metadatas&quot;: { # Additional structured details about this error.
6156 #
6157 # Keys must match a regular expression of `a-z+` but should
6158 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6159 # length. When identifying the current value of an exceeded limit, the units
6160 # should be contained in the key, not the value. For example, rather than
6161 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6162 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6163 # instances that can be created in a single (batch) request.
6164 &quot;a_key&quot;: &quot;A String&quot;,
6165 },
6166 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6167 # proximate cause of the error. Error reasons are unique within a particular
6168 # domain of errors. This should be at most 63 characters and match a
6169 # regular expression of `A-Z+[A-Z0-9]`, which represents
6170 # UPPER_SNAKE_CASE.
6171 },
6172 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6173 #
6174 # For example, if a quota check failed with an error indicating the calling
6175 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6176 # directly to the right place in the developer console to flip the bit.
6177 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6178 { # Describes a URL link.
6179 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6180 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6181 },
6182 ],
6183 },
6184 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6185 # which can be attached to an RPC error.
6186 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6187 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6188 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6189 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6190 },
6191 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6192 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6193 &quot;a_key&quot;: &quot;A String&quot;,
6194 },
6195 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6196 # type or metric.
6197 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6198 # or metric.
6199 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6200 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6201 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6202 },
6203 },
6204 ],
6205 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6206 # This property is optional.
6207 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6208 },
6209 ],
6210 },
6211 &quot;getVersionOperationMetadata&quot;: {
6212 &quot;inlineSbomInfo&quot;: {
6213 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6214 # appropriate identifiers.
6215 &quot;a_key&quot;: &quot;A String&quot;,
6216 },
6217 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6218 # identifiers.
6219 &quot;a_key&quot;: &quot;A String&quot;,
6220 },
6221 },
6222 },
6223 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6224 # message that was returned, such as `NOT FOUND`.
6225 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6226 # status code that was returned. For example, a `404` means the
6227 # resource was not found.
6228 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6229 # defined by the server.
6230 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6231 # This value is inRFC3339
6232 # text format.
6233 &quot;instancesBulkInsertOperationMetadata&quot;: {
6234 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6235 # Example key: zones/us-central1-a
6236 &quot;a_key&quot;: {
6237 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6238 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6239 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6240 # error.
6241 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6242 # if the flow is rolling forward or rolling back.
6243 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6244 },
6245 },
6246 },
6247 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6248 # Operation resources.
6249 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6250 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6251 # group of operations results from a `bulkInsert` API request.
6252 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6253 # `update`, or `delete`, and so on.
6254 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6255 # There is no requirement that this be linear or support any granularity of
6256 # operations. This should not be used to guess when the operation will be
6257 # complete. This number should monotonically increase as the operation
6258 # progresses.
6259 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6260 # applicable when performing regional operations.
6261 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6262 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6263 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6264 # this field will contain information on all underlying zonal actions and
6265 # their state.
6266 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6267 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6268 # Example key: zones/us-central1-a
6269 &quot;a_key&quot;: {
6270 &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
6271 # populated.
6272 # different programming environments, including REST APIs and RPC APIs. It is
6273 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6274 # three pieces of data: error code, error message, and error details.
6275 #
6276 # You can find out more about this error model and how to work with it in the
6277 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6278 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6279 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6280 # message types for APIs to use.
6281 {
6282 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6283 },
6284 ],
6285 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6286 # user-facing error message should be localized and sent in the
6287 # google.rpc.Status.details field, or localized by the client.
6288 },
6289 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6290 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6291 },
6292 },
6293 },
6294 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6295 # This value is inRFC3339
6296 # text format.
6297 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6298 # following:
6299 # `PENDING`, `RUNNING`, or `DONE`.
6300 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6301 # operation.
6302 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6303 # of the target resource.
6304 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6305 # operations related to creating a snapshot, this points to the disk
6306 # that the snapshot was created from.
6307 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6308 # `[email protected]` or
6309 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6310 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6311 # operation, this field will be populated.
6312 {
6313 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6314 # Engine returns NO_RESULTS_ON_PAGE if there
6315 # are no results in the response.
6316 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6317 # value format. For example:
6318 #
6319 # &quot;data&quot;: [
6320 # {
6321 # &quot;key&quot;: &quot;scope&quot;,
6322 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6323 # }
6324 {
6325 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6326 # returned. For example, for warnings where there are no results in a list
6327 # request for a particular zone, this key might be scope and
6328 # the key value might be the zone name. Other examples might be a key
6329 # indicating a deprecated resource and a suggested replacement, or a
6330 # warning about invalid network settings (for example, if an instance
6331 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6332 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6333 },
6334 ],
6335 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6336 },
6337 ],
6338 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6339 # applicable when performing per-zone operations.
6340 }</pre>
6341 </div>
6342
6343 <div class="method">
6344 <code class="details" id="patchAssociation">patchAssociation(project, firewallPolicy, body=None, requestId=None, x__xgafv=None)</code>
6345 <pre>Updates an association for the specified network firewall policy.
6346
6347 Args:
6348 project: string, Project ID for this request. (required)
6349 firewallPolicy: string, Name of the firewall policy to update. (required)
6350 body: object, The request body.
6351 The object takes the form of:
6352
6353 {
6354 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
6355 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
6356 # of the firewall policy of the association.
6357 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
6358 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
6359 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
6360 # must be a positive value between 1 and 2147483647.
6361 # Firewall Policies are evaluated from highest to lowest priority where 1
6362 # is the highest priority and 2147483647 is the lowest priority.
6363 # The default value is `1000`. If two associations have the same priority
6364 # then lexicographical order on association names is applied.
6365 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
6366 }
6367
6368 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6369 that if you must retry your request, the server will know to ignore the
6370 request if it has already been completed.
6371
6372 For example, consider a situation where you make an initial request and
6373 the request times out. If you make the request again with the same
6374 request ID, the server can check if original operation with the same
6375 request ID was received, and if so, will ignore the second request. This
6376 prevents clients from accidentally creating duplicate commitments.
6377
6378 The request ID must be
6379 a valid UUID with the exception that zero UUID is not supported
6380 (00000000-0000-0000-0000-000000000000).
6381 x__xgafv: string, V1 error format.
6382 Allowed values
6383 1 - v1 error format
6384 2 - v2 error format
6385
6386 Returns:
6387 An object of the form:
6388
6389 { # Represents an Operation resource.
6390 #
6391 # Google Compute Engine has three Operation resources:
6392 #
6393 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6394 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6395 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6396 #
6397 # You can use an operation resource to manage asynchronous API requests.
6398 # For more information, readHandling
6399 # API responses.
6400 #
6401 # Operations can be global, regional or zonal.
6402 #
6403 # - For global operations, use the `globalOperations`
6404 # resource.
6405 # - For regional operations, use the
6406 # `regionOperations` resource.
6407 # - For zonal operations, use
6408 # the `zoneOperations` resource.
6409 #
6410 #
6411 #
6412 # For more information, read
6413 # Global, Regional, and Zonal Resources.
6414 #
6415 # Note that completed Operation resources have a limited
6416 # retention period.
6417 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6418 # Not present otherwise.
6419 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6420 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6421 # set when the operation is created.
6422 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6423 # text format.
6424 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6425 # this field will be populated.
6426 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6427 # operation.
6428 {
6429 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6430 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6431 # details. There is a set of defined message types to use for providing
6432 # details.The syntax depends on the error code. For example,
6433 # QuotaExceededInfo will have details when the error code is
6434 # QUOTA_EXCEEDED.
6435 {
6436 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6437 #
6438 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6439 # is not enabled:
6440 #
6441 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6442 # &quot;domain&quot;: &quot;googleapis.com&quot;
6443 # &quot;metadata&quot;: {
6444 # &quot;resource&quot;: &quot;projects/123&quot;,
6445 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6446 # }
6447 # }
6448 #
6449 # This response indicates that the pubsub.googleapis.com API is not enabled.
6450 #
6451 # Example of an error that is returned when attempting to create a Spanner
6452 # instance in a region that is out of stock:
6453 #
6454 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6455 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6456 # &quot;metadata&quot;: {
6457 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6458 # }
6459 # }
6460 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6461 # is typically the registered service name of the tool or product that
6462 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6463 # generated by some common infrastructure, the error domain must be a
6464 # globally unique value that identifies the infrastructure. For Google API
6465 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6466 &quot;metadatas&quot;: { # Additional structured details about this error.
6467 #
6468 # Keys must match a regular expression of `a-z+` but should
6469 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6470 # length. When identifying the current value of an exceeded limit, the units
6471 # should be contained in the key, not the value. For example, rather than
6472 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6473 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6474 # instances that can be created in a single (batch) request.
6475 &quot;a_key&quot;: &quot;A String&quot;,
6476 },
6477 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6478 # proximate cause of the error. Error reasons are unique within a particular
6479 # domain of errors. This should be at most 63 characters and match a
6480 # regular expression of `A-Z+[A-Z0-9]`, which represents
6481 # UPPER_SNAKE_CASE.
6482 },
6483 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6484 #
6485 # For example, if a quota check failed with an error indicating the calling
6486 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6487 # directly to the right place in the developer console to flip the bit.
6488 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6489 { # Describes a URL link.
6490 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6491 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6492 },
6493 ],
6494 },
6495 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6496 # which can be attached to an RPC error.
6497 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6498 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6499 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6500 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6501 },
6502 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6503 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6504 &quot;a_key&quot;: &quot;A String&quot;,
6505 },
6506 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6507 # type or metric.
6508 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6509 # or metric.
6510 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6511 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6512 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6513 },
6514 },
6515 ],
6516 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6517 # This property is optional.
6518 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6519 },
6520 ],
6521 },
6522 &quot;getVersionOperationMetadata&quot;: {
6523 &quot;inlineSbomInfo&quot;: {
6524 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6525 # appropriate identifiers.
6526 &quot;a_key&quot;: &quot;A String&quot;,
6527 },
6528 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6529 # identifiers.
6530 &quot;a_key&quot;: &quot;A String&quot;,
6531 },
6532 },
6533 },
6534 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6535 # message that was returned, such as `NOT FOUND`.
6536 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6537 # status code that was returned. For example, a `404` means the
6538 # resource was not found.
6539 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6540 # defined by the server.
6541 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6542 # This value is inRFC3339
6543 # text format.
6544 &quot;instancesBulkInsertOperationMetadata&quot;: {
6545 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6546 # Example key: zones/us-central1-a
6547 &quot;a_key&quot;: {
6548 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6549 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6550 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6551 # error.
6552 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6553 # if the flow is rolling forward or rolling back.
6554 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6555 },
6556 },
6557 },
6558 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6559 # Operation resources.
6560 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6561 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6562 # group of operations results from a `bulkInsert` API request.
6563 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6564 # `update`, or `delete`, and so on.
6565 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6566 # There is no requirement that this be linear or support any granularity of
6567 # operations. This should not be used to guess when the operation will be
6568 # complete. This number should monotonically increase as the operation
6569 # progresses.
6570 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6571 # applicable when performing regional operations.
6572 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6573 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6574 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6575 # this field will contain information on all underlying zonal actions and
6576 # their state.
6577 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6578 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6579 # Example key: zones/us-central1-a
6580 &quot;a_key&quot;: {
6581 &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
6582 # populated.
6583 # different programming environments, including REST APIs and RPC APIs. It is
6584 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6585 # three pieces of data: error code, error message, and error details.
6586 #
6587 # You can find out more about this error model and how to work with it in the
6588 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6589 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6590 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6591 # message types for APIs to use.
6592 {
6593 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6594 },
6595 ],
6596 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6597 # user-facing error message should be localized and sent in the
6598 # google.rpc.Status.details field, or localized by the client.
6599 },
6600 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6601 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6602 },
6603 },
6604 },
6605 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6606 # This value is inRFC3339
6607 # text format.
6608 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6609 # following:
6610 # `PENDING`, `RUNNING`, or `DONE`.
6611 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6612 # operation.
6613 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6614 # of the target resource.
6615 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6616 # operations related to creating a snapshot, this points to the disk
6617 # that the snapshot was created from.
6618 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6619 # `[email protected]` or
6620 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6621 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6622 # operation, this field will be populated.
6623 {
6624 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6625 # Engine returns NO_RESULTS_ON_PAGE if there
6626 # are no results in the response.
6627 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6628 # value format. For example:
6629 #
6630 # &quot;data&quot;: [
6631 # {
6632 # &quot;key&quot;: &quot;scope&quot;,
6633 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6634 # }
6635 {
6636 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6637 # returned. For example, for warnings where there are no results in a list
6638 # request for a particular zone, this key might be scope and
6639 # the key value might be the zone name. Other examples might be a key
6640 # indicating a deprecated resource and a suggested replacement, or a
6641 # warning about invalid network settings (for example, if an instance
6642 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6643 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6644 },
6645 ],
6646 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6647 },
6648 ],
6649 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6650 # applicable when performing per-zone operations.
6651 }</pre>
6652 </div>
6653
6654 <div class="method">
6655 <code class="details" id="patchPacketMirroringRule">patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code>
6656 <pre>Patches a packet mirroring rule of the specified priority.
6657
6658 Args:
6659 project: string, Project ID for this request. (required)
6660 firewallPolicy: string, Name of the firewall policy to update. (required)
6661 body: object, The request body.
6662 The object takes the form of:
6663
6664 { # Represents a rule that describes one or more match conditions along with
6665 # the action to be taken when traffic matches this condition (allow or deny).
6666 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
6667 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
6668 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
6669 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
6670 # and &quot;goto_next&quot;.
6671 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
6672 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
6673 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
6674 # the firewall policy rule is not enforced and traffic behaves as if it did
6675 # not exist. If this is unspecified, the firewall policy rule will be
6676 # enabled.
6677 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
6678 # enabled, logs will be exported to the configured export destination in
6679 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
6680 # cannot enable logging on &quot;goto_next&quot; rules.
6681 &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.
6682 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
6683 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
6684 # Exactly one field must be specified.
6685 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
6686 # Maximum number of destination address groups is 10.
6687 &quot;A String&quot;,
6688 ],
6689 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6690 # traffic destination.
6691 # Maximum number of destination fqdn allowed is 100.
6692 &quot;A String&quot;,
6693 ],
6694 &quot;destIpRanges&quot;: [ # CIDR IP address range.
6695 # Maximum number of destination CIDR IP ranges allowed is 5000.
6696 &quot;A String&quot;,
6697 ],
6698 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
6699 #
6700 #
6701 # - UNSPECIFIED
6702 # - INTERNET
6703 # - NON_INTERNET
6704 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
6705 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
6706 #
6707 #
6708 # - UNSPECIFIED
6709 # - INTERNET
6710 # - NON_INTERNET
6711 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
6712 # of traffic. Should be specified as 2 letter country code defined as per
6713 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6714 # Maximum number of dest region codes allowed is 5000.
6715 &quot;A String&quot;,
6716 ],
6717 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6718 # The IPs in these lists will be matched against traffic destination.
6719 &quot;A String&quot;,
6720 ],
6721 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
6722 {
6723 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
6724 # required when creating a firewall rule. This value can either be
6725 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
6726 # protocol number.
6727 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
6728 # only applicable for UDP or TCP protocol. Each entry must be either
6729 # an integer or a range. If not specified, this rule applies to
6730 # connections through any port.
6731 #
6732 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
6733 &quot;A String&quot;,
6734 ],
6735 },
6736 ],
6737 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
6738 # Maximum number of source address groups is 10.
6739 &quot;A String&quot;,
6740 ],
6741 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6742 # traffic source.
6743 # Maximum number of source fqdn allowed is 100.
6744 &quot;A String&quot;,
6745 ],
6746 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
6747 # Maximum number of source CIDR IP ranges allowed is 5000.
6748 &quot;A String&quot;,
6749 ],
6750 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
6751 #
6752 #
6753 # - UNSPECIFIED
6754 # - INTERNET
6755 # - INTRA_VPC
6756 # - NON_INTERNET
6757 # - VPC_NETWORKS
6758 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
6759 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
6760 #
6761 #
6762 # - UNSPECIFIED
6763 # - INTERNET
6764 # - INTRA_VPC
6765 # - NON_INTERNET
6766 # - VPC_NETWORKS
6767 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
6768 &quot;A String&quot;,
6769 ],
6770 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
6771 # of traffic. Should be specified as 2 letter country code defined as per
6772 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6773 # Maximum number of source region codes allowed is 5000.
6774 &quot;A String&quot;,
6775 ],
6776 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
6777 # of the traffic.
6778 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
6779 # and there is no srcIpRange, this rule will be ignored.
6780 # Maximum number of source tag values allowed is 256.
6781 {
6782 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6783 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6784 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6785 # or its network is deleted.
6786 },
6787 ],
6788 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6789 # The IPs in these lists will be matched against traffic source.
6790 &quot;A String&quot;,
6791 ],
6792 },
6793 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
6794 # must be a positive value between 0 and 2147483647.
6795 # Rules are evaluated from highest to lowest priority where 0 is the
6796 # highest priority and 2147483647 is the lowest priority.
6797 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
6798 # and can be updated.
6799 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
6800 # rule.
6801 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
6802 # Example:
6803 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
6804 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
6805 # &#x27;mirror&#x27;. Cannot be specified for other actions.
6806 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
6807 # This field allows you to control which load balancers get this rule.
6808 # For example, the following are valid values:
6809 #
6810 #
6811 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
6812 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
6813 # - projects/project/global/
6814 # forwardingRules/forwardingRule
6815 # - projects/project/regions/region/forwardingRules/
6816 # forwardingRule
6817 &quot;A String&quot;,
6818 ],
6819 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
6820 # allows you to control which network&#x27;s VMs get this rule. If this field
6821 # is left blank, all VMs within the organization will receive the rule.
6822 &quot;A String&quot;,
6823 ],
6824 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
6825 # applies to. If targetSecureTag are specified, then the
6826 # firewall rule applies only to instances in the VPC network that have one
6827 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
6828 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
6829 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
6830 # to all instances on the specified network.
6831 # Maximum number of target label tags allowed is 256.
6832 {
6833 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6834 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6835 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6836 # or its network is deleted.
6837 },
6838 ],
6839 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
6840 # applied with this rule.
6841 &quot;A String&quot;,
6842 ],
6843 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
6844 # Default value is INSTANCES.
6845 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
6846 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
6847 # be set for other actions.
6848 }
6849
6850 priority: integer, The priority of the rule to patch.
6851 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6852 that if you must retry your request, the server will know to ignore the
6853 request if it has already been completed.
6854
6855 For example, consider a situation where you make an initial request and
6856 the request times out. If you make the request again with the same
6857 request ID, the server can check if original operation with the same
6858 request ID was received, and if so, will ignore the second request. This
6859 prevents clients from accidentally creating duplicate commitments.
6860
6861 The request ID must be
6862 a valid UUID with the exception that zero UUID is not supported
6863 (00000000-0000-0000-0000-000000000000).
6864 x__xgafv: string, V1 error format.
6865 Allowed values
6866 1 - v1 error format
6867 2 - v2 error format
6868
6869 Returns:
6870 An object of the form:
6871
6872 { # Represents an Operation resource.
6873 #
6874 # Google Compute Engine has three Operation resources:
6875 #
6876 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6877 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6878 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6879 #
6880 # You can use an operation resource to manage asynchronous API requests.
6881 # For more information, readHandling
6882 # API responses.
6883 #
6884 # Operations can be global, regional or zonal.
6885 #
6886 # - For global operations, use the `globalOperations`
6887 # resource.
6888 # - For regional operations, use the
6889 # `regionOperations` resource.
6890 # - For zonal operations, use
6891 # the `zoneOperations` resource.
6892 #
6893 #
6894 #
6895 # For more information, read
6896 # Global, Regional, and Zonal Resources.
6897 #
6898 # Note that completed Operation resources have a limited
6899 # retention period.
6900 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6901 # Not present otherwise.
6902 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6903 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6904 # set when the operation is created.
6905 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6906 # text format.
6907 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6908 # this field will be populated.
6909 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6910 # operation.
6911 {
6912 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6913 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6914 # details. There is a set of defined message types to use for providing
6915 # details.The syntax depends on the error code. For example,
6916 # QuotaExceededInfo will have details when the error code is
6917 # QUOTA_EXCEEDED.
6918 {
6919 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6920 #
6921 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6922 # is not enabled:
6923 #
6924 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6925 # &quot;domain&quot;: &quot;googleapis.com&quot;
6926 # &quot;metadata&quot;: {
6927 # &quot;resource&quot;: &quot;projects/123&quot;,
6928 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6929 # }
6930 # }
6931 #
6932 # This response indicates that the pubsub.googleapis.com API is not enabled.
6933 #
6934 # Example of an error that is returned when attempting to create a Spanner
6935 # instance in a region that is out of stock:
6936 #
6937 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6938 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6939 # &quot;metadata&quot;: {
6940 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6941 # }
6942 # }
6943 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6944 # is typically the registered service name of the tool or product that
6945 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6946 # generated by some common infrastructure, the error domain must be a
6947 # globally unique value that identifies the infrastructure. For Google API
6948 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6949 &quot;metadatas&quot;: { # Additional structured details about this error.
6950 #
6951 # Keys must match a regular expression of `a-z+` but should
6952 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6953 # length. When identifying the current value of an exceeded limit, the units
6954 # should be contained in the key, not the value. For example, rather than
6955 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6956 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6957 # instances that can be created in a single (batch) request.
6958 &quot;a_key&quot;: &quot;A String&quot;,
6959 },
6960 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6961 # proximate cause of the error. Error reasons are unique within a particular
6962 # domain of errors. This should be at most 63 characters and match a
6963 # regular expression of `A-Z+[A-Z0-9]`, which represents
6964 # UPPER_SNAKE_CASE.
6965 },
6966 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6967 #
6968 # For example, if a quota check failed with an error indicating the calling
6969 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6970 # directly to the right place in the developer console to flip the bit.
6971 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6972 { # Describes a URL link.
6973 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6974 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6975 },
6976 ],
6977 },
6978 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6979 # which can be attached to an RPC error.
6980 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6981 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6982 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6983 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6984 },
6985 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6986 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6987 &quot;a_key&quot;: &quot;A String&quot;,
6988 },
6989 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6990 # type or metric.
6991 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6992 # or metric.
6993 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6994 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6995 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6996 },
6997 },
6998 ],
6999 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7000 # This property is optional.
7001 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7002 },
7003 ],
7004 },
7005 &quot;getVersionOperationMetadata&quot;: {
7006 &quot;inlineSbomInfo&quot;: {
7007 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7008 # appropriate identifiers.
7009 &quot;a_key&quot;: &quot;A String&quot;,
7010 },
7011 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7012 # identifiers.
7013 &quot;a_key&quot;: &quot;A String&quot;,
7014 },
7015 },
7016 },
7017 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7018 # message that was returned, such as `NOT FOUND`.
7019 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7020 # status code that was returned. For example, a `404` means the
7021 # resource was not found.
7022 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7023 # defined by the server.
7024 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7025 # This value is inRFC3339
7026 # text format.
7027 &quot;instancesBulkInsertOperationMetadata&quot;: {
7028 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7029 # Example key: zones/us-central1-a
7030 &quot;a_key&quot;: {
7031 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7032 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7033 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7034 # error.
7035 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7036 # if the flow is rolling forward or rolling back.
7037 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7038 },
7039 },
7040 },
7041 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7042 # Operation resources.
7043 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7044 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7045 # group of operations results from a `bulkInsert` API request.
7046 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7047 # `update`, or `delete`, and so on.
7048 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7049 # There is no requirement that this be linear or support any granularity of
7050 # operations. This should not be used to guess when the operation will be
7051 # complete. This number should monotonically increase as the operation
7052 # progresses.
7053 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7054 # applicable when performing regional operations.
7055 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7056 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7057 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7058 # this field will contain information on all underlying zonal actions and
7059 # their state.
7060 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7061 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7062 # Example key: zones/us-central1-a
7063 &quot;a_key&quot;: {
7064 &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
7065 # populated.
7066 # different programming environments, including REST APIs and RPC APIs. It is
7067 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7068 # three pieces of data: error code, error message, and error details.
7069 #
7070 # You can find out more about this error model and how to work with it in the
7071 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7072 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7073 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7074 # message types for APIs to use.
7075 {
7076 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7077 },
7078 ],
7079 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7080 # user-facing error message should be localized and sent in the
7081 # google.rpc.Status.details field, or localized by the client.
7082 },
7083 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7084 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7085 },
7086 },
7087 },
7088 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7089 # This value is inRFC3339
7090 # text format.
7091 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7092 # following:
7093 # `PENDING`, `RUNNING`, or `DONE`.
7094 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7095 # operation.
7096 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7097 # of the target resource.
7098 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7099 # operations related to creating a snapshot, this points to the disk
7100 # that the snapshot was created from.
7101 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7102 # `[email protected]` or
7103 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7104 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7105 # operation, this field will be populated.
7106 {
7107 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7108 # Engine returns NO_RESULTS_ON_PAGE if there
7109 # are no results in the response.
7110 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7111 # value format. For example:
7112 #
7113 # &quot;data&quot;: [
7114 # {
7115 # &quot;key&quot;: &quot;scope&quot;,
7116 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7117 # }
7118 {
7119 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7120 # returned. For example, for warnings where there are no results in a list
7121 # request for a particular zone, this key might be scope and
7122 # the key value might be the zone name. Other examples might be a key
7123 # indicating a deprecated resource and a suggested replacement, or a
7124 # warning about invalid network settings (for example, if an instance
7125 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7126 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7127 },
7128 ],
7129 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7130 },
7131 ],
7132 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7133 # applicable when performing per-zone operations.
7134 }</pre>
7135 </div>
7136
7137 <div class="method">
7138 <code class="details" id="patchRule">patchRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code>
7139 <pre>Patches a rule of the specified priority.
7140
7141 Args:
7142 project: string, Project ID for this request. (required)
7143 firewallPolicy: string, Name of the firewall policy to update. (required)
7144 body: object, The request body.
7145 The object takes the form of:
7146
7147 { # Represents a rule that describes one or more match conditions along with
7148 # the action to be taken when traffic matches this condition (allow or deny).
7149 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
7150 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
7151 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
7152 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
7153 # and &quot;goto_next&quot;.
7154 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
7155 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
7156 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
7157 # the firewall policy rule is not enforced and traffic behaves as if it did
7158 # not exist. If this is unspecified, the firewall policy rule will be
7159 # enabled.
7160 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
7161 # enabled, logs will be exported to the configured export destination in
7162 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
7163 # cannot enable logging on &quot;goto_next&quot; rules.
7164 &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.
7165 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
7166 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
7167 # Exactly one field must be specified.
7168 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
7169 # Maximum number of destination address groups is 10.
7170 &quot;A String&quot;,
7171 ],
7172 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
7173 # traffic destination.
7174 # Maximum number of destination fqdn allowed is 100.
7175 &quot;A String&quot;,
7176 ],
7177 &quot;destIpRanges&quot;: [ # CIDR IP address range.
7178 # Maximum number of destination CIDR IP ranges allowed is 5000.
7179 &quot;A String&quot;,
7180 ],
7181 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
7182 #
7183 #
7184 # - UNSPECIFIED
7185 # - INTERNET
7186 # - NON_INTERNET
7187 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
7188 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
7189 #
7190 #
7191 # - UNSPECIFIED
7192 # - INTERNET
7193 # - NON_INTERNET
7194 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
7195 # of traffic. Should be specified as 2 letter country code defined as per
7196 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
7197 # Maximum number of dest region codes allowed is 5000.
7198 &quot;A String&quot;,
7199 ],
7200 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
7201 # The IPs in these lists will be matched against traffic destination.
7202 &quot;A String&quot;,
7203 ],
7204 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
7205 {
7206 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
7207 # required when creating a firewall rule. This value can either be
7208 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
7209 # protocol number.
7210 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
7211 # only applicable for UDP or TCP protocol. Each entry must be either
7212 # an integer or a range. If not specified, this rule applies to
7213 # connections through any port.
7214 #
7215 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
7216 &quot;A String&quot;,
7217 ],
7218 },
7219 ],
7220 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
7221 # Maximum number of source address groups is 10.
7222 &quot;A String&quot;,
7223 ],
7224 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
7225 # traffic source.
7226 # Maximum number of source fqdn allowed is 100.
7227 &quot;A String&quot;,
7228 ],
7229 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
7230 # Maximum number of source CIDR IP ranges allowed is 5000.
7231 &quot;A String&quot;,
7232 ],
7233 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
7234 #
7235 #
7236 # - UNSPECIFIED
7237 # - INTERNET
7238 # - INTRA_VPC
7239 # - NON_INTERNET
7240 # - VPC_NETWORKS
7241 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
7242 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
7243 #
7244 #
7245 # - UNSPECIFIED
7246 # - INTERNET
7247 # - INTRA_VPC
7248 # - NON_INTERNET
7249 # - VPC_NETWORKS
7250 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
7251 &quot;A String&quot;,
7252 ],
7253 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
7254 # of traffic. Should be specified as 2 letter country code defined as per
7255 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
7256 # Maximum number of source region codes allowed is 5000.
7257 &quot;A String&quot;,
7258 ],
7259 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
7260 # of the traffic.
7261 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
7262 # and there is no srcIpRange, this rule will be ignored.
7263 # Maximum number of source tag values allowed is 256.
7264 {
7265 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
7266 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
7267 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
7268 # or its network is deleted.
7269 },
7270 ],
7271 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
7272 # The IPs in these lists will be matched against traffic source.
7273 &quot;A String&quot;,
7274 ],
7275 },
7276 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
7277 # must be a positive value between 0 and 2147483647.
7278 # Rules are evaluated from highest to lowest priority where 0 is the
7279 # highest priority and 2147483647 is the lowest priority.
7280 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
7281 # and can be updated.
7282 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
7283 # rule.
7284 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
7285 # Example:
7286 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
7287 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
7288 # &#x27;mirror&#x27;. Cannot be specified for other actions.
7289 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
7290 # This field allows you to control which load balancers get this rule.
7291 # For example, the following are valid values:
7292 #
7293 #
7294 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
7295 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
7296 # - projects/project/global/
7297 # forwardingRules/forwardingRule
7298 # - projects/project/regions/region/forwardingRules/
7299 # forwardingRule
7300 &quot;A String&quot;,
7301 ],
7302 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
7303 # allows you to control which network&#x27;s VMs get this rule. If this field
7304 # is left blank, all VMs within the organization will receive the rule.
7305 &quot;A String&quot;,
7306 ],
7307 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
7308 # applies to. If targetSecureTag are specified, then the
7309 # firewall rule applies only to instances in the VPC network that have one
7310 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
7311 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
7312 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
7313 # to all instances on the specified network.
7314 # Maximum number of target label tags allowed is 256.
7315 {
7316 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
7317 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
7318 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
7319 # or its network is deleted.
7320 },
7321 ],
7322 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
7323 # applied with this rule.
7324 &quot;A String&quot;,
7325 ],
7326 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
7327 # Default value is INSTANCES.
7328 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
7329 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
7330 # be set for other actions.
7331 }
7332
7333 priority: integer, The priority of the rule to patch.
7334 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7335 that if you must retry your request, the server will know to ignore the
7336 request if it has already been completed.
7337
7338 For example, consider a situation where you make an initial request and
7339 the request times out. If you make the request again with the same
7340 request ID, the server can check if original operation with the same
7341 request ID was received, and if so, will ignore the second request. This
7342 prevents clients from accidentally creating duplicate commitments.
7343
7344 The request ID must be
7345 a valid UUID with the exception that zero UUID is not supported
7346 (00000000-0000-0000-0000-000000000000).
7347 x__xgafv: string, V1 error format.
7348 Allowed values
7349 1 - v1 error format
7350 2 - v2 error format
7351
7352 Returns:
7353 An object of the form:
7354
7355 { # Represents an Operation resource.
7356 #
7357 # Google Compute Engine has three Operation resources:
7358 #
7359 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
7360 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
7361 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
7362 #
7363 # You can use an operation resource to manage asynchronous API requests.
7364 # For more information, readHandling
7365 # API responses.
7366 #
7367 # Operations can be global, regional or zonal.
7368 #
7369 # - For global operations, use the `globalOperations`
7370 # resource.
7371 # - For regional operations, use the
7372 # `regionOperations` resource.
7373 # - For zonal operations, use
7374 # the `zoneOperations` resource.
7375 #
7376 #
7377 #
7378 # For more information, read
7379 # Global, Regional, and Zonal Resources.
7380 #
7381 # Note that completed Operation resources have a limited
7382 # retention period.
7383 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7384 # Not present otherwise.
7385 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7386 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7387 # set when the operation is created.
7388 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7389 # text format.
7390 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7391 # this field will be populated.
7392 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7393 # operation.
7394 {
7395 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7396 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7397 # details. There is a set of defined message types to use for providing
7398 # details.The syntax depends on the error code. For example,
7399 # QuotaExceededInfo will have details when the error code is
7400 # QUOTA_EXCEEDED.
7401 {
7402 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7403 #
7404 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7405 # is not enabled:
7406 #
7407 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7408 # &quot;domain&quot;: &quot;googleapis.com&quot;
7409 # &quot;metadata&quot;: {
7410 # &quot;resource&quot;: &quot;projects/123&quot;,
7411 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7412 # }
7413 # }
7414 #
7415 # This response indicates that the pubsub.googleapis.com API is not enabled.
7416 #
7417 # Example of an error that is returned when attempting to create a Spanner
7418 # instance in a region that is out of stock:
7419 #
7420 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7421 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7422 # &quot;metadata&quot;: {
7423 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7424 # }
7425 # }
7426 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7427 # is typically the registered service name of the tool or product that
7428 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7429 # generated by some common infrastructure, the error domain must be a
7430 # globally unique value that identifies the infrastructure. For Google API
7431 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7432 &quot;metadatas&quot;: { # Additional structured details about this error.
7433 #
7434 # Keys must match a regular expression of `a-z+` but should
7435 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7436 # length. When identifying the current value of an exceeded limit, the units
7437 # should be contained in the key, not the value. For example, rather than
7438 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7439 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7440 # instances that can be created in a single (batch) request.
7441 &quot;a_key&quot;: &quot;A String&quot;,
7442 },
7443 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7444 # proximate cause of the error. Error reasons are unique within a particular
7445 # domain of errors. This should be at most 63 characters and match a
7446 # regular expression of `A-Z+[A-Z0-9]`, which represents
7447 # UPPER_SNAKE_CASE.
7448 },
7449 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7450 #
7451 # For example, if a quota check failed with an error indicating the calling
7452 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7453 # directly to the right place in the developer console to flip the bit.
7454 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7455 { # Describes a URL link.
7456 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7457 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7458 },
7459 ],
7460 },
7461 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7462 # which can be attached to an RPC error.
7463 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7464 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7465 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7466 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7467 },
7468 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7469 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7470 &quot;a_key&quot;: &quot;A String&quot;,
7471 },
7472 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7473 # type or metric.
7474 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7475 # or metric.
7476 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7477 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7478 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7479 },
7480 },
7481 ],
7482 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7483 # This property is optional.
7484 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7485 },
7486 ],
7487 },
7488 &quot;getVersionOperationMetadata&quot;: {
7489 &quot;inlineSbomInfo&quot;: {
7490 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7491 # appropriate identifiers.
7492 &quot;a_key&quot;: &quot;A String&quot;,
7493 },
7494 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7495 # identifiers.
7496 &quot;a_key&quot;: &quot;A String&quot;,
7497 },
7498 },
7499 },
7500 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7501 # message that was returned, such as `NOT FOUND`.
7502 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7503 # status code that was returned. For example, a `404` means the
7504 # resource was not found.
7505 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7506 # defined by the server.
7507 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7508 # This value is inRFC3339
7509 # text format.
7510 &quot;instancesBulkInsertOperationMetadata&quot;: {
7511 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7512 # Example key: zones/us-central1-a
7513 &quot;a_key&quot;: {
7514 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7515 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7516 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7517 # error.
7518 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7519 # if the flow is rolling forward or rolling back.
7520 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7521 },
7522 },
7523 },
7524 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7525 # Operation resources.
7526 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7527 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7528 # group of operations results from a `bulkInsert` API request.
7529 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7530 # `update`, or `delete`, and so on.
7531 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7532 # There is no requirement that this be linear or support any granularity of
7533 # operations. This should not be used to guess when the operation will be
7534 # complete. This number should monotonically increase as the operation
7535 # progresses.
7536 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7537 # applicable when performing regional operations.
7538 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7539 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7540 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7541 # this field will contain information on all underlying zonal actions and
7542 # their state.
7543 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7544 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7545 # Example key: zones/us-central1-a
7546 &quot;a_key&quot;: {
7547 &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
7548 # populated.
7549 # different programming environments, including REST APIs and RPC APIs. It is
7550 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7551 # three pieces of data: error code, error message, and error details.
7552 #
7553 # You can find out more about this error model and how to work with it in the
7554 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7555 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7556 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7557 # message types for APIs to use.
7558 {
7559 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7560 },
7561 ],
7562 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7563 # user-facing error message should be localized and sent in the
7564 # google.rpc.Status.details field, or localized by the client.
7565 },
7566 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7567 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7568 },
7569 },
7570 },
7571 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7572 # This value is inRFC3339
7573 # text format.
7574 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7575 # following:
7576 # `PENDING`, `RUNNING`, or `DONE`.
7577 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7578 # operation.
7579 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7580 # of the target resource.
7581 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7582 # operations related to creating a snapshot, this points to the disk
7583 # that the snapshot was created from.
7584 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7585 # `[email protected]` or
7586 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7587 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7588 # operation, this field will be populated.
7589 {
7590 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7591 # Engine returns NO_RESULTS_ON_PAGE if there
7592 # are no results in the response.
7593 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7594 # value format. For example:
7595 #
7596 # &quot;data&quot;: [
7597 # {
7598 # &quot;key&quot;: &quot;scope&quot;,
7599 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7600 # }
7601 {
7602 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7603 # returned. For example, for warnings where there are no results in a list
7604 # request for a particular zone, this key might be scope and
7605 # the key value might be the zone name. Other examples might be a key
7606 # indicating a deprecated resource and a suggested replacement, or a
7607 # warning about invalid network settings (for example, if an instance
7608 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7609 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7610 },
7611 ],
7612 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7613 },
7614 ],
7615 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7616 # applicable when performing per-zone operations.
7617 }</pre>
7618 </div>
7619
7620 <div class="method">
7621 <code class="details" id="removeAssociation">removeAssociation(project, firewallPolicy, name=None, requestId=None, x__xgafv=None)</code>
7622 <pre>Removes an association for the specified firewall policy.
7623
7624 Args:
7625 project: string, Project ID for this request. (required)
7626 firewallPolicy: string, Name of the firewall policy to update. (required)
7627 name: string, Name for the attachment that will be removed.
7628 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7629 that if you must retry your request, the server will know to ignore the
7630 request if it has already been completed.
7631
7632 For example, consider a situation where you make an initial request and
7633 the request times out. If you make the request again with the same
7634 request ID, the server can check if original operation with the same
7635 request ID was received, and if so, will ignore the second request. This
7636 prevents clients from accidentally creating duplicate commitments.
7637
7638 The request ID must be
7639 a valid UUID with the exception that zero UUID is not supported
7640 (00000000-0000-0000-0000-000000000000).
7641 x__xgafv: string, V1 error format.
7642 Allowed values
7643 1 - v1 error format
7644 2 - v2 error format
7645
7646 Returns:
7647 An object of the form:
7648
7649 { # Represents an Operation resource.
7650 #
7651 # Google Compute Engine has three Operation resources:
7652 #
7653 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
7654 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
7655 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
7656 #
7657 # You can use an operation resource to manage asynchronous API requests.
7658 # For more information, readHandling
7659 # API responses.
7660 #
7661 # Operations can be global, regional or zonal.
7662 #
7663 # - For global operations, use the `globalOperations`
7664 # resource.
7665 # - For regional operations, use the
7666 # `regionOperations` resource.
7667 # - For zonal operations, use
7668 # the `zoneOperations` resource.
7669 #
7670 #
7671 #
7672 # For more information, read
7673 # Global, Regional, and Zonal Resources.
7674 #
7675 # Note that completed Operation resources have a limited
7676 # retention period.
7677 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7678 # Not present otherwise.
7679 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7680 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7681 # set when the operation is created.
7682 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7683 # text format.
7684 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7685 # this field will be populated.
7686 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7687 # operation.
7688 {
7689 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7690 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7691 # details. There is a set of defined message types to use for providing
7692 # details.The syntax depends on the error code. For example,
7693 # QuotaExceededInfo will have details when the error code is
7694 # QUOTA_EXCEEDED.
7695 {
7696 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7697 #
7698 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7699 # is not enabled:
7700 #
7701 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7702 # &quot;domain&quot;: &quot;googleapis.com&quot;
7703 # &quot;metadata&quot;: {
7704 # &quot;resource&quot;: &quot;projects/123&quot;,
7705 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7706 # }
7707 # }
7708 #
7709 # This response indicates that the pubsub.googleapis.com API is not enabled.
7710 #
7711 # Example of an error that is returned when attempting to create a Spanner
7712 # instance in a region that is out of stock:
7713 #
7714 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7715 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7716 # &quot;metadata&quot;: {
7717 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7718 # }
7719 # }
7720 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7721 # is typically the registered service name of the tool or product that
7722 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7723 # generated by some common infrastructure, the error domain must be a
7724 # globally unique value that identifies the infrastructure. For Google API
7725 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7726 &quot;metadatas&quot;: { # Additional structured details about this error.
7727 #
7728 # Keys must match a regular expression of `a-z+` but should
7729 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7730 # length. When identifying the current value of an exceeded limit, the units
7731 # should be contained in the key, not the value. For example, rather than
7732 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7733 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7734 # instances that can be created in a single (batch) request.
7735 &quot;a_key&quot;: &quot;A String&quot;,
7736 },
7737 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7738 # proximate cause of the error. Error reasons are unique within a particular
7739 # domain of errors. This should be at most 63 characters and match a
7740 # regular expression of `A-Z+[A-Z0-9]`, which represents
7741 # UPPER_SNAKE_CASE.
7742 },
7743 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7744 #
7745 # For example, if a quota check failed with an error indicating the calling
7746 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7747 # directly to the right place in the developer console to flip the bit.
7748 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7749 { # Describes a URL link.
7750 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7751 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7752 },
7753 ],
7754 },
7755 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7756 # which can be attached to an RPC error.
7757 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7758 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7759 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7760 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7761 },
7762 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7763 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7764 &quot;a_key&quot;: &quot;A String&quot;,
7765 },
7766 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7767 # type or metric.
7768 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7769 # or metric.
7770 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7771 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7772 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7773 },
7774 },
7775 ],
7776 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7777 # This property is optional.
7778 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7779 },
7780 ],
7781 },
7782 &quot;getVersionOperationMetadata&quot;: {
7783 &quot;inlineSbomInfo&quot;: {
7784 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7785 # appropriate identifiers.
7786 &quot;a_key&quot;: &quot;A String&quot;,
7787 },
7788 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7789 # identifiers.
7790 &quot;a_key&quot;: &quot;A String&quot;,
7791 },
7792 },
7793 },
7794 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7795 # message that was returned, such as `NOT FOUND`.
7796 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7797 # status code that was returned. For example, a `404` means the
7798 # resource was not found.
7799 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7800 # defined by the server.
7801 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7802 # This value is inRFC3339
7803 # text format.
7804 &quot;instancesBulkInsertOperationMetadata&quot;: {
7805 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7806 # Example key: zones/us-central1-a
7807 &quot;a_key&quot;: {
7808 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7809 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7810 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7811 # error.
7812 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7813 # if the flow is rolling forward or rolling back.
7814 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7815 },
7816 },
7817 },
7818 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7819 # Operation resources.
7820 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7821 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7822 # group of operations results from a `bulkInsert` API request.
7823 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7824 # `update`, or `delete`, and so on.
7825 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7826 # There is no requirement that this be linear or support any granularity of
7827 # operations. This should not be used to guess when the operation will be
7828 # complete. This number should monotonically increase as the operation
7829 # progresses.
7830 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7831 # applicable when performing regional operations.
7832 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7833 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7834 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7835 # this field will contain information on all underlying zonal actions and
7836 # their state.
7837 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7838 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7839 # Example key: zones/us-central1-a
7840 &quot;a_key&quot;: {
7841 &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
7842 # populated.
7843 # different programming environments, including REST APIs and RPC APIs. It is
7844 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7845 # three pieces of data: error code, error message, and error details.
7846 #
7847 # You can find out more about this error model and how to work with it in the
7848 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7849 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7850 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7851 # message types for APIs to use.
7852 {
7853 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7854 },
7855 ],
7856 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7857 # user-facing error message should be localized and sent in the
7858 # google.rpc.Status.details field, or localized by the client.
7859 },
7860 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7861 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7862 },
7863 },
7864 },
7865 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7866 # This value is inRFC3339
7867 # text format.
7868 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7869 # following:
7870 # `PENDING`, `RUNNING`, or `DONE`.
7871 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7872 # operation.
7873 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7874 # of the target resource.
7875 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7876 # operations related to creating a snapshot, this points to the disk
7877 # that the snapshot was created from.
7878 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7879 # `[email protected]` or
7880 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7881 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7882 # operation, this field will be populated.
7883 {
7884 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7885 # Engine returns NO_RESULTS_ON_PAGE if there
7886 # are no results in the response.
7887 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7888 # value format. For example:
7889 #
7890 # &quot;data&quot;: [
7891 # {
7892 # &quot;key&quot;: &quot;scope&quot;,
7893 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7894 # }
7895 {
7896 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7897 # returned. For example, for warnings where there are no results in a list
7898 # request for a particular zone, this key might be scope and
7899 # the key value might be the zone name. Other examples might be a key
7900 # indicating a deprecated resource and a suggested replacement, or a
7901 # warning about invalid network settings (for example, if an instance
7902 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7903 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7904 },
7905 ],
7906 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7907 },
7908 ],
7909 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7910 # applicable when performing per-zone operations.
7911 }</pre>
7912 </div>
7913
7914 <div class="method">
7915 <code class="details" id="removePacketMirroringRule">removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code>
7916 <pre>Deletes a packet mirroring rule of the specified priority.
7917
7918 Args:
7919 project: string, Project ID for this request. (required)
7920 firewallPolicy: string, Name of the firewall policy to update. (required)
7921 priority: integer, The priority of the rule to remove from the firewall policy.
7922 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7923 that if you must retry your request, the server will know to ignore the
7924 request if it has already been completed.
7925
7926 For example, consider a situation where you make an initial request and
7927 the request times out. If you make the request again with the same
7928 request ID, the server can check if original operation with the same
7929 request ID was received, and if so, will ignore the second request. This
7930 prevents clients from accidentally creating duplicate commitments.
7931
7932 The request ID must be
7933 a valid UUID with the exception that zero UUID is not supported
7934 (00000000-0000-0000-0000-000000000000).
7935 x__xgafv: string, V1 error format.
7936 Allowed values
7937 1 - v1 error format
7938 2 - v2 error format
7939
7940 Returns:
7941 An object of the form:
7942
7943 { # Represents an Operation resource.
7944 #
7945 # Google Compute Engine has three Operation resources:
7946 #
7947 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
7948 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
7949 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
7950 #
7951 # You can use an operation resource to manage asynchronous API requests.
7952 # For more information, readHandling
7953 # API responses.
7954 #
7955 # Operations can be global, regional or zonal.
7956 #
7957 # - For global operations, use the `globalOperations`
7958 # resource.
7959 # - For regional operations, use the
7960 # `regionOperations` resource.
7961 # - For zonal operations, use
7962 # the `zoneOperations` resource.
7963 #
7964 #
7965 #
7966 # For more information, read
7967 # Global, Regional, and Zonal Resources.
7968 #
7969 # Note that completed Operation resources have a limited
7970 # retention period.
7971 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7972 # Not present otherwise.
7973 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7974 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7975 # set when the operation is created.
7976 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7977 # text format.
7978 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7979 # this field will be populated.
7980 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7981 # operation.
7982 {
7983 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7984 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7985 # details. There is a set of defined message types to use for providing
7986 # details.The syntax depends on the error code. For example,
7987 # QuotaExceededInfo will have details when the error code is
7988 # QUOTA_EXCEEDED.
7989 {
7990 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7991 #
7992 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7993 # is not enabled:
7994 #
7995 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7996 # &quot;domain&quot;: &quot;googleapis.com&quot;
7997 # &quot;metadata&quot;: {
7998 # &quot;resource&quot;: &quot;projects/123&quot;,
7999 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8000 # }
8001 # }
8002 #
8003 # This response indicates that the pubsub.googleapis.com API is not enabled.
8004 #
8005 # Example of an error that is returned when attempting to create a Spanner
8006 # instance in a region that is out of stock:
8007 #
8008 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8009 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8010 # &quot;metadata&quot;: {
8011 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8012 # }
8013 # }
8014 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8015 # is typically the registered service name of the tool or product that
8016 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8017 # generated by some common infrastructure, the error domain must be a
8018 # globally unique value that identifies the infrastructure. For Google API
8019 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8020 &quot;metadatas&quot;: { # Additional structured details about this error.
8021 #
8022 # Keys must match a regular expression of `a-z+` but should
8023 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8024 # length. When identifying the current value of an exceeded limit, the units
8025 # should be contained in the key, not the value. For example, rather than
8026 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8027 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8028 # instances that can be created in a single (batch) request.
8029 &quot;a_key&quot;: &quot;A String&quot;,
8030 },
8031 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8032 # proximate cause of the error. Error reasons are unique within a particular
8033 # domain of errors. This should be at most 63 characters and match a
8034 # regular expression of `A-Z+[A-Z0-9]`, which represents
8035 # UPPER_SNAKE_CASE.
8036 },
8037 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8038 #
8039 # For example, if a quota check failed with an error indicating the calling
8040 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8041 # directly to the right place in the developer console to flip the bit.
8042 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8043 { # Describes a URL link.
8044 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8045 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8046 },
8047 ],
8048 },
8049 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8050 # which can be attached to an RPC error.
8051 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8052 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8053 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8054 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8055 },
8056 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8057 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8058 &quot;a_key&quot;: &quot;A String&quot;,
8059 },
8060 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8061 # type or metric.
8062 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8063 # or metric.
8064 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8065 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8066 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8067 },
8068 },
8069 ],
8070 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8071 # This property is optional.
8072 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8073 },
8074 ],
8075 },
8076 &quot;getVersionOperationMetadata&quot;: {
8077 &quot;inlineSbomInfo&quot;: {
8078 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8079 # appropriate identifiers.
8080 &quot;a_key&quot;: &quot;A String&quot;,
8081 },
8082 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8083 # identifiers.
8084 &quot;a_key&quot;: &quot;A String&quot;,
8085 },
8086 },
8087 },
8088 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8089 # message that was returned, such as `NOT FOUND`.
8090 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8091 # status code that was returned. For example, a `404` means the
8092 # resource was not found.
8093 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8094 # defined by the server.
8095 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8096 # This value is inRFC3339
8097 # text format.
8098 &quot;instancesBulkInsertOperationMetadata&quot;: {
8099 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8100 # Example key: zones/us-central1-a
8101 &quot;a_key&quot;: {
8102 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8103 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8104 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8105 # error.
8106 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8107 # if the flow is rolling forward or rolling back.
8108 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8109 },
8110 },
8111 },
8112 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8113 # Operation resources.
8114 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8115 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8116 # group of operations results from a `bulkInsert` API request.
8117 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8118 # `update`, or `delete`, and so on.
8119 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8120 # There is no requirement that this be linear or support any granularity of
8121 # operations. This should not be used to guess when the operation will be
8122 # complete. This number should monotonically increase as the operation
8123 # progresses.
8124 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8125 # applicable when performing regional operations.
8126 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8127 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
8128 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8129 # this field will contain information on all underlying zonal actions and
8130 # their state.
8131 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8132 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8133 # Example key: zones/us-central1-a
8134 &quot;a_key&quot;: {
8135 &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
8136 # populated.
8137 # different programming environments, including REST APIs and RPC APIs. It is
8138 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8139 # three pieces of data: error code, error message, and error details.
8140 #
8141 # You can find out more about this error model and how to work with it in the
8142 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8143 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8144 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8145 # message types for APIs to use.
8146 {
8147 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8148 },
8149 ],
8150 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8151 # user-facing error message should be localized and sent in the
8152 # google.rpc.Status.details field, or localized by the client.
8153 },
8154 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8155 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8156 },
8157 },
8158 },
8159 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8160 # This value is inRFC3339
8161 # text format.
8162 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8163 # following:
8164 # `PENDING`, `RUNNING`, or `DONE`.
8165 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8166 # operation.
8167 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8168 # of the target resource.
8169 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8170 # operations related to creating a snapshot, this points to the disk
8171 # that the snapshot was created from.
8172 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8173 # `[email protected]` or
8174 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8175 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8176 # operation, this field will be populated.
8177 {
8178 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8179 # Engine returns NO_RESULTS_ON_PAGE if there
8180 # are no results in the response.
8181 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8182 # value format. For example:
8183 #
8184 # &quot;data&quot;: [
8185 # {
8186 # &quot;key&quot;: &quot;scope&quot;,
8187 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8188 # }
8189 {
8190 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8191 # returned. For example, for warnings where there are no results in a list
8192 # request for a particular zone, this key might be scope and
8193 # the key value might be the zone name. Other examples might be a key
8194 # indicating a deprecated resource and a suggested replacement, or a
8195 # warning about invalid network settings (for example, if an instance
8196 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8197 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8198 },
8199 ],
8200 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8201 },
8202 ],
8203 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8204 # applicable when performing per-zone operations.
8205 }</pre>
8206 </div>
8207
8208 <div class="method">
8209 <code class="details" id="removeRule">removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code>
8210 <pre>Deletes a rule of the specified priority.
8211
8212 Args:
8213 project: string, Project ID for this request. (required)
8214 firewallPolicy: string, Name of the firewall policy to update. (required)
8215 priority: integer, The priority of the rule to remove from the firewall policy.
8216 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8217 that if you must retry your request, the server will know to ignore the
8218 request if it has already been completed.
8219
8220 For example, consider a situation where you make an initial request and
8221 the request times out. If you make the request again with the same
8222 request ID, the server can check if original operation with the same
8223 request ID was received, and if so, will ignore the second request. This
8224 prevents clients from accidentally creating duplicate commitments.
8225
8226 The request ID must be
8227 a valid UUID with the exception that zero UUID is not supported
8228 (00000000-0000-0000-0000-000000000000).
8229 x__xgafv: string, V1 error format.
8230 Allowed values
8231 1 - v1 error format
8232 2 - v2 error format
8233
8234 Returns:
8235 An object of the form:
8236
8237 { # Represents an Operation resource.
8238 #
8239 # Google Compute Engine has three Operation resources:
8240 #
8241 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
8242 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
8243 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
8244 #
8245 # You can use an operation resource to manage asynchronous API requests.
8246 # For more information, readHandling
8247 # API responses.
8248 #
8249 # Operations can be global, regional or zonal.
8250 #
8251 # - For global operations, use the `globalOperations`
8252 # resource.
8253 # - For regional operations, use the
8254 # `regionOperations` resource.
8255 # - For zonal operations, use
8256 # the `zoneOperations` resource.
8257 #
8258 #
8259 #
8260 # For more information, read
8261 # Global, Regional, and Zonal Resources.
8262 #
8263 # Note that completed Operation resources have a limited
8264 # retention period.
8265 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8266 # Not present otherwise.
8267 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8268 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8269 # set when the operation is created.
8270 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8271 # text format.
8272 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8273 # this field will be populated.
8274 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8275 # operation.
8276 {
8277 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8278 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8279 # details. There is a set of defined message types to use for providing
8280 # details.The syntax depends on the error code. For example,
8281 # QuotaExceededInfo will have details when the error code is
8282 # QUOTA_EXCEEDED.
8283 {
8284 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8285 #
8286 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8287 # is not enabled:
8288 #
8289 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8290 # &quot;domain&quot;: &quot;googleapis.com&quot;
8291 # &quot;metadata&quot;: {
8292 # &quot;resource&quot;: &quot;projects/123&quot;,
8293 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8294 # }
8295 # }
8296 #
8297 # This response indicates that the pubsub.googleapis.com API is not enabled.
8298 #
8299 # Example of an error that is returned when attempting to create a Spanner
8300 # instance in a region that is out of stock:
8301 #
8302 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8303 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8304 # &quot;metadata&quot;: {
8305 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8306 # }
8307 # }
8308 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8309 # is typically the registered service name of the tool or product that
8310 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8311 # generated by some common infrastructure, the error domain must be a
8312 # globally unique value that identifies the infrastructure. For Google API
8313 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8314 &quot;metadatas&quot;: { # Additional structured details about this error.
8315 #
8316 # Keys must match a regular expression of `a-z+` but should
8317 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8318 # length. When identifying the current value of an exceeded limit, the units
8319 # should be contained in the key, not the value. For example, rather than
8320 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8321 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8322 # instances that can be created in a single (batch) request.
8323 &quot;a_key&quot;: &quot;A String&quot;,
8324 },
8325 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8326 # proximate cause of the error. Error reasons are unique within a particular
8327 # domain of errors. This should be at most 63 characters and match a
8328 # regular expression of `A-Z+[A-Z0-9]`, which represents
8329 # UPPER_SNAKE_CASE.
8330 },
8331 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8332 #
8333 # For example, if a quota check failed with an error indicating the calling
8334 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8335 # directly to the right place in the developer console to flip the bit.
8336 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8337 { # Describes a URL link.
8338 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8339 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8340 },
8341 ],
8342 },
8343 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8344 # which can be attached to an RPC error.
8345 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8346 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8347 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8348 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8349 },
8350 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8351 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8352 &quot;a_key&quot;: &quot;A String&quot;,
8353 },
8354 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8355 # type or metric.
8356 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8357 # or metric.
8358 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8359 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8360 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8361 },
8362 },
8363 ],
8364 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8365 # This property is optional.
8366 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8367 },
8368 ],
8369 },
8370 &quot;getVersionOperationMetadata&quot;: {
8371 &quot;inlineSbomInfo&quot;: {
8372 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8373 # appropriate identifiers.
8374 &quot;a_key&quot;: &quot;A String&quot;,
8375 },
8376 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8377 # identifiers.
8378 &quot;a_key&quot;: &quot;A String&quot;,
8379 },
8380 },
8381 },
8382 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8383 # message that was returned, such as `NOT FOUND`.
8384 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8385 # status code that was returned. For example, a `404` means the
8386 # resource was not found.
8387 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8388 # defined by the server.
8389 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8390 # This value is inRFC3339
8391 # text format.
8392 &quot;instancesBulkInsertOperationMetadata&quot;: {
8393 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8394 # Example key: zones/us-central1-a
8395 &quot;a_key&quot;: {
8396 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8397 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8398 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8399 # error.
8400 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8401 # if the flow is rolling forward or rolling back.
8402 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8403 },
8404 },
8405 },
8406 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8407 # Operation resources.
8408 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8409 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8410 # group of operations results from a `bulkInsert` API request.
8411 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8412 # `update`, or `delete`, and so on.
8413 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8414 # There is no requirement that this be linear or support any granularity of
8415 # operations. This should not be used to guess when the operation will be
8416 # complete. This number should monotonically increase as the operation
8417 # progresses.
8418 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8419 # applicable when performing regional operations.
8420 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8421 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
8422 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8423 # this field will contain information on all underlying zonal actions and
8424 # their state.
8425 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8426 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8427 # Example key: zones/us-central1-a
8428 &quot;a_key&quot;: {
8429 &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
8430 # populated.
8431 # different programming environments, including REST APIs and RPC APIs. It is
8432 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8433 # three pieces of data: error code, error message, and error details.
8434 #
8435 # You can find out more about this error model and how to work with it in the
8436 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8437 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8438 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8439 # message types for APIs to use.
8440 {
8441 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8442 },
8443 ],
8444 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8445 # user-facing error message should be localized and sent in the
8446 # google.rpc.Status.details field, or localized by the client.
8447 },
8448 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8449 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8450 },
8451 },
8452 },
8453 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8454 # This value is inRFC3339
8455 # text format.
8456 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8457 # following:
8458 # `PENDING`, `RUNNING`, or `DONE`.
8459 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8460 # operation.
8461 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8462 # of the target resource.
8463 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8464 # operations related to creating a snapshot, this points to the disk
8465 # that the snapshot was created from.
8466 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8467 # `[email protected]` or
8468 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8469 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8470 # operation, this field will be populated.
8471 {
8472 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8473 # Engine returns NO_RESULTS_ON_PAGE if there
8474 # are no results in the response.
8475 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8476 # value format. For example:
8477 #
8478 # &quot;data&quot;: [
8479 # {
8480 # &quot;key&quot;: &quot;scope&quot;,
8481 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8482 # }
8483 {
8484 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8485 # returned. For example, for warnings where there are no results in a list
8486 # request for a particular zone, this key might be scope and
8487 # the key value might be the zone name. Other examples might be a key
8488 # indicating a deprecated resource and a suggested replacement, or a
8489 # warning about invalid network settings (for example, if an instance
8490 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8491 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8492 },
8493 ],
8494 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8495 },
8496 ],
8497 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8498 # applicable when performing per-zone operations.
8499 }</pre>
8500 </div>
8501
8502 <div class="method">
8503 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
8504 <pre>Sets the access control policy on the specified resource.
8505 Replaces any existing policy.
8506
8507 Args:
8508 project: string, Project ID for this request. (required)
8509 resource: string, Name or id of the resource for this request. (required)
8510 body: object, The request body.
8511 The object takes the form of:
8512
8513 {
8514 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
8515 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
8516 { # Associates `members`, or principals, with a `role`.
8517 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8518 #
8519 # If the condition evaluates to `true`, then this binding applies to the
8520 # current request.
8521 #
8522 # If the condition evaluates to `false`, then this binding does not apply to
8523 # the current request. However, a different role binding might grant the same
8524 # role to one or more of the principals in this binding.
8525 #
8526 # To learn which resources support conditions in their IAM policies, see the
8527 # [IAM
8528 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8529 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8530 # are documented at https://github.com/google/cel-spec.
8531 #
8532 # Example (Comparison):
8533 #
8534 # title: &quot;Summary size limit&quot;
8535 # description: &quot;Determines if a summary is less than 100 chars&quot;
8536 # expression: &quot;document.summary.size() &lt; 100&quot;
8537 #
8538 # Example (Equality):
8539 #
8540 # title: &quot;Requestor is owner&quot;
8541 # description: &quot;Determines if requestor is the document owner&quot;
8542 # expression: &quot;document.owner == request.auth.claims.email&quot;
8543 #
8544 # Example (Logic):
8545 #
8546 # title: &quot;Public documents&quot;
8547 # description: &quot;Determine whether the document should be publicly visible&quot;
8548 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8549 #
8550 # Example (Data Manipulation):
8551 #
8552 # title: &quot;Notification string&quot;
8553 # description: &quot;Create a notification string with a timestamp.&quot;
8554 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8555 #
8556 # The exact variables and functions that may be referenced within an expression
8557 # are determined by the service that evaluates it. See the service
8558 # documentation for additional information.
8559 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8560 # describes the expression, e.g. when hovered over it in a UI.
8561 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8562 # syntax.
8563 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8564 # reporting, e.g. a file name and a position in the file.
8565 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8566 # its purpose. This can be used e.g. in UIs which allow to enter the
8567 # expression.
8568 },
8569 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8570 # `members` can have the following values:
8571 #
8572 # * `allUsers`: A special identifier that represents anyone who is
8573 # on the internet; with or without a Google account.
8574 #
8575 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8576 # who is authenticated with a Google account or a service account.
8577 # Does not include identities that come from external identity providers
8578 # (IdPs) through identity federation.
8579 #
8580 # * `user:{emailid}`: An email address that represents a specific Google
8581 # account. For example, `[email protected]` .
8582 #
8583 #
8584 # * `serviceAccount:{emailid}`: An email address that represents a Google
8585 # service account. For example,
8586 # `[email protected]`.
8587 #
8588 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8589 # identifier for a
8590 # [Kubernetes service
8591 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8592 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8593 #
8594 # * `group:{emailid}`: An email address that represents a Google group.
8595 # For example, `[email protected]`.
8596 #
8597 #
8598 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8599 # users of that domain. For example, `google.com` or `example.com`.
8600 #
8601 #
8602 #
8603 #
8604 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8605 # A single identity in a workforce identity pool.
8606 #
8607 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8608 # All workforce identities in a group.
8609 #
8610 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8611 # All workforce identities with a specific attribute value.
8612 #
8613 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8614 # All identities in a workforce identity pool.
8615 #
8616 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8617 # A single identity in a workload identity pool.
8618 #
8619 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8620 # A workload identity pool group.
8621 #
8622 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8623 # All identities in a workload identity pool with a certain attribute.
8624 #
8625 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8626 # All identities in a workload identity pool.
8627 #
8628 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8629 # identifier) representing a user that has been recently deleted. For
8630 # example, `[email protected]?uid=123456789012345678901`. If the user is
8631 # recovered, this value reverts to `user:{emailid}` and the recovered user
8632 # retains the role in the binding.
8633 #
8634 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8635 # unique identifier) representing a service account that has been recently
8636 # deleted. For example,
8637 # `[email protected]?uid=123456789012345678901`.
8638 # If the service account is undeleted, this value reverts to
8639 # `serviceAccount:{emailid}` and the undeleted service account retains the
8640 # role in the binding.
8641 #
8642 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8643 # identifier) representing a Google group that has been recently
8644 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8645 # the group is recovered, this value reverts to `group:{emailid}` and the
8646 # recovered group retains the role in the binding.
8647 #
8648 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8649 # Deleted single identity in a workforce identity pool. For example,
8650 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8651 &quot;A String&quot;,
8652 ],
8653 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8654 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8655 #
8656 # For an overview of the IAM roles and permissions, see the
8657 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8658 # a list of the available pre-defined roles, see
8659 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8660 },
8661 ],
8662 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
8663 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
8664 &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
8665 # the policy is limited to a few 10s of KB. An empty policy is in general a
8666 # valid policy but certain services (like Projects) might reject them.
8667 # controls for Google Cloud resources.
8668 #
8669 #
8670 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8671 # `members`, or principals, to a single `role`. Principals can be user
8672 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8673 # `role` is a named list of permissions; each `role` can be an IAM predefined
8674 # role or a user-created custom role.
8675 #
8676 # For some types of Google Cloud resources, a `binding` can also specify a
8677 # `condition`, which is a logical expression that allows access to a resource
8678 # only if the expression evaluates to `true`. A condition can add constraints
8679 # based on attributes of the request, the resource, or both. To learn which
8680 # resources support conditions in their IAM policies, see the
8681 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8682 #
8683 # **JSON example:**
8684 #
8685 # ```
8686 # {
8687 # &quot;bindings&quot;: [
8688 # {
8689 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8690 # &quot;members&quot;: [
8691 # &quot;user:[email protected]&quot;,
8692 # &quot;group:[email protected]&quot;,
8693 # &quot;domain:google.com&quot;,
8694 # &quot;serviceAccount:[email protected]&quot;
8695 # ]
8696 # },
8697 # {
8698 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8699 # &quot;members&quot;: [
8700 # &quot;user:[email protected]&quot;
8701 # ],
8702 # &quot;condition&quot;: {
8703 # &quot;title&quot;: &quot;expirable access&quot;,
8704 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8705 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8706 # }
8707 # }
8708 # ],
8709 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8710 # &quot;version&quot;: 3
8711 # }
8712 # ```
8713 #
8714 # **YAML example:**
8715 #
8716 # ```
8717 # bindings:
8718 # - members:
8719 # - user:[email protected]
8720 # - group:[email protected]
8721 # - domain:google.com
8722 # - serviceAccount:[email protected]
8723 # role: roles/resourcemanager.organizationAdmin
8724 # - members:
8725 # - user:[email protected]
8726 # role: roles/resourcemanager.organizationViewer
8727 # condition:
8728 # title: expirable access
8729 # description: Does not grant access after Sep 2020
8730 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8731 # etag: BwWWja0YfJA=
8732 # version: 3
8733 # ```
8734 #
8735 # For a description of IAM and its features, see the
8736 # [IAM documentation](https://cloud.google.com/iam/docs/).
8737 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8738 { # Specifies the audit configuration for a service.
8739 # The configuration determines which permission types are logged, and what
8740 # identities, if any, are exempted from logging.
8741 # An AuditConfig must have one or more AuditLogConfigs.
8742 #
8743 # If there are AuditConfigs for both `allServices` and a specific service,
8744 # the union of the two AuditConfigs is used for that service: the log_types
8745 # specified in each AuditConfig are enabled, and the exempted_members in each
8746 # AuditLogConfig are exempted.
8747 #
8748 # Example Policy with multiple AuditConfigs:
8749 #
8750 # {
8751 # &quot;audit_configs&quot;: [
8752 # {
8753 # &quot;service&quot;: &quot;allServices&quot;,
8754 # &quot;audit_log_configs&quot;: [
8755 # {
8756 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8757 # &quot;exempted_members&quot;: [
8758 # &quot;user:[email protected]&quot;
8759 # ]
8760 # },
8761 # {
8762 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8763 # },
8764 # {
8765 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8766 # }
8767 # ]
8768 # },
8769 # {
8770 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8771 # &quot;audit_log_configs&quot;: [
8772 # {
8773 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8774 # },
8775 # {
8776 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8777 # &quot;exempted_members&quot;: [
8778 # &quot;user:[email protected]&quot;
8779 # ]
8780 # }
8781 # ]
8782 # }
8783 # ]
8784 # }
8785 #
8786 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8787 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8788 # `[email protected]` from DATA_WRITE logging.
8789 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8790 { # Provides the configuration for logging a type of permissions.
8791 # Example:
8792 #
8793 # {
8794 # &quot;audit_log_configs&quot;: [
8795 # {
8796 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8797 # &quot;exempted_members&quot;: [
8798 # &quot;user:[email protected]&quot;
8799 # ]
8800 # },
8801 # {
8802 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8803 # }
8804 # ]
8805 # }
8806 #
8807 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8808 # [email protected] from DATA_READ logging.
8809 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8810 # permission.
8811 # Follows the same format of Binding.members.
8812 &quot;A String&quot;,
8813 ],
8814 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8815 },
8816 ],
8817 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8818 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8819 # `allServices` is a special value that covers all services.
8820 },
8821 ],
8822 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8823 # may specify a `condition` that determines how and when the `bindings` are
8824 # applied. Each of the `bindings` must contain at least one principal.
8825 #
8826 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8827 # of these principals can be Google groups. Each occurrence of a principal
8828 # counts towards these limits. For example, if the `bindings` grant 50
8829 # different roles to `user:[email protected]`, and not to any other
8830 # principal, then you can add another 1,450 principals to the `bindings` in
8831 # the `Policy`.
8832 { # Associates `members`, or principals, with a `role`.
8833 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8834 #
8835 # If the condition evaluates to `true`, then this binding applies to the
8836 # current request.
8837 #
8838 # If the condition evaluates to `false`, then this binding does not apply to
8839 # the current request. However, a different role binding might grant the same
8840 # role to one or more of the principals in this binding.
8841 #
8842 # To learn which resources support conditions in their IAM policies, see the
8843 # [IAM
8844 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8845 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8846 # are documented at https://github.com/google/cel-spec.
8847 #
8848 # Example (Comparison):
8849 #
8850 # title: &quot;Summary size limit&quot;
8851 # description: &quot;Determines if a summary is less than 100 chars&quot;
8852 # expression: &quot;document.summary.size() &lt; 100&quot;
8853 #
8854 # Example (Equality):
8855 #
8856 # title: &quot;Requestor is owner&quot;
8857 # description: &quot;Determines if requestor is the document owner&quot;
8858 # expression: &quot;document.owner == request.auth.claims.email&quot;
8859 #
8860 # Example (Logic):
8861 #
8862 # title: &quot;Public documents&quot;
8863 # description: &quot;Determine whether the document should be publicly visible&quot;
8864 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8865 #
8866 # Example (Data Manipulation):
8867 #
8868 # title: &quot;Notification string&quot;
8869 # description: &quot;Create a notification string with a timestamp.&quot;
8870 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8871 #
8872 # The exact variables and functions that may be referenced within an expression
8873 # are determined by the service that evaluates it. See the service
8874 # documentation for additional information.
8875 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8876 # describes the expression, e.g. when hovered over it in a UI.
8877 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8878 # syntax.
8879 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8880 # reporting, e.g. a file name and a position in the file.
8881 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8882 # its purpose. This can be used e.g. in UIs which allow to enter the
8883 # expression.
8884 },
8885 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8886 # `members` can have the following values:
8887 #
8888 # * `allUsers`: A special identifier that represents anyone who is
8889 # on the internet; with or without a Google account.
8890 #
8891 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8892 # who is authenticated with a Google account or a service account.
8893 # Does not include identities that come from external identity providers
8894 # (IdPs) through identity federation.
8895 #
8896 # * `user:{emailid}`: An email address that represents a specific Google
8897 # account. For example, `[email protected]` .
8898 #
8899 #
8900 # * `serviceAccount:{emailid}`: An email address that represents a Google
8901 # service account. For example,
8902 # `[email protected]`.
8903 #
8904 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8905 # identifier for a
8906 # [Kubernetes service
8907 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8908 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8909 #
8910 # * `group:{emailid}`: An email address that represents a Google group.
8911 # For example, `[email protected]`.
8912 #
8913 #
8914 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8915 # users of that domain. For example, `google.com` or `example.com`.
8916 #
8917 #
8918 #
8919 #
8920 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8921 # A single identity in a workforce identity pool.
8922 #
8923 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8924 # All workforce identities in a group.
8925 #
8926 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8927 # All workforce identities with a specific attribute value.
8928 #
8929 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8930 # All identities in a workforce identity pool.
8931 #
8932 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8933 # A single identity in a workload identity pool.
8934 #
8935 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8936 # A workload identity pool group.
8937 #
8938 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8939 # All identities in a workload identity pool with a certain attribute.
8940 #
8941 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8942 # All identities in a workload identity pool.
8943 #
8944 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8945 # identifier) representing a user that has been recently deleted. For
8946 # example, `[email protected]?uid=123456789012345678901`. If the user is
8947 # recovered, this value reverts to `user:{emailid}` and the recovered user
8948 # retains the role in the binding.
8949 #
8950 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8951 # unique identifier) representing a service account that has been recently
8952 # deleted. For example,
8953 # `[email protected]?uid=123456789012345678901`.
8954 # If the service account is undeleted, this value reverts to
8955 # `serviceAccount:{emailid}` and the undeleted service account retains the
8956 # role in the binding.
8957 #
8958 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8959 # identifier) representing a Google group that has been recently
8960 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8961 # the group is recovered, this value reverts to `group:{emailid}` and the
8962 # recovered group retains the role in the binding.
8963 #
8964 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8965 # Deleted single identity in a workforce identity pool. For example,
8966 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8967 &quot;A String&quot;,
8968 ],
8969 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8970 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8971 #
8972 # For an overview of the IAM roles and permissions, see the
8973 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8974 # a list of the available pre-defined roles, see
8975 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8976 },
8977 ],
8978 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8979 # prevent simultaneous updates of a policy from overwriting each other.
8980 # It is strongly suggested that systems make use of the `etag` in the
8981 # read-modify-write cycle to perform policy updates in order to avoid race
8982 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8983 # systems are expected to put that etag in the request to `setIamPolicy` to
8984 # ensure that their change will be applied to the same version of the policy.
8985 #
8986 # **Important:** If you use IAM Conditions, you must include the `etag` field
8987 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8988 # you to overwrite a version `3` policy with a version `1` policy, and all of
8989 # the conditions in the version `3` policy are lost.
8990 &quot;version&quot;: 42, # Specifies the format of the policy.
8991 #
8992 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8993 # are rejected.
8994 #
8995 # Any operation that affects conditional role bindings must specify version
8996 # `3`. This requirement applies to the following operations:
8997 #
8998 # * Getting a policy that includes a conditional role binding
8999 # * Adding a conditional role binding to a policy
9000 # * Changing a conditional role binding in a policy
9001 # * Removing any role binding, with or without a condition, from a policy
9002 # that includes conditions
9003 #
9004 # **Important:** If you use IAM Conditions, you must include the `etag` field
9005 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9006 # you to overwrite a version `3` policy with a version `1` policy, and all of
9007 # the conditions in the version `3` policy are lost.
9008 #
9009 # If a policy does not include any conditions, operations on that policy may
9010 # specify any valid version or leave the field unset.
9011 #
9012 # To learn which resources support conditions in their IAM policies, see the
9013 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9014 },
9015 }
9016
9017 x__xgafv: string, V1 error format.
9018 Allowed values
9019 1 - v1 error format
9020 2 - v2 error format
9021
9022 Returns:
9023 An object of the form:
9024
9025 { # An Identity and Access Management (IAM) policy, which specifies access
9026 # controls for Google Cloud resources.
9027 #
9028 #
9029 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
9030 # `members`, or principals, to a single `role`. Principals can be user
9031 # accounts, service accounts, Google groups, and domains (such as G Suite). A
9032 # `role` is a named list of permissions; each `role` can be an IAM predefined
9033 # role or a user-created custom role.
9034 #
9035 # For some types of Google Cloud resources, a `binding` can also specify a
9036 # `condition`, which is a logical expression that allows access to a resource
9037 # only if the expression evaluates to `true`. A condition can add constraints
9038 # based on attributes of the request, the resource, or both. To learn which
9039 # resources support conditions in their IAM policies, see the
9040 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9041 #
9042 # **JSON example:**
9043 #
9044 # ```
9045 # {
9046 # &quot;bindings&quot;: [
9047 # {
9048 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
9049 # &quot;members&quot;: [
9050 # &quot;user:[email protected]&quot;,
9051 # &quot;group:[email protected]&quot;,
9052 # &quot;domain:google.com&quot;,
9053 # &quot;serviceAccount:[email protected]&quot;
9054 # ]
9055 # },
9056 # {
9057 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
9058 # &quot;members&quot;: [
9059 # &quot;user:[email protected]&quot;
9060 # ],
9061 # &quot;condition&quot;: {
9062 # &quot;title&quot;: &quot;expirable access&quot;,
9063 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
9064 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
9065 # }
9066 # }
9067 # ],
9068 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
9069 # &quot;version&quot;: 3
9070 # }
9071 # ```
9072 #
9073 # **YAML example:**
9074 #
9075 # ```
9076 # bindings:
9077 # - members:
9078 # - user:[email protected]
9079 # - group:[email protected]
9080 # - domain:google.com
9081 # - serviceAccount:[email protected]
9082 # role: roles/resourcemanager.organizationAdmin
9083 # - members:
9084 # - user:[email protected]
9085 # role: roles/resourcemanager.organizationViewer
9086 # condition:
9087 # title: expirable access
9088 # description: Does not grant access after Sep 2020
9089 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
9090 # etag: BwWWja0YfJA=
9091 # version: 3
9092 # ```
9093 #
9094 # For a description of IAM and its features, see the
9095 # [IAM documentation](https://cloud.google.com/iam/docs/).
9096 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
9097 { # Specifies the audit configuration for a service.
9098 # The configuration determines which permission types are logged, and what
9099 # identities, if any, are exempted from logging.
9100 # An AuditConfig must have one or more AuditLogConfigs.
9101 #
9102 # If there are AuditConfigs for both `allServices` and a specific service,
9103 # the union of the two AuditConfigs is used for that service: the log_types
9104 # specified in each AuditConfig are enabled, and the exempted_members in each
9105 # AuditLogConfig are exempted.
9106 #
9107 # Example Policy with multiple AuditConfigs:
9108 #
9109 # {
9110 # &quot;audit_configs&quot;: [
9111 # {
9112 # &quot;service&quot;: &quot;allServices&quot;,
9113 # &quot;audit_log_configs&quot;: [
9114 # {
9115 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
9116 # &quot;exempted_members&quot;: [
9117 # &quot;user:[email protected]&quot;
9118 # ]
9119 # },
9120 # {
9121 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
9122 # },
9123 # {
9124 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
9125 # }
9126 # ]
9127 # },
9128 # {
9129 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
9130 # &quot;audit_log_configs&quot;: [
9131 # {
9132 # &quot;log_type&quot;: &quot;DATA_READ&quot;
9133 # },
9134 # {
9135 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
9136 # &quot;exempted_members&quot;: [
9137 # &quot;user:[email protected]&quot;
9138 # ]
9139 # }
9140 # ]
9141 # }
9142 # ]
9143 # }
9144 #
9145 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
9146 # logging. It also exempts `[email protected]` from DATA_READ logging, and
9147 # `[email protected]` from DATA_WRITE logging.
9148 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
9149 { # Provides the configuration for logging a type of permissions.
9150 # Example:
9151 #
9152 # {
9153 # &quot;audit_log_configs&quot;: [
9154 # {
9155 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
9156 # &quot;exempted_members&quot;: [
9157 # &quot;user:[email protected]&quot;
9158 # ]
9159 # },
9160 # {
9161 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
9162 # }
9163 # ]
9164 # }
9165 #
9166 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
9167 # [email protected] from DATA_READ logging.
9168 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
9169 # permission.
9170 # Follows the same format of Binding.members.
9171 &quot;A String&quot;,
9172 ],
9173 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
9174 },
9175 ],
9176 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
9177 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
9178 # `allServices` is a special value that covers all services.
9179 },
9180 ],
9181 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
9182 # may specify a `condition` that determines how and when the `bindings` are
9183 # applied. Each of the `bindings` must contain at least one principal.
9184 #
9185 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
9186 # of these principals can be Google groups. Each occurrence of a principal
9187 # counts towards these limits. For example, if the `bindings` grant 50
9188 # different roles to `user:[email protected]`, and not to any other
9189 # principal, then you can add another 1,450 principals to the `bindings` in
9190 # the `Policy`.
9191 { # Associates `members`, or principals, with a `role`.
9192 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
9193 #
9194 # If the condition evaluates to `true`, then this binding applies to the
9195 # current request.
9196 #
9197 # If the condition evaluates to `false`, then this binding does not apply to
9198 # the current request. However, a different role binding might grant the same
9199 # role to one or more of the principals in this binding.
9200 #
9201 # To learn which resources support conditions in their IAM policies, see the
9202 # [IAM
9203 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9204 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9205 # are documented at https://github.com/google/cel-spec.
9206 #
9207 # Example (Comparison):
9208 #
9209 # title: &quot;Summary size limit&quot;
9210 # description: &quot;Determines if a summary is less than 100 chars&quot;
9211 # expression: &quot;document.summary.size() &lt; 100&quot;
9212 #
9213 # Example (Equality):
9214 #
9215 # title: &quot;Requestor is owner&quot;
9216 # description: &quot;Determines if requestor is the document owner&quot;
9217 # expression: &quot;document.owner == request.auth.claims.email&quot;
9218 #
9219 # Example (Logic):
9220 #
9221 # title: &quot;Public documents&quot;
9222 # description: &quot;Determine whether the document should be publicly visible&quot;
9223 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9224 #
9225 # Example (Data Manipulation):
9226 #
9227 # title: &quot;Notification string&quot;
9228 # description: &quot;Create a notification string with a timestamp.&quot;
9229 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9230 #
9231 # The exact variables and functions that may be referenced within an expression
9232 # are determined by the service that evaluates it. See the service
9233 # documentation for additional information.
9234 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9235 # describes the expression, e.g. when hovered over it in a UI.
9236 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9237 # syntax.
9238 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9239 # reporting, e.g. a file name and a position in the file.
9240 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9241 # its purpose. This can be used e.g. in UIs which allow to enter the
9242 # expression.
9243 },
9244 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
9245 # `members` can have the following values:
9246 #
9247 # * `allUsers`: A special identifier that represents anyone who is
9248 # on the internet; with or without a Google account.
9249 #
9250 # * `allAuthenticatedUsers`: A special identifier that represents anyone
9251 # who is authenticated with a Google account or a service account.
9252 # Does not include identities that come from external identity providers
9253 # (IdPs) through identity federation.
9254 #
9255 # * `user:{emailid}`: An email address that represents a specific Google
9256 # account. For example, `[email protected]` .
9257 #
9258 #
9259 # * `serviceAccount:{emailid}`: An email address that represents a Google
9260 # service account. For example,
9261 # `[email protected]`.
9262 #
9263 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
9264 # identifier for a
9265 # [Kubernetes service
9266 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
9267 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
9268 #
9269 # * `group:{emailid}`: An email address that represents a Google group.
9270 # For example, `[email protected]`.
9271 #
9272 #
9273 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
9274 # users of that domain. For example, `google.com` or `example.com`.
9275 #
9276 #
9277 #
9278 #
9279 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
9280 # A single identity in a workforce identity pool.
9281 #
9282 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
9283 # All workforce identities in a group.
9284 #
9285 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
9286 # All workforce identities with a specific attribute value.
9287 #
9288 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
9289 # All identities in a workforce identity pool.
9290 #
9291 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
9292 # A single identity in a workload identity pool.
9293 #
9294 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
9295 # A workload identity pool group.
9296 #
9297 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
9298 # All identities in a workload identity pool with a certain attribute.
9299 #
9300 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
9301 # All identities in a workload identity pool.
9302 #
9303 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
9304 # identifier) representing a user that has been recently deleted. For
9305 # example, `[email protected]?uid=123456789012345678901`. If the user is
9306 # recovered, this value reverts to `user:{emailid}` and the recovered user
9307 # retains the role in the binding.
9308 #
9309 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
9310 # unique identifier) representing a service account that has been recently
9311 # deleted. For example,
9312 # `[email protected]?uid=123456789012345678901`.
9313 # If the service account is undeleted, this value reverts to
9314 # `serviceAccount:{emailid}` and the undeleted service account retains the
9315 # role in the binding.
9316 #
9317 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
9318 # identifier) representing a Google group that has been recently
9319 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
9320 # the group is recovered, this value reverts to `group:{emailid}` and the
9321 # recovered group retains the role in the binding.
9322 #
9323 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
9324 # Deleted single identity in a workforce identity pool. For example,
9325 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
9326 &quot;A String&quot;,
9327 ],
9328 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
9329 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
9330 #
9331 # For an overview of the IAM roles and permissions, see the
9332 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
9333 # a list of the available pre-defined roles, see
9334 # [here](https://cloud.google.com/iam/docs/understanding-roles).
9335 },
9336 ],
9337 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
9338 # prevent simultaneous updates of a policy from overwriting each other.
9339 # It is strongly suggested that systems make use of the `etag` in the
9340 # read-modify-write cycle to perform policy updates in order to avoid race
9341 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
9342 # systems are expected to put that etag in the request to `setIamPolicy` to
9343 # ensure that their change will be applied to the same version of the policy.
9344 #
9345 # **Important:** If you use IAM Conditions, you must include the `etag` field
9346 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9347 # you to overwrite a version `3` policy with a version `1` policy, and all of
9348 # the conditions in the version `3` policy are lost.
9349 &quot;version&quot;: 42, # Specifies the format of the policy.
9350 #
9351 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
9352 # are rejected.
9353 #
9354 # Any operation that affects conditional role bindings must specify version
9355 # `3`. This requirement applies to the following operations:
9356 #
9357 # * Getting a policy that includes a conditional role binding
9358 # * Adding a conditional role binding to a policy
9359 # * Changing a conditional role binding in a policy
9360 # * Removing any role binding, with or without a condition, from a policy
9361 # that includes conditions
9362 #
9363 # **Important:** If you use IAM Conditions, you must include the `etag` field
9364 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9365 # you to overwrite a version `3` policy with a version `1` policy, and all of
9366 # the conditions in the version `3` policy are lost.
9367 #
9368 # If a policy does not include any conditions, operations on that policy may
9369 # specify any valid version or leave the field unset.
9370 #
9371 # To learn which resources support conditions in their IAM policies, see the
9372 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9373 }</pre>
9374 </div>
9375
9376 <div class="method">
9377 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
9378 <pre>Returns permissions that a caller has on the specified resource.
9379
9380 Args:
9381 project: string, Project ID for this request. (required)
9382 resource: string, Name or id of the resource for this request. (required)
9383 body: object, The request body.
9384 The object takes the form of:
9385
9386 {
9387 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
9388 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
9389 &quot;A String&quot;,
9390 ],
9391 }
9392
9393 x__xgafv: string, V1 error format.
9394 Allowed values
9395 1 - v1 error format
9396 2 - v2 error format
9397
9398 Returns:
9399 An object of the form:
9400
9401 {
9402 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
9403 # allowed.
9404 &quot;A String&quot;,
9405 ],
9406 }</pre>
9407 </div>
9408
9409 </body></html>