Debian Codegraph @

docs/dyn/compute_alpha.firewallPolicies.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.firewallPolicies.html">firewallPolicies</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addAssociation">addAssociation(firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Inserts an association for the specified firewall policy.</p>
80 <p class="toc_element">
81 <code><a href="#addPacketMirroringRule">addPacketMirroringRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Inserts a packet mirroring rule into a firewall policy.</p>
83 <p class="toc_element">
84 <code><a href="#addRule">addRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Inserts a rule into a firewall policy.</p>
86 <p class="toc_element">
87 <code><a href="#cloneRules">cloneRules(firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Copies rules to the specified firewall policy.</p>
89 <p class="toc_element">
90 <code><a href="#close">close()</a></code></p>
91 <p class="firstline">Close httplib2 connections.</p>
92 <p class="toc_element">
93 <code><a href="#delete">delete(firewallPolicy, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Deletes the specified policy.</p>
95 <p class="toc_element">
96 <code><a href="#forceStartProgressiveRollout">forceStartProgressiveRollout(firewallPolicy, x__xgafv=None)</a></code></p>
97 <p class="firstline">Starts a brand new progressive rollout of hierarchical firewall policy.</p>
98 <p class="toc_element">
99 <code><a href="#get">get(firewallPolicy, x__xgafv=None)</a></code></p>
100 <p class="firstline">Returns the specified firewall policy.</p>
101 <p class="toc_element">
102 <code><a href="#getAssociation">getAssociation(firewallPolicy, name=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Gets an association with the specified name.</p>
104 <p class="toc_element">
105 <code><a href="#getIamPolicy">getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
107 <p class="toc_element">
108 <code><a href="#getPacketMirroringRule">getPacketMirroringRule(firewallPolicy, priority=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Gets a packet mirroring rule of the specified priority.</p>
110 <p class="toc_element">
111 <code><a href="#getRule">getRule(firewallPolicy, priority=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Gets a rule of the specified priority.</p>
113 <p class="toc_element">
114 <code><a href="#insert">insert(body=None, parentId=None, requestId=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Creates a new policy in the specified project using the data included in</p>
116 <p class="toc_element">
117 <code><a href="#list">list(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Lists all the policies that have been configured for the specified</p>
119 <p class="toc_element">
120 <code><a href="#listAssociations">listAssociations(includeInheritedPolicies=None, targetResource=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Lists associations of a specified target, i.e., organization or folder.</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="#move">move(firewallPolicy, parentId=None, requestId=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Moves the specified firewall policy.</p>
128 <p class="toc_element">
129 <code><a href="#patch">patch(firewallPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Patches the specified policy with the data included in the request.</p>
131 <p class="toc_element">
132 <code><a href="#patchPacketMirroringRule">patchPacketMirroringRule(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(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(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(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(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(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(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(firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</code>
155 <pre>Inserts an association for the specified firewall policy.
156
157 Args:
158 firewallPolicy: string, Name of the firewall policy to update. (required)
159 body: object, The request body.
160 The object takes the form of:
161
162 {
163 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
164 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
165 # of the firewall policy of the association.
166 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
167 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
168 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
169 # must be a positive value between 1 and 2147483647.
170 # Firewall Policies are evaluated from highest to lowest priority where 1
171 # is the highest priority and 2147483647 is the lowest priority.
172 # The default value is `1000`. If two associations have the same priority
173 # then lexicographical order on association names is applied.
174 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
175 }
176
177 replaceExistingAssociation: boolean, Indicates whether or not to replace it if an association of the attachment
178 already exists. This is false by default, in which case an error will be
179 returned if an association already exists.
180 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
181 that if you must retry your request, the server will know to ignore the
182 request if it has already been completed.
183
184 For example, consider a situation where you make an initial request and
185 the request times out. If you make the request again with the same
186 request ID, the server can check if original operation with the same
187 request ID was received, and if so, will ignore the second request. This
188 prevents clients from accidentally creating duplicate commitments.
189
190 The request ID must be
191 a valid UUID with the exception that zero UUID is not supported
192 (00000000-0000-0000-0000-000000000000).
193 x__xgafv: string, V1 error format.
194 Allowed values
195 1 - v1 error format
196 2 - v2 error format
197
198 Returns:
199 An object of the form:
200
201 { # Represents an Operation resource.
202 #
203 # Google Compute Engine has three Operation resources:
204 #
205 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
206 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
207 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
208 #
209 # You can use an operation resource to manage asynchronous API requests.
210 # For more information, readHandling
211 # API responses.
212 #
213 # Operations can be global, regional or zonal.
214 #
215 # - For global operations, use the `globalOperations`
216 # resource.
217 # - For regional operations, use the
218 # `regionOperations` resource.
219 # - For zonal operations, use
220 # the `zoneOperations` resource.
221 #
222 #
223 #
224 # For more information, read
225 # Global, Regional, and Zonal Resources.
226 #
227 # Note that completed Operation resources have a limited
228 # retention period.
229 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
230 # Not present otherwise.
231 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
232 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
233 # set when the operation is created.
234 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
235 # text format.
236 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
237 # this field will be populated.
238 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
239 # operation.
240 {
241 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
242 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
243 # details. There is a set of defined message types to use for providing
244 # details.The syntax depends on the error code. For example,
245 # QuotaExceededInfo will have details when the error code is
246 # QUOTA_EXCEEDED.
247 {
248 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
249 #
250 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
251 # is not enabled:
252 #
253 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
254 # &quot;domain&quot;: &quot;googleapis.com&quot;
255 # &quot;metadata&quot;: {
256 # &quot;resource&quot;: &quot;projects/123&quot;,
257 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
258 # }
259 # }
260 #
261 # This response indicates that the pubsub.googleapis.com API is not enabled.
262 #
263 # Example of an error that is returned when attempting to create a Spanner
264 # instance in a region that is out of stock:
265 #
266 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
267 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
268 # &quot;metadata&quot;: {
269 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
270 # }
271 # }
272 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
273 # is typically the registered service name of the tool or product that
274 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
275 # generated by some common infrastructure, the error domain must be a
276 # globally unique value that identifies the infrastructure. For Google API
277 # infrastructure, the error domain is &quot;googleapis.com&quot;.
278 &quot;metadatas&quot;: { # Additional structured details about this error.
279 #
280 # Keys must match a regular expression of `a-z+` but should
281 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
282 # length. When identifying the current value of an exceeded limit, the units
283 # should be contained in the key, not the value. For example, rather than
284 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
285 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
286 # instances that can be created in a single (batch) request.
287 &quot;a_key&quot;: &quot;A String&quot;,
288 },
289 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
290 # proximate cause of the error. Error reasons are unique within a particular
291 # domain of errors. This should be at most 63 characters and match a
292 # regular expression of `A-Z+[A-Z0-9]`, which represents
293 # UPPER_SNAKE_CASE.
294 },
295 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
296 #
297 # For example, if a quota check failed with an error indicating the calling
298 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
299 # directly to the right place in the developer console to flip the bit.
300 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
301 { # Describes a URL link.
302 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
303 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
304 },
305 ],
306 },
307 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
308 # which can be attached to an RPC error.
309 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
310 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
311 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
312 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
313 },
314 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
315 &quot;dimensions&quot;: { # The map holding related quota dimensions.
316 &quot;a_key&quot;: &quot;A String&quot;,
317 },
318 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
319 # type or metric.
320 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
321 # or metric.
322 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
323 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
324 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
325 },
326 },
327 ],
328 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
329 # This property is optional.
330 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
331 },
332 ],
333 },
334 &quot;getVersionOperationMetadata&quot;: {
335 &quot;inlineSbomInfo&quot;: {
336 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
337 # appropriate identifiers.
338 &quot;a_key&quot;: &quot;A String&quot;,
339 },
340 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
341 # identifiers.
342 &quot;a_key&quot;: &quot;A String&quot;,
343 },
344 },
345 },
346 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
347 # message that was returned, such as `NOT FOUND`.
348 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
349 # status code that was returned. For example, a `404` means the
350 # resource was not found.
351 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
352 # defined by the server.
353 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
354 # This value is inRFC3339
355 # text format.
356 &quot;instancesBulkInsertOperationMetadata&quot;: {
357 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
358 # Example key: zones/us-central1-a
359 &quot;a_key&quot;: {
360 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
361 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
362 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
363 # error.
364 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
365 # if the flow is rolling forward or rolling back.
366 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
367 },
368 },
369 },
370 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
371 # Operation resources.
372 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
373 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
374 # group of operations results from a `bulkInsert` API request.
375 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
376 # `update`, or `delete`, and so on.
377 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
378 # There is no requirement that this be linear or support any granularity of
379 # operations. This should not be used to guess when the operation will be
380 # complete. This number should monotonically increase as the operation
381 # progresses.
382 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
383 # applicable when performing regional operations.
384 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
385 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
386 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
387 # this field will contain information on all underlying zonal actions and
388 # their state.
389 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
390 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
391 # Example key: zones/us-central1-a
392 &quot;a_key&quot;: {
393 &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
394 # populated.
395 # different programming environments, including REST APIs and RPC APIs. It is
396 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
397 # three pieces of data: error code, error message, and error details.
398 #
399 # You can find out more about this error model and how to work with it in the
400 # [API Design Guide](https://cloud.google.com/apis/design/errors).
401 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
402 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
403 # message types for APIs to use.
404 {
405 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
406 },
407 ],
408 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
409 # user-facing error message should be localized and sent in the
410 # google.rpc.Status.details field, or localized by the client.
411 },
412 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
413 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
414 },
415 },
416 },
417 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
418 # This value is inRFC3339
419 # text format.
420 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
421 # following:
422 # `PENDING`, `RUNNING`, or `DONE`.
423 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
424 # operation.
425 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
426 # of the target resource.
427 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
428 # operations related to creating a snapshot, this points to the disk
429 # that the snapshot was created from.
430 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
431 # `[email protected]` or
432 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
433 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
434 # operation, this field will be populated.
435 {
436 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
437 # Engine returns NO_RESULTS_ON_PAGE if there
438 # are no results in the response.
439 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
440 # value format. For example:
441 #
442 # &quot;data&quot;: [
443 # {
444 # &quot;key&quot;: &quot;scope&quot;,
445 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
446 # }
447 {
448 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
449 # returned. For example, for warnings where there are no results in a list
450 # request for a particular zone, this key might be scope and
451 # the key value might be the zone name. Other examples might be a key
452 # indicating a deprecated resource and a suggested replacement, or a
453 # warning about invalid network settings (for example, if an instance
454 # attempts to perform IP forwarding but is not enabled for IP forwarding).
455 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
456 },
457 ],
458 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
459 },
460 ],
461 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
462 # applicable when performing per-zone operations.
463 }</pre>
464 </div>
465
466 <div class="method">
467 <code class="details" id="addPacketMirroringRule">addPacketMirroringRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)</code>
468 <pre>Inserts a packet mirroring rule into a firewall policy.
469
470 Args:
471 firewallPolicy: string, Name of the firewall policy to update. (required)
472 body: object, The request body.
473 The object takes the form of:
474
475 { # Represents a rule that describes one or more match conditions along with
476 # the action to be taken when traffic matches this condition (allow or deny).
477 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
478 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
479 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
480 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
481 # and &quot;goto_next&quot;.
482 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
483 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
484 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
485 # the firewall policy rule is not enforced and traffic behaves as if it did
486 # not exist. If this is unspecified, the firewall policy rule will be
487 # enabled.
488 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
489 # enabled, logs will be exported to the configured export destination in
490 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
491 # cannot enable logging on &quot;goto_next&quot; rules.
492 &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.
493 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
494 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
495 # Exactly one field must be specified.
496 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
497 # Maximum number of destination address groups is 10.
498 &quot;A String&quot;,
499 ],
500 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
501 # traffic destination.
502 # Maximum number of destination fqdn allowed is 100.
503 &quot;A String&quot;,
504 ],
505 &quot;destIpRanges&quot;: [ # CIDR IP address range.
506 # Maximum number of destination CIDR IP ranges allowed is 5000.
507 &quot;A String&quot;,
508 ],
509 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
510 #
511 #
512 # - UNSPECIFIED
513 # - INTERNET
514 # - NON_INTERNET
515 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
516 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
517 #
518 #
519 # - UNSPECIFIED
520 # - INTERNET
521 # - NON_INTERNET
522 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
523 # of traffic. Should be specified as 2 letter country code defined as per
524 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
525 # Maximum number of dest region codes allowed is 5000.
526 &quot;A String&quot;,
527 ],
528 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
529 # The IPs in these lists will be matched against traffic destination.
530 &quot;A String&quot;,
531 ],
532 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
533 {
534 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
535 # required when creating a firewall rule. This value can either be
536 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
537 # protocol number.
538 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
539 # only applicable for UDP or TCP protocol. Each entry must be either
540 # an integer or a range. If not specified, this rule applies to
541 # connections through any port.
542 #
543 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
544 &quot;A String&quot;,
545 ],
546 },
547 ],
548 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
549 # Maximum number of source address groups is 10.
550 &quot;A String&quot;,
551 ],
552 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
553 # traffic source.
554 # Maximum number of source fqdn allowed is 100.
555 &quot;A String&quot;,
556 ],
557 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
558 # Maximum number of source CIDR IP ranges allowed is 5000.
559 &quot;A String&quot;,
560 ],
561 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
562 #
563 #
564 # - UNSPECIFIED
565 # - INTERNET
566 # - INTRA_VPC
567 # - NON_INTERNET
568 # - VPC_NETWORKS
569 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
570 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
571 #
572 #
573 # - UNSPECIFIED
574 # - INTERNET
575 # - INTRA_VPC
576 # - NON_INTERNET
577 # - VPC_NETWORKS
578 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
579 &quot;A String&quot;,
580 ],
581 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
582 # of traffic. Should be specified as 2 letter country code defined as per
583 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
584 # Maximum number of source region codes allowed is 5000.
585 &quot;A String&quot;,
586 ],
587 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
588 # of the traffic.
589 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
590 # and there is no srcIpRange, this rule will be ignored.
591 # Maximum number of source tag values allowed is 256.
592 {
593 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
594 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
595 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
596 # or its network is deleted.
597 },
598 ],
599 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
600 # The IPs in these lists will be matched against traffic source.
601 &quot;A String&quot;,
602 ],
603 },
604 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
605 # must be a positive value between 0 and 2147483647.
606 # Rules are evaluated from highest to lowest priority where 0 is the
607 # highest priority and 2147483647 is the lowest priority.
608 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
609 # and can be updated.
610 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
611 # rule.
612 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
613 # Example:
614 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
615 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
616 # &#x27;mirror&#x27;. Cannot be specified for other actions.
617 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
618 # This field allows you to control which load balancers get this rule.
619 # For example, the following are valid values:
620 #
621 #
622 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
623 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
624 # - projects/project/global/
625 # forwardingRules/forwardingRule
626 # - projects/project/regions/region/forwardingRules/
627 # forwardingRule
628 &quot;A String&quot;,
629 ],
630 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
631 # allows you to control which network&#x27;s VMs get this rule. If this field
632 # is left blank, all VMs within the organization will receive the rule.
633 &quot;A String&quot;,
634 ],
635 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
636 # applies to. If targetSecureTag are specified, then the
637 # firewall rule applies only to instances in the VPC network that have one
638 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
639 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
640 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
641 # to all instances on the specified network.
642 # Maximum number of target label tags allowed is 256.
643 {
644 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
645 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
646 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
647 # or its network is deleted.
648 },
649 ],
650 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
651 # applied with this rule.
652 &quot;A String&quot;,
653 ],
654 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
655 # Default value is INSTANCES.
656 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
657 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
658 # be set for other actions.
659 }
660
661 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
662 that if you must retry your request, the server will know to ignore the
663 request if it has already been completed.
664
665 For example, consider a situation where you make an initial request and
666 the request times out. If you make the request again with the same
667 request ID, the server can check if original operation with the same
668 request ID was received, and if so, will ignore the second request. This
669 prevents clients from accidentally creating duplicate commitments.
670
671 The request ID must be
672 a valid UUID with the exception that zero UUID is not supported
673 (00000000-0000-0000-0000-000000000000).
674 x__xgafv: string, V1 error format.
675 Allowed values
676 1 - v1 error format
677 2 - v2 error format
678
679 Returns:
680 An object of the form:
681
682 { # Represents an Operation resource.
683 #
684 # Google Compute Engine has three Operation resources:
685 #
686 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
687 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
688 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
689 #
690 # You can use an operation resource to manage asynchronous API requests.
691 # For more information, readHandling
692 # API responses.
693 #
694 # Operations can be global, regional or zonal.
695 #
696 # - For global operations, use the `globalOperations`
697 # resource.
698 # - For regional operations, use the
699 # `regionOperations` resource.
700 # - For zonal operations, use
701 # the `zoneOperations` resource.
702 #
703 #
704 #
705 # For more information, read
706 # Global, Regional, and Zonal Resources.
707 #
708 # Note that completed Operation resources have a limited
709 # retention period.
710 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
711 # Not present otherwise.
712 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
713 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
714 # set when the operation is created.
715 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
716 # text format.
717 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
718 # this field will be populated.
719 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
720 # operation.
721 {
722 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
723 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
724 # details. There is a set of defined message types to use for providing
725 # details.The syntax depends on the error code. For example,
726 # QuotaExceededInfo will have details when the error code is
727 # QUOTA_EXCEEDED.
728 {
729 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
730 #
731 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
732 # is not enabled:
733 #
734 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
735 # &quot;domain&quot;: &quot;googleapis.com&quot;
736 # &quot;metadata&quot;: {
737 # &quot;resource&quot;: &quot;projects/123&quot;,
738 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
739 # }
740 # }
741 #
742 # This response indicates that the pubsub.googleapis.com API is not enabled.
743 #
744 # Example of an error that is returned when attempting to create a Spanner
745 # instance in a region that is out of stock:
746 #
747 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
748 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
749 # &quot;metadata&quot;: {
750 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
751 # }
752 # }
753 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
754 # is typically the registered service name of the tool or product that
755 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
756 # generated by some common infrastructure, the error domain must be a
757 # globally unique value that identifies the infrastructure. For Google API
758 # infrastructure, the error domain is &quot;googleapis.com&quot;.
759 &quot;metadatas&quot;: { # Additional structured details about this error.
760 #
761 # Keys must match a regular expression of `a-z+` but should
762 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
763 # length. When identifying the current value of an exceeded limit, the units
764 # should be contained in the key, not the value. For example, rather than
765 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
766 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
767 # instances that can be created in a single (batch) request.
768 &quot;a_key&quot;: &quot;A String&quot;,
769 },
770 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
771 # proximate cause of the error. Error reasons are unique within a particular
772 # domain of errors. This should be at most 63 characters and match a
773 # regular expression of `A-Z+[A-Z0-9]`, which represents
774 # UPPER_SNAKE_CASE.
775 },
776 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
777 #
778 # For example, if a quota check failed with an error indicating the calling
779 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
780 # directly to the right place in the developer console to flip the bit.
781 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
782 { # Describes a URL link.
783 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
784 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
785 },
786 ],
787 },
788 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
789 # which can be attached to an RPC error.
790 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
791 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
792 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
793 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
794 },
795 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
796 &quot;dimensions&quot;: { # The map holding related quota dimensions.
797 &quot;a_key&quot;: &quot;A String&quot;,
798 },
799 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
800 # type or metric.
801 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
802 # or metric.
803 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
804 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
805 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
806 },
807 },
808 ],
809 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
810 # This property is optional.
811 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
812 },
813 ],
814 },
815 &quot;getVersionOperationMetadata&quot;: {
816 &quot;inlineSbomInfo&quot;: {
817 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
818 # appropriate identifiers.
819 &quot;a_key&quot;: &quot;A String&quot;,
820 },
821 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
822 # identifiers.
823 &quot;a_key&quot;: &quot;A String&quot;,
824 },
825 },
826 },
827 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
828 # message that was returned, such as `NOT FOUND`.
829 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
830 # status code that was returned. For example, a `404` means the
831 # resource was not found.
832 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
833 # defined by the server.
834 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
835 # This value is inRFC3339
836 # text format.
837 &quot;instancesBulkInsertOperationMetadata&quot;: {
838 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
839 # Example key: zones/us-central1-a
840 &quot;a_key&quot;: {
841 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
842 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
843 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
844 # error.
845 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
846 # if the flow is rolling forward or rolling back.
847 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
848 },
849 },
850 },
851 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
852 # Operation resources.
853 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
854 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
855 # group of operations results from a `bulkInsert` API request.
856 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
857 # `update`, or `delete`, and so on.
858 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
859 # There is no requirement that this be linear or support any granularity of
860 # operations. This should not be used to guess when the operation will be
861 # complete. This number should monotonically increase as the operation
862 # progresses.
863 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
864 # applicable when performing regional operations.
865 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
866 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
867 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
868 # this field will contain information on all underlying zonal actions and
869 # their state.
870 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
871 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
872 # Example key: zones/us-central1-a
873 &quot;a_key&quot;: {
874 &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
875 # populated.
876 # different programming environments, including REST APIs and RPC APIs. It is
877 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
878 # three pieces of data: error code, error message, and error details.
879 #
880 # You can find out more about this error model and how to work with it in the
881 # [API Design Guide](https://cloud.google.com/apis/design/errors).
882 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
883 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
884 # message types for APIs to use.
885 {
886 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
887 },
888 ],
889 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
890 # user-facing error message should be localized and sent in the
891 # google.rpc.Status.details field, or localized by the client.
892 },
893 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
894 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
895 },
896 },
897 },
898 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
899 # This value is inRFC3339
900 # text format.
901 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
902 # following:
903 # `PENDING`, `RUNNING`, or `DONE`.
904 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
905 # operation.
906 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
907 # of the target resource.
908 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
909 # operations related to creating a snapshot, this points to the disk
910 # that the snapshot was created from.
911 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
912 # `[email protected]` or
913 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
914 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
915 # operation, this field will be populated.
916 {
917 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
918 # Engine returns NO_RESULTS_ON_PAGE if there
919 # are no results in the response.
920 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
921 # value format. For example:
922 #
923 # &quot;data&quot;: [
924 # {
925 # &quot;key&quot;: &quot;scope&quot;,
926 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
927 # }
928 {
929 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
930 # returned. For example, for warnings where there are no results in a list
931 # request for a particular zone, this key might be scope and
932 # the key value might be the zone name. Other examples might be a key
933 # indicating a deprecated resource and a suggested replacement, or a
934 # warning about invalid network settings (for example, if an instance
935 # attempts to perform IP forwarding but is not enabled for IP forwarding).
936 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
937 },
938 ],
939 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
940 },
941 ],
942 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
943 # applicable when performing per-zone operations.
944 }</pre>
945 </div>
946
947 <div class="method">
948 <code class="details" id="addRule">addRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)</code>
949 <pre>Inserts a rule into a firewall policy.
950
951 Args:
952 firewallPolicy: string, Name of the firewall policy to update. (required)
953 body: object, The request body.
954 The object takes the form of:
955
956 { # Represents a rule that describes one or more match conditions along with
957 # the action to be taken when traffic matches this condition (allow or deny).
958 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
959 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
960 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
961 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
962 # and &quot;goto_next&quot;.
963 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
964 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
965 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
966 # the firewall policy rule is not enforced and traffic behaves as if it did
967 # not exist. If this is unspecified, the firewall policy rule will be
968 # enabled.
969 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
970 # enabled, logs will be exported to the configured export destination in
971 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
972 # cannot enable logging on &quot;goto_next&quot; rules.
973 &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.
974 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
975 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
976 # Exactly one field must be specified.
977 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
978 # Maximum number of destination address groups is 10.
979 &quot;A String&quot;,
980 ],
981 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
982 # traffic destination.
983 # Maximum number of destination fqdn allowed is 100.
984 &quot;A String&quot;,
985 ],
986 &quot;destIpRanges&quot;: [ # CIDR IP address range.
987 # Maximum number of destination CIDR IP ranges allowed is 5000.
988 &quot;A String&quot;,
989 ],
990 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
991 #
992 #
993 # - UNSPECIFIED
994 # - INTERNET
995 # - NON_INTERNET
996 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
997 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
998 #
999 #
1000 # - UNSPECIFIED
1001 # - INTERNET
1002 # - NON_INTERNET
1003 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
1004 # of traffic. Should be specified as 2 letter country code defined as per
1005 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1006 # Maximum number of dest region codes allowed is 5000.
1007 &quot;A String&quot;,
1008 ],
1009 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1010 # The IPs in these lists will be matched against traffic destination.
1011 &quot;A String&quot;,
1012 ],
1013 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1014 {
1015 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1016 # required when creating a firewall rule. This value can either be
1017 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1018 # protocol number.
1019 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1020 # only applicable for UDP or TCP protocol. Each entry must be either
1021 # an integer or a range. If not specified, this rule applies to
1022 # connections through any port.
1023 #
1024 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1025 &quot;A String&quot;,
1026 ],
1027 },
1028 ],
1029 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1030 # Maximum number of source address groups is 10.
1031 &quot;A String&quot;,
1032 ],
1033 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1034 # traffic source.
1035 # Maximum number of source fqdn allowed is 100.
1036 &quot;A String&quot;,
1037 ],
1038 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1039 # Maximum number of source CIDR IP ranges allowed is 5000.
1040 &quot;A String&quot;,
1041 ],
1042 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1043 #
1044 #
1045 # - UNSPECIFIED
1046 # - INTERNET
1047 # - INTRA_VPC
1048 # - NON_INTERNET
1049 # - VPC_NETWORKS
1050 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1051 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1052 #
1053 #
1054 # - UNSPECIFIED
1055 # - INTERNET
1056 # - INTRA_VPC
1057 # - NON_INTERNET
1058 # - VPC_NETWORKS
1059 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1060 &quot;A String&quot;,
1061 ],
1062 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1063 # of traffic. Should be specified as 2 letter country code defined as per
1064 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1065 # Maximum number of source region codes allowed is 5000.
1066 &quot;A String&quot;,
1067 ],
1068 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1069 # of the traffic.
1070 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1071 # and there is no srcIpRange, this rule will be ignored.
1072 # Maximum number of source tag values allowed is 256.
1073 {
1074 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1075 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1076 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1077 # or its network is deleted.
1078 },
1079 ],
1080 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1081 # The IPs in these lists will be matched against traffic source.
1082 &quot;A String&quot;,
1083 ],
1084 },
1085 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1086 # must be a positive value between 0 and 2147483647.
1087 # Rules are evaluated from highest to lowest priority where 0 is the
1088 # highest priority and 2147483647 is the lowest priority.
1089 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1090 # and can be updated.
1091 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1092 # rule.
1093 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1094 # Example:
1095 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1096 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1097 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1098 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
1099 # This field allows you to control which load balancers get this rule.
1100 # For example, the following are valid values:
1101 #
1102 #
1103 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
1104 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1105 # - projects/project/global/
1106 # forwardingRules/forwardingRule
1107 # - projects/project/regions/region/forwardingRules/
1108 # forwardingRule
1109 &quot;A String&quot;,
1110 ],
1111 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
1112 # allows you to control which network&#x27;s VMs get this rule. If this field
1113 # is left blank, all VMs within the organization will receive the rule.
1114 &quot;A String&quot;,
1115 ],
1116 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
1117 # applies to. If targetSecureTag are specified, then the
1118 # firewall rule applies only to instances in the VPC network that have one
1119 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
1120 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
1121 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
1122 # to all instances on the specified network.
1123 # Maximum number of target label tags allowed is 256.
1124 {
1125 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1126 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1127 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1128 # or its network is deleted.
1129 },
1130 ],
1131 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
1132 # applied with this rule.
1133 &quot;A String&quot;,
1134 ],
1135 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
1136 # Default value is INSTANCES.
1137 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
1138 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
1139 # be set for other actions.
1140 }
1141
1142 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1143 that if you must retry your request, the server will know to ignore the
1144 request if it has already been completed.
1145
1146 For example, consider a situation where you make an initial request and
1147 the request times out. If you make the request again with the same
1148 request ID, the server can check if original operation with the same
1149 request ID was received, and if so, will ignore the second request. This
1150 prevents clients from accidentally creating duplicate commitments.
1151
1152 The request ID must be
1153 a valid UUID with the exception that zero UUID is not supported
1154 (00000000-0000-0000-0000-000000000000).
1155 x__xgafv: string, V1 error format.
1156 Allowed values
1157 1 - v1 error format
1158 2 - v2 error format
1159
1160 Returns:
1161 An object of the form:
1162
1163 { # Represents an Operation resource.
1164 #
1165 # Google Compute Engine has three Operation resources:
1166 #
1167 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1168 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1169 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1170 #
1171 # You can use an operation resource to manage asynchronous API requests.
1172 # For more information, readHandling
1173 # API responses.
1174 #
1175 # Operations can be global, regional or zonal.
1176 #
1177 # - For global operations, use the `globalOperations`
1178 # resource.
1179 # - For regional operations, use the
1180 # `regionOperations` resource.
1181 # - For zonal operations, use
1182 # the `zoneOperations` resource.
1183 #
1184 #
1185 #
1186 # For more information, read
1187 # Global, Regional, and Zonal Resources.
1188 #
1189 # Note that completed Operation resources have a limited
1190 # retention period.
1191 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1192 # Not present otherwise.
1193 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1194 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1195 # set when the operation is created.
1196 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1197 # text format.
1198 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1199 # this field will be populated.
1200 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1201 # operation.
1202 {
1203 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1204 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1205 # details. There is a set of defined message types to use for providing
1206 # details.The syntax depends on the error code. For example,
1207 # QuotaExceededInfo will have details when the error code is
1208 # QUOTA_EXCEEDED.
1209 {
1210 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1211 #
1212 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1213 # is not enabled:
1214 #
1215 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1216 # &quot;domain&quot;: &quot;googleapis.com&quot;
1217 # &quot;metadata&quot;: {
1218 # &quot;resource&quot;: &quot;projects/123&quot;,
1219 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1220 # }
1221 # }
1222 #
1223 # This response indicates that the pubsub.googleapis.com API is not enabled.
1224 #
1225 # Example of an error that is returned when attempting to create a Spanner
1226 # instance in a region that is out of stock:
1227 #
1228 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1229 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1230 # &quot;metadata&quot;: {
1231 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1232 # }
1233 # }
1234 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1235 # is typically the registered service name of the tool or product that
1236 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1237 # generated by some common infrastructure, the error domain must be a
1238 # globally unique value that identifies the infrastructure. For Google API
1239 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1240 &quot;metadatas&quot;: { # Additional structured details about this error.
1241 #
1242 # Keys must match a regular expression of `a-z+` but should
1243 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1244 # length. When identifying the current value of an exceeded limit, the units
1245 # should be contained in the key, not the value. For example, rather than
1246 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1247 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1248 # instances that can be created in a single (batch) request.
1249 &quot;a_key&quot;: &quot;A String&quot;,
1250 },
1251 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1252 # proximate cause of the error. Error reasons are unique within a particular
1253 # domain of errors. This should be at most 63 characters and match a
1254 # regular expression of `A-Z+[A-Z0-9]`, which represents
1255 # UPPER_SNAKE_CASE.
1256 },
1257 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1258 #
1259 # For example, if a quota check failed with an error indicating the calling
1260 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1261 # directly to the right place in the developer console to flip the bit.
1262 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1263 { # Describes a URL link.
1264 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1265 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1266 },
1267 ],
1268 },
1269 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1270 # which can be attached to an RPC error.
1271 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1272 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1273 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1274 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1275 },
1276 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1277 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1278 &quot;a_key&quot;: &quot;A String&quot;,
1279 },
1280 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1281 # type or metric.
1282 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1283 # or metric.
1284 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1285 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1286 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1287 },
1288 },
1289 ],
1290 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1291 # This property is optional.
1292 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1293 },
1294 ],
1295 },
1296 &quot;getVersionOperationMetadata&quot;: {
1297 &quot;inlineSbomInfo&quot;: {
1298 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1299 # appropriate identifiers.
1300 &quot;a_key&quot;: &quot;A String&quot;,
1301 },
1302 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1303 # identifiers.
1304 &quot;a_key&quot;: &quot;A String&quot;,
1305 },
1306 },
1307 },
1308 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1309 # message that was returned, such as `NOT FOUND`.
1310 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1311 # status code that was returned. For example, a `404` means the
1312 # resource was not found.
1313 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1314 # defined by the server.
1315 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1316 # This value is inRFC3339
1317 # text format.
1318 &quot;instancesBulkInsertOperationMetadata&quot;: {
1319 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1320 # Example key: zones/us-central1-a
1321 &quot;a_key&quot;: {
1322 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1323 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1324 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1325 # error.
1326 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1327 # if the flow is rolling forward or rolling back.
1328 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1329 },
1330 },
1331 },
1332 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1333 # Operation resources.
1334 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1335 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1336 # group of operations results from a `bulkInsert` API request.
1337 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1338 # `update`, or `delete`, and so on.
1339 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1340 # There is no requirement that this be linear or support any granularity of
1341 # operations. This should not be used to guess when the operation will be
1342 # complete. This number should monotonically increase as the operation
1343 # progresses.
1344 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1345 # applicable when performing regional operations.
1346 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1347 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1348 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1349 # this field will contain information on all underlying zonal actions and
1350 # their state.
1351 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1352 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1353 # Example key: zones/us-central1-a
1354 &quot;a_key&quot;: {
1355 &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
1356 # populated.
1357 # different programming environments, including REST APIs and RPC APIs. It is
1358 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1359 # three pieces of data: error code, error message, and error details.
1360 #
1361 # You can find out more about this error model and how to work with it in the
1362 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1363 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1364 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1365 # message types for APIs to use.
1366 {
1367 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1368 },
1369 ],
1370 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1371 # user-facing error message should be localized and sent in the
1372 # google.rpc.Status.details field, or localized by the client.
1373 },
1374 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1375 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1376 },
1377 },
1378 },
1379 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1380 # This value is inRFC3339
1381 # text format.
1382 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1383 # following:
1384 # `PENDING`, `RUNNING`, or `DONE`.
1385 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1386 # operation.
1387 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1388 # of the target resource.
1389 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1390 # operations related to creating a snapshot, this points to the disk
1391 # that the snapshot was created from.
1392 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1393 # `[email protected]` or
1394 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1395 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1396 # operation, this field will be populated.
1397 {
1398 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1399 # Engine returns NO_RESULTS_ON_PAGE if there
1400 # are no results in the response.
1401 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1402 # value format. For example:
1403 #
1404 # &quot;data&quot;: [
1405 # {
1406 # &quot;key&quot;: &quot;scope&quot;,
1407 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1408 # }
1409 {
1410 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1411 # returned. For example, for warnings where there are no results in a list
1412 # request for a particular zone, this key might be scope and
1413 # the key value might be the zone name. Other examples might be a key
1414 # indicating a deprecated resource and a suggested replacement, or a
1415 # warning about invalid network settings (for example, if an instance
1416 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1417 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1418 },
1419 ],
1420 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1421 },
1422 ],
1423 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1424 # applicable when performing per-zone operations.
1425 }</pre>
1426 </div>
1427
1428 <div class="method">
1429 <code class="details" id="cloneRules">cloneRules(firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</code>
1430 <pre>Copies rules to the specified firewall policy.
1431
1432 Args:
1433 firewallPolicy: string, Name of the firewall policy to update. (required)
1434 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1435 that if you must retry your request, the server will know to ignore the
1436 request if it has already been completed.
1437
1438 For example, consider a situation where you make an initial request and
1439 the request times out. If you make the request again with the same
1440 request ID, the server can check if original operation with the same
1441 request ID was received, and if so, will ignore the second request. This
1442 prevents clients from accidentally creating duplicate commitments.
1443
1444 The request ID must be
1445 a valid UUID with the exception that zero UUID is not supported
1446 (00000000-0000-0000-0000-000000000000).
1447 sourceFirewallPolicy: string, The firewall policy from which to copy rules.
1448 x__xgafv: string, V1 error format.
1449 Allowed values
1450 1 - v1 error format
1451 2 - v2 error format
1452
1453 Returns:
1454 An object of the form:
1455
1456 { # Represents an Operation resource.
1457 #
1458 # Google Compute Engine has three Operation resources:
1459 #
1460 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1461 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1462 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1463 #
1464 # You can use an operation resource to manage asynchronous API requests.
1465 # For more information, readHandling
1466 # API responses.
1467 #
1468 # Operations can be global, regional or zonal.
1469 #
1470 # - For global operations, use the `globalOperations`
1471 # resource.
1472 # - For regional operations, use the
1473 # `regionOperations` resource.
1474 # - For zonal operations, use
1475 # the `zoneOperations` resource.
1476 #
1477 #
1478 #
1479 # For more information, read
1480 # Global, Regional, and Zonal Resources.
1481 #
1482 # Note that completed Operation resources have a limited
1483 # retention period.
1484 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1485 # Not present otherwise.
1486 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1487 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1488 # set when the operation is created.
1489 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1490 # text format.
1491 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1492 # this field will be populated.
1493 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1494 # operation.
1495 {
1496 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1497 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1498 # details. There is a set of defined message types to use for providing
1499 # details.The syntax depends on the error code. For example,
1500 # QuotaExceededInfo will have details when the error code is
1501 # QUOTA_EXCEEDED.
1502 {
1503 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1504 #
1505 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1506 # is not enabled:
1507 #
1508 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1509 # &quot;domain&quot;: &quot;googleapis.com&quot;
1510 # &quot;metadata&quot;: {
1511 # &quot;resource&quot;: &quot;projects/123&quot;,
1512 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1513 # }
1514 # }
1515 #
1516 # This response indicates that the pubsub.googleapis.com API is not enabled.
1517 #
1518 # Example of an error that is returned when attempting to create a Spanner
1519 # instance in a region that is out of stock:
1520 #
1521 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1522 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1523 # &quot;metadata&quot;: {
1524 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1525 # }
1526 # }
1527 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1528 # is typically the registered service name of the tool or product that
1529 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1530 # generated by some common infrastructure, the error domain must be a
1531 # globally unique value that identifies the infrastructure. For Google API
1532 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1533 &quot;metadatas&quot;: { # Additional structured details about this error.
1534 #
1535 # Keys must match a regular expression of `a-z+` but should
1536 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1537 # length. When identifying the current value of an exceeded limit, the units
1538 # should be contained in the key, not the value. For example, rather than
1539 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1540 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1541 # instances that can be created in a single (batch) request.
1542 &quot;a_key&quot;: &quot;A String&quot;,
1543 },
1544 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1545 # proximate cause of the error. Error reasons are unique within a particular
1546 # domain of errors. This should be at most 63 characters and match a
1547 # regular expression of `A-Z+[A-Z0-9]`, which represents
1548 # UPPER_SNAKE_CASE.
1549 },
1550 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1551 #
1552 # For example, if a quota check failed with an error indicating the calling
1553 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1554 # directly to the right place in the developer console to flip the bit.
1555 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1556 { # Describes a URL link.
1557 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1558 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1559 },
1560 ],
1561 },
1562 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1563 # which can be attached to an RPC error.
1564 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1565 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1566 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1567 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1568 },
1569 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1570 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1571 &quot;a_key&quot;: &quot;A String&quot;,
1572 },
1573 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1574 # type or metric.
1575 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1576 # or metric.
1577 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1578 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1579 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1580 },
1581 },
1582 ],
1583 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1584 # This property is optional.
1585 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1586 },
1587 ],
1588 },
1589 &quot;getVersionOperationMetadata&quot;: {
1590 &quot;inlineSbomInfo&quot;: {
1591 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1592 # appropriate identifiers.
1593 &quot;a_key&quot;: &quot;A String&quot;,
1594 },
1595 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1596 # identifiers.
1597 &quot;a_key&quot;: &quot;A String&quot;,
1598 },
1599 },
1600 },
1601 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1602 # message that was returned, such as `NOT FOUND`.
1603 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1604 # status code that was returned. For example, a `404` means the
1605 # resource was not found.
1606 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1607 # defined by the server.
1608 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1609 # This value is inRFC3339
1610 # text format.
1611 &quot;instancesBulkInsertOperationMetadata&quot;: {
1612 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1613 # Example key: zones/us-central1-a
1614 &quot;a_key&quot;: {
1615 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1616 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1617 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1618 # error.
1619 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1620 # if the flow is rolling forward or rolling back.
1621 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1622 },
1623 },
1624 },
1625 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1626 # Operation resources.
1627 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1628 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1629 # group of operations results from a `bulkInsert` API request.
1630 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1631 # `update`, or `delete`, and so on.
1632 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1633 # There is no requirement that this be linear or support any granularity of
1634 # operations. This should not be used to guess when the operation will be
1635 # complete. This number should monotonically increase as the operation
1636 # progresses.
1637 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1638 # applicable when performing regional operations.
1639 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1640 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1641 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1642 # this field will contain information on all underlying zonal actions and
1643 # their state.
1644 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1645 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1646 # Example key: zones/us-central1-a
1647 &quot;a_key&quot;: {
1648 &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
1649 # populated.
1650 # different programming environments, including REST APIs and RPC APIs. It is
1651 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1652 # three pieces of data: error code, error message, and error details.
1653 #
1654 # You can find out more about this error model and how to work with it in the
1655 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1656 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1657 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1658 # message types for APIs to use.
1659 {
1660 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1661 },
1662 ],
1663 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1664 # user-facing error message should be localized and sent in the
1665 # google.rpc.Status.details field, or localized by the client.
1666 },
1667 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1668 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1669 },
1670 },
1671 },
1672 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1673 # This value is inRFC3339
1674 # text format.
1675 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1676 # following:
1677 # `PENDING`, `RUNNING`, or `DONE`.
1678 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1679 # operation.
1680 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1681 # of the target resource.
1682 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1683 # operations related to creating a snapshot, this points to the disk
1684 # that the snapshot was created from.
1685 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1686 # `[email protected]` or
1687 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1688 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1689 # operation, this field will be populated.
1690 {
1691 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1692 # Engine returns NO_RESULTS_ON_PAGE if there
1693 # are no results in the response.
1694 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1695 # value format. For example:
1696 #
1697 # &quot;data&quot;: [
1698 # {
1699 # &quot;key&quot;: &quot;scope&quot;,
1700 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1701 # }
1702 {
1703 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1704 # returned. For example, for warnings where there are no results in a list
1705 # request for a particular zone, this key might be scope and
1706 # the key value might be the zone name. Other examples might be a key
1707 # indicating a deprecated resource and a suggested replacement, or a
1708 # warning about invalid network settings (for example, if an instance
1709 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1710 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1711 },
1712 ],
1713 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1714 },
1715 ],
1716 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1717 # applicable when performing per-zone operations.
1718 }</pre>
1719 </div>
1720
1721 <div class="method">
1722 <code class="details" id="close">close()</code>
1723 <pre>Close httplib2 connections.</pre>
1724 </div>
1725
1726 <div class="method">
1727 <code class="details" id="delete">delete(firewallPolicy, requestId=None, x__xgafv=None)</code>
1728 <pre>Deletes the specified policy.
1729
1730 Args:
1731 firewallPolicy: string, Name of the firewall policy to delete. (required)
1732 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1733 that if you must retry your request, the server will know to ignore the
1734 request if it has already been completed.
1735
1736 For example, consider a situation where you make an initial request and
1737 the request times out. If you make the request again with the same
1738 request ID, the server can check if original operation with the same
1739 request ID was received, and if so, will ignore the second request. This
1740 prevents clients from accidentally creating duplicate commitments.
1741
1742 The request ID must be
1743 a valid UUID with the exception that zero UUID is not supported
1744 (00000000-0000-0000-0000-000000000000).
1745 x__xgafv: string, V1 error format.
1746 Allowed values
1747 1 - v1 error format
1748 2 - v2 error format
1749
1750 Returns:
1751 An object of the form:
1752
1753 { # Represents an Operation resource.
1754 #
1755 # Google Compute Engine has three Operation resources:
1756 #
1757 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1758 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1759 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1760 #
1761 # You can use an operation resource to manage asynchronous API requests.
1762 # For more information, readHandling
1763 # API responses.
1764 #
1765 # Operations can be global, regional or zonal.
1766 #
1767 # - For global operations, use the `globalOperations`
1768 # resource.
1769 # - For regional operations, use the
1770 # `regionOperations` resource.
1771 # - For zonal operations, use
1772 # the `zoneOperations` resource.
1773 #
1774 #
1775 #
1776 # For more information, read
1777 # Global, Regional, and Zonal Resources.
1778 #
1779 # Note that completed Operation resources have a limited
1780 # retention period.
1781 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1782 # Not present otherwise.
1783 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1784 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1785 # set when the operation is created.
1786 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1787 # text format.
1788 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1789 # this field will be populated.
1790 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1791 # operation.
1792 {
1793 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1794 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1795 # details. There is a set of defined message types to use for providing
1796 # details.The syntax depends on the error code. For example,
1797 # QuotaExceededInfo will have details when the error code is
1798 # QUOTA_EXCEEDED.
1799 {
1800 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1801 #
1802 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1803 # is not enabled:
1804 #
1805 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1806 # &quot;domain&quot;: &quot;googleapis.com&quot;
1807 # &quot;metadata&quot;: {
1808 # &quot;resource&quot;: &quot;projects/123&quot;,
1809 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1810 # }
1811 # }
1812 #
1813 # This response indicates that the pubsub.googleapis.com API is not enabled.
1814 #
1815 # Example of an error that is returned when attempting to create a Spanner
1816 # instance in a region that is out of stock:
1817 #
1818 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1819 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1820 # &quot;metadata&quot;: {
1821 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1822 # }
1823 # }
1824 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1825 # is typically the registered service name of the tool or product that
1826 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1827 # generated by some common infrastructure, the error domain must be a
1828 # globally unique value that identifies the infrastructure. For Google API
1829 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1830 &quot;metadatas&quot;: { # Additional structured details about this error.
1831 #
1832 # Keys must match a regular expression of `a-z+` but should
1833 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1834 # length. When identifying the current value of an exceeded limit, the units
1835 # should be contained in the key, not the value. For example, rather than
1836 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1837 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1838 # instances that can be created in a single (batch) request.
1839 &quot;a_key&quot;: &quot;A String&quot;,
1840 },
1841 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1842 # proximate cause of the error. Error reasons are unique within a particular
1843 # domain of errors. This should be at most 63 characters and match a
1844 # regular expression of `A-Z+[A-Z0-9]`, which represents
1845 # UPPER_SNAKE_CASE.
1846 },
1847 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1848 #
1849 # For example, if a quota check failed with an error indicating the calling
1850 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1851 # directly to the right place in the developer console to flip the bit.
1852 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1853 { # Describes a URL link.
1854 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1855 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1856 },
1857 ],
1858 },
1859 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1860 # which can be attached to an RPC error.
1861 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1862 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1863 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1864 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1865 },
1866 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1867 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1868 &quot;a_key&quot;: &quot;A String&quot;,
1869 },
1870 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1871 # type or metric.
1872 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1873 # or metric.
1874 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1875 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1876 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1877 },
1878 },
1879 ],
1880 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1881 # This property is optional.
1882 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1883 },
1884 ],
1885 },
1886 &quot;getVersionOperationMetadata&quot;: {
1887 &quot;inlineSbomInfo&quot;: {
1888 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1889 # appropriate identifiers.
1890 &quot;a_key&quot;: &quot;A String&quot;,
1891 },
1892 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1893 # identifiers.
1894 &quot;a_key&quot;: &quot;A String&quot;,
1895 },
1896 },
1897 },
1898 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1899 # message that was returned, such as `NOT FOUND`.
1900 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1901 # status code that was returned. For example, a `404` means the
1902 # resource was not found.
1903 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1904 # defined by the server.
1905 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1906 # This value is inRFC3339
1907 # text format.
1908 &quot;instancesBulkInsertOperationMetadata&quot;: {
1909 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1910 # Example key: zones/us-central1-a
1911 &quot;a_key&quot;: {
1912 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1913 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1914 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1915 # error.
1916 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1917 # if the flow is rolling forward or rolling back.
1918 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1919 },
1920 },
1921 },
1922 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1923 # Operation resources.
1924 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1925 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1926 # group of operations results from a `bulkInsert` API request.
1927 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1928 # `update`, or `delete`, and so on.
1929 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1930 # There is no requirement that this be linear or support any granularity of
1931 # operations. This should not be used to guess when the operation will be
1932 # complete. This number should monotonically increase as the operation
1933 # progresses.
1934 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1935 # applicable when performing regional operations.
1936 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1937 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1938 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1939 # this field will contain information on all underlying zonal actions and
1940 # their state.
1941 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1942 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1943 # Example key: zones/us-central1-a
1944 &quot;a_key&quot;: {
1945 &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
1946 # populated.
1947 # different programming environments, including REST APIs and RPC APIs. It is
1948 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1949 # three pieces of data: error code, error message, and error details.
1950 #
1951 # You can find out more about this error model and how to work with it in the
1952 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1953 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1954 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1955 # message types for APIs to use.
1956 {
1957 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1958 },
1959 ],
1960 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1961 # user-facing error message should be localized and sent in the
1962 # google.rpc.Status.details field, or localized by the client.
1963 },
1964 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1965 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1966 },
1967 },
1968 },
1969 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1970 # This value is inRFC3339
1971 # text format.
1972 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1973 # following:
1974 # `PENDING`, `RUNNING`, or `DONE`.
1975 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1976 # operation.
1977 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1978 # of the target resource.
1979 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1980 # operations related to creating a snapshot, this points to the disk
1981 # that the snapshot was created from.
1982 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1983 # `[email protected]` or
1984 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1985 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1986 # operation, this field will be populated.
1987 {
1988 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1989 # Engine returns NO_RESULTS_ON_PAGE if there
1990 # are no results in the response.
1991 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1992 # value format. For example:
1993 #
1994 # &quot;data&quot;: [
1995 # {
1996 # &quot;key&quot;: &quot;scope&quot;,
1997 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1998 # }
1999 {
2000 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2001 # returned. For example, for warnings where there are no results in a list
2002 # request for a particular zone, this key might be scope and
2003 # the key value might be the zone name. Other examples might be a key
2004 # indicating a deprecated resource and a suggested replacement, or a
2005 # warning about invalid network settings (for example, if an instance
2006 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2007 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2008 },
2009 ],
2010 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2011 },
2012 ],
2013 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2014 # applicable when performing per-zone operations.
2015 }</pre>
2016 </div>
2017
2018 <div class="method">
2019 <code class="details" id="forceStartProgressiveRollout">forceStartProgressiveRollout(firewallPolicy, x__xgafv=None)</code>
2020 <pre>Starts a brand new progressive rollout of hierarchical firewall policy.
2021 This API will return an error when there is an ongoing progressive rollout.
2022
2023 Args:
2024 firewallPolicy: string, Name of the target firewall policy. (required)
2025 x__xgafv: string, V1 error format.
2026 Allowed values
2027 1 - v1 error format
2028 2 - v2 error format
2029
2030 Returns:
2031 An object of the form:
2032
2033 { # Represents an Operation resource.
2034 #
2035 # Google Compute Engine has three Operation resources:
2036 #
2037 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2038 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2039 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2040 #
2041 # You can use an operation resource to manage asynchronous API requests.
2042 # For more information, readHandling
2043 # API responses.
2044 #
2045 # Operations can be global, regional or zonal.
2046 #
2047 # - For global operations, use the `globalOperations`
2048 # resource.
2049 # - For regional operations, use the
2050 # `regionOperations` resource.
2051 # - For zonal operations, use
2052 # the `zoneOperations` resource.
2053 #
2054 #
2055 #
2056 # For more information, read
2057 # Global, Regional, and Zonal Resources.
2058 #
2059 # Note that completed Operation resources have a limited
2060 # retention period.
2061 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2062 # Not present otherwise.
2063 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2064 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2065 # set when the operation is created.
2066 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2067 # text format.
2068 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2069 # this field will be populated.
2070 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2071 # operation.
2072 {
2073 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2074 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2075 # details. There is a set of defined message types to use for providing
2076 # details.The syntax depends on the error code. For example,
2077 # QuotaExceededInfo will have details when the error code is
2078 # QUOTA_EXCEEDED.
2079 {
2080 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2081 #
2082 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2083 # is not enabled:
2084 #
2085 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2086 # &quot;domain&quot;: &quot;googleapis.com&quot;
2087 # &quot;metadata&quot;: {
2088 # &quot;resource&quot;: &quot;projects/123&quot;,
2089 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2090 # }
2091 # }
2092 #
2093 # This response indicates that the pubsub.googleapis.com API is not enabled.
2094 #
2095 # Example of an error that is returned when attempting to create a Spanner
2096 # instance in a region that is out of stock:
2097 #
2098 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2099 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2100 # &quot;metadata&quot;: {
2101 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2102 # }
2103 # }
2104 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2105 # is typically the registered service name of the tool or product that
2106 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2107 # generated by some common infrastructure, the error domain must be a
2108 # globally unique value that identifies the infrastructure. For Google API
2109 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2110 &quot;metadatas&quot;: { # Additional structured details about this error.
2111 #
2112 # Keys must match a regular expression of `a-z+` but should
2113 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2114 # length. When identifying the current value of an exceeded limit, the units
2115 # should be contained in the key, not the value. For example, rather than
2116 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2117 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2118 # instances that can be created in a single (batch) request.
2119 &quot;a_key&quot;: &quot;A String&quot;,
2120 },
2121 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2122 # proximate cause of the error. Error reasons are unique within a particular
2123 # domain of errors. This should be at most 63 characters and match a
2124 # regular expression of `A-Z+[A-Z0-9]`, which represents
2125 # UPPER_SNAKE_CASE.
2126 },
2127 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2128 #
2129 # For example, if a quota check failed with an error indicating the calling
2130 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2131 # directly to the right place in the developer console to flip the bit.
2132 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2133 { # Describes a URL link.
2134 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2135 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2136 },
2137 ],
2138 },
2139 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2140 # which can be attached to an RPC error.
2141 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2142 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2143 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2144 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2145 },
2146 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2147 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2148 &quot;a_key&quot;: &quot;A String&quot;,
2149 },
2150 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2151 # type or metric.
2152 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2153 # or metric.
2154 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2155 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2156 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2157 },
2158 },
2159 ],
2160 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2161 # This property is optional.
2162 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2163 },
2164 ],
2165 },
2166 &quot;getVersionOperationMetadata&quot;: {
2167 &quot;inlineSbomInfo&quot;: {
2168 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2169 # appropriate identifiers.
2170 &quot;a_key&quot;: &quot;A String&quot;,
2171 },
2172 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2173 # identifiers.
2174 &quot;a_key&quot;: &quot;A String&quot;,
2175 },
2176 },
2177 },
2178 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2179 # message that was returned, such as `NOT FOUND`.
2180 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2181 # status code that was returned. For example, a `404` means the
2182 # resource was not found.
2183 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2184 # defined by the server.
2185 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2186 # This value is inRFC3339
2187 # text format.
2188 &quot;instancesBulkInsertOperationMetadata&quot;: {
2189 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2190 # Example key: zones/us-central1-a
2191 &quot;a_key&quot;: {
2192 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2193 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2194 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2195 # error.
2196 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2197 # if the flow is rolling forward or rolling back.
2198 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2199 },
2200 },
2201 },
2202 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2203 # Operation resources.
2204 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2205 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2206 # group of operations results from a `bulkInsert` API request.
2207 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2208 # `update`, or `delete`, and so on.
2209 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2210 # There is no requirement that this be linear or support any granularity of
2211 # operations. This should not be used to guess when the operation will be
2212 # complete. This number should monotonically increase as the operation
2213 # progresses.
2214 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2215 # applicable when performing regional operations.
2216 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2217 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2218 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2219 # this field will contain information on all underlying zonal actions and
2220 # their state.
2221 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2222 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2223 # Example key: zones/us-central1-a
2224 &quot;a_key&quot;: {
2225 &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
2226 # populated.
2227 # different programming environments, including REST APIs and RPC APIs. It is
2228 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2229 # three pieces of data: error code, error message, and error details.
2230 #
2231 # You can find out more about this error model and how to work with it in the
2232 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2233 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2234 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2235 # message types for APIs to use.
2236 {
2237 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2238 },
2239 ],
2240 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2241 # user-facing error message should be localized and sent in the
2242 # google.rpc.Status.details field, or localized by the client.
2243 },
2244 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2245 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2246 },
2247 },
2248 },
2249 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2250 # This value is inRFC3339
2251 # text format.
2252 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2253 # following:
2254 # `PENDING`, `RUNNING`, or `DONE`.
2255 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2256 # operation.
2257 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2258 # of the target resource.
2259 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2260 # operations related to creating a snapshot, this points to the disk
2261 # that the snapshot was created from.
2262 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2263 # `[email protected]` or
2264 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2265 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2266 # operation, this field will be populated.
2267 {
2268 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2269 # Engine returns NO_RESULTS_ON_PAGE if there
2270 # are no results in the response.
2271 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2272 # value format. For example:
2273 #
2274 # &quot;data&quot;: [
2275 # {
2276 # &quot;key&quot;: &quot;scope&quot;,
2277 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2278 # }
2279 {
2280 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2281 # returned. For example, for warnings where there are no results in a list
2282 # request for a particular zone, this key might be scope and
2283 # the key value might be the zone name. Other examples might be a key
2284 # indicating a deprecated resource and a suggested replacement, or a
2285 # warning about invalid network settings (for example, if an instance
2286 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2287 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2288 },
2289 ],
2290 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2291 },
2292 ],
2293 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2294 # applicable when performing per-zone operations.
2295 }</pre>
2296 </div>
2297
2298 <div class="method">
2299 <code class="details" id="get">get(firewallPolicy, x__xgafv=None)</code>
2300 <pre>Returns the specified firewall policy.
2301
2302 Args:
2303 firewallPolicy: string, Name of the firewall policy to get. (required)
2304 x__xgafv: string, V1 error format.
2305 Allowed values
2306 1 - v1 error format
2307 2 - v2 error format
2308
2309 Returns:
2310 An object of the form:
2311
2312 { # Represents a Firewall Policy resource.
2313 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
2314 {
2315 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
2316 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
2317 # of the firewall policy of the association.
2318 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
2319 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
2320 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
2321 # must be a positive value between 1 and 2147483647.
2322 # Firewall Policies are evaluated from highest to lowest priority where 1
2323 # is the highest priority and 2147483647 is the lowest priority.
2324 # The default value is `1000`. If two associations have the same priority
2325 # then lexicographical order on association names is applied.
2326 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
2327 },
2328 ],
2329 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2330 # text format.
2331 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2332 # create the resource.
2333 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
2334 # Organization firewall policy. The name should be unique in the organization
2335 # in which the firewall policy is created.
2336 # This field is not applicable to network firewall policies.
2337 # This name must be set on creation and cannot be changed.
2338 # The name must be 1-63 characters long, and comply
2339 # with RFC1035. Specifically, the name must be 1-63 characters
2340 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
2341 # means the first character must be a lowercase letter, and all following
2342 # characters must be a dash, lowercase letter, or digit, except the last
2343 # character, which cannot be a dash.
2344 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
2345 # the metadata&#x27;s contents and used for optimistic locking. The
2346 # fingerprint is initially generated by Compute Engine and changes after
2347 # every request to modify or update metadata. You must always provide an
2348 # up-to-date fingerprint hash in order to update or change metadata,
2349 # otherwise the request will fail with error412 conditionNotMet.
2350 #
2351 # To see the latest fingerprint, make get() request to the
2352 # firewall policy.
2353 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2354 # defined by the server.
2355 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
2356 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
2357 # [Output Only] numeric ID allocated by Google Cloud which uniquely
2358 # identifies the Organization Firewall Policy.
2359 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
2360 { # Represents a rule that describes one or more match conditions along with
2361 # the action to be taken when traffic matches this condition (allow or deny).
2362 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
2363 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
2364 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
2365 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
2366 # and &quot;goto_next&quot;.
2367 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
2368 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
2369 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
2370 # the firewall policy rule is not enforced and traffic behaves as if it did
2371 # not exist. If this is unspecified, the firewall policy rule will be
2372 # enabled.
2373 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
2374 # enabled, logs will be exported to the configured export destination in
2375 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
2376 # cannot enable logging on &quot;goto_next&quot; rules.
2377 &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.
2378 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
2379 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
2380 # Exactly one field must be specified.
2381 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
2382 # Maximum number of destination address groups is 10.
2383 &quot;A String&quot;,
2384 ],
2385 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2386 # traffic destination.
2387 # Maximum number of destination fqdn allowed is 100.
2388 &quot;A String&quot;,
2389 ],
2390 &quot;destIpRanges&quot;: [ # CIDR IP address range.
2391 # Maximum number of destination CIDR IP ranges allowed is 5000.
2392 &quot;A String&quot;,
2393 ],
2394 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
2395 #
2396 #
2397 # - UNSPECIFIED
2398 # - INTERNET
2399 # - NON_INTERNET
2400 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
2401 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
2402 #
2403 #
2404 # - UNSPECIFIED
2405 # - INTERNET
2406 # - NON_INTERNET
2407 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
2408 # of traffic. Should be specified as 2 letter country code defined as per
2409 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2410 # Maximum number of dest region codes allowed is 5000.
2411 &quot;A String&quot;,
2412 ],
2413 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2414 # The IPs in these lists will be matched against traffic destination.
2415 &quot;A String&quot;,
2416 ],
2417 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
2418 {
2419 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
2420 # required when creating a firewall rule. This value can either be
2421 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
2422 # protocol number.
2423 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
2424 # only applicable for UDP or TCP protocol. Each entry must be either
2425 # an integer or a range. If not specified, this rule applies to
2426 # connections through any port.
2427 #
2428 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
2429 &quot;A String&quot;,
2430 ],
2431 },
2432 ],
2433 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
2434 # Maximum number of source address groups is 10.
2435 &quot;A String&quot;,
2436 ],
2437 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2438 # traffic source.
2439 # Maximum number of source fqdn allowed is 100.
2440 &quot;A String&quot;,
2441 ],
2442 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
2443 # Maximum number of source CIDR IP ranges allowed is 5000.
2444 &quot;A String&quot;,
2445 ],
2446 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
2447 #
2448 #
2449 # - UNSPECIFIED
2450 # - INTERNET
2451 # - INTRA_VPC
2452 # - NON_INTERNET
2453 # - VPC_NETWORKS
2454 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
2455 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
2456 #
2457 #
2458 # - UNSPECIFIED
2459 # - INTERNET
2460 # - INTRA_VPC
2461 # - NON_INTERNET
2462 # - VPC_NETWORKS
2463 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
2464 &quot;A String&quot;,
2465 ],
2466 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
2467 # of traffic. Should be specified as 2 letter country code defined as per
2468 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2469 # Maximum number of source region codes allowed is 5000.
2470 &quot;A String&quot;,
2471 ],
2472 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
2473 # of the traffic.
2474 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
2475 # and there is no srcIpRange, this rule will be ignored.
2476 # Maximum number of source tag values allowed is 256.
2477 {
2478 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2479 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2480 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2481 # or its network is deleted.
2482 },
2483 ],
2484 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2485 # The IPs in these lists will be matched against traffic source.
2486 &quot;A String&quot;,
2487 ],
2488 },
2489 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
2490 # must be a positive value between 0 and 2147483647.
2491 # Rules are evaluated from highest to lowest priority where 0 is the
2492 # highest priority and 2147483647 is the lowest priority.
2493 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
2494 # and can be updated.
2495 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
2496 # rule.
2497 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
2498 # Example:
2499 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
2500 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
2501 # &#x27;mirror&#x27;. Cannot be specified for other actions.
2502 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
2503 # This field allows you to control which load balancers get this rule.
2504 # For example, the following are valid values:
2505 #
2506 #
2507 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
2508 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2509 # - projects/project/global/
2510 # forwardingRules/forwardingRule
2511 # - projects/project/regions/region/forwardingRules/
2512 # forwardingRule
2513 &quot;A String&quot;,
2514 ],
2515 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
2516 # allows you to control which network&#x27;s VMs get this rule. If this field
2517 # is left blank, all VMs within the organization will receive the rule.
2518 &quot;A String&quot;,
2519 ],
2520 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
2521 # applies to. If targetSecureTag are specified, then the
2522 # firewall rule applies only to instances in the VPC network that have one
2523 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
2524 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
2525 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
2526 # to all instances on the specified network.
2527 # Maximum number of target label tags allowed is 256.
2528 {
2529 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2530 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2531 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2532 # or its network is deleted.
2533 },
2534 ],
2535 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
2536 # applied with this rule.
2537 &quot;A String&quot;,
2538 ],
2539 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
2540 # Default value is INSTANCES.
2541 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
2542 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
2543 # be set for other actions.
2544 },
2545 ],
2546 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
2547 # This field is not applicable to network firewall policies.
2548 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
2549 # creation and defaults to USER_DEFINED.
2550 #
2551 # The USER_DEFINED value indicates a regular firewall policy.
2552 #
2553 # The SYSTEM value indicates a system-level policy managed by an
2554 # internal service like GKE. This SYSTEM value is reserved for
2555 # internal services and cannot be set by users during policy creation.
2556 # Policies with a SYSTEM source cannot be modified or deleted by
2557 # users.
2558 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
2559 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
2560 #
2561 # Note: if not specified then VPC_POLICY will be used.
2562 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
2563 # This field is not applicable to global firewall policies.
2564 # You must specify this field as part of the HTTP request URL. It is
2565 # not settable as a field in the request body.
2566 &quot;rolloutOperation&quot;: { # Represents progressive rollout input parameters and current status. # Configuration and status of the progressive rollout of this resource.
2567 &quot;rolloutInput&quot;: { # Represents progressive rollout input parameters. # Input parameters to be used by the next not yet scheduled rollout.
2568 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan. Ex.
2569 # organizations//locations/global/rolloutPlans/.
2570 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
2571 &quot;retryUuid&quot;: &quot;A String&quot;, # The UUID of the retry action. Only needed if this is a retry for an
2572 # existing rollout. This can be used after the user canceled a rollout
2573 # and want to retry it with no changes.
2574 },
2575 &quot;rolloutStatus&quot;: { # Represents progressive rollout current status. # [Output only] Current status of the rollout.
2576 &quot;nextRollout&quot;: { # [Output only] The next rollout.
2577 &quot;rolloutId&quot;: &quot;A String&quot;, # Output only. [Output only] The id of the next rollout.
2578 &quot;rolloutPlan&quot;: &quot;A String&quot;, # The name of the rollout plan to be used by the next not yet started
2579 # rollout. This field is auto populated based on RolloutInput when a
2580 # new rollout is scheduled. This can be manually changed before the
2581 # scheduled rollout starts.
2582 # Ex.
2583 # organizations//locations/global/rolloutPlans/
2584 },
2585 &quot;ongoingRollouts&quot;: [ # [Output only] The ongoing rollout.
2586 { # Represents the status of the progressive rollout instance, either
2587 # completed or ongoing.
2588 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
2589 # organizations//locations/global/rollouts/
2590 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
2591 # organizations//locations/global/rolloutPlans/
2592 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
2593 },
2594 ],
2595 &quot;previousRollout&quot;: { # Represents the status of the progressive rollout instance, either # [Output only] The last previously executed rollout.
2596 # completed or ongoing.
2597 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
2598 # organizations//locations/global/rollouts/
2599 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
2600 # organizations//locations/global/rolloutPlans/
2601 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
2602 },
2603 },
2604 },
2605 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
2606 # policy can not exceed a set number of tuples.
2607 &quot;rules&quot;: [ # A list of rules that belong to this policy.
2608 # There must always be a default rule (rule with priority 2147483647 and
2609 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
2610 # default rule with action &quot;allow&quot; will be added.
2611 { # Represents a rule that describes one or more match conditions along with
2612 # the action to be taken when traffic matches this condition (allow or deny).
2613 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
2614 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
2615 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
2616 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
2617 # and &quot;goto_next&quot;.
2618 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
2619 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
2620 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
2621 # the firewall policy rule is not enforced and traffic behaves as if it did
2622 # not exist. If this is unspecified, the firewall policy rule will be
2623 # enabled.
2624 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
2625 # enabled, logs will be exported to the configured export destination in
2626 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
2627 # cannot enable logging on &quot;goto_next&quot; rules.
2628 &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.
2629 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
2630 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
2631 # Exactly one field must be specified.
2632 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
2633 # Maximum number of destination address groups is 10.
2634 &quot;A String&quot;,
2635 ],
2636 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2637 # traffic destination.
2638 # Maximum number of destination fqdn allowed is 100.
2639 &quot;A String&quot;,
2640 ],
2641 &quot;destIpRanges&quot;: [ # CIDR IP address range.
2642 # Maximum number of destination CIDR IP ranges allowed is 5000.
2643 &quot;A String&quot;,
2644 ],
2645 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
2646 #
2647 #
2648 # - UNSPECIFIED
2649 # - INTERNET
2650 # - NON_INTERNET
2651 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
2652 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
2653 #
2654 #
2655 # - UNSPECIFIED
2656 # - INTERNET
2657 # - NON_INTERNET
2658 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
2659 # of traffic. Should be specified as 2 letter country code defined as per
2660 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2661 # Maximum number of dest region codes allowed is 5000.
2662 &quot;A String&quot;,
2663 ],
2664 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2665 # The IPs in these lists will be matched against traffic destination.
2666 &quot;A String&quot;,
2667 ],
2668 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
2669 {
2670 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
2671 # required when creating a firewall rule. This value can either be
2672 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
2673 # protocol number.
2674 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
2675 # only applicable for UDP or TCP protocol. Each entry must be either
2676 # an integer or a range. If not specified, this rule applies to
2677 # connections through any port.
2678 #
2679 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
2680 &quot;A String&quot;,
2681 ],
2682 },
2683 ],
2684 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
2685 # Maximum number of source address groups is 10.
2686 &quot;A String&quot;,
2687 ],
2688 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
2689 # traffic source.
2690 # Maximum number of source fqdn allowed is 100.
2691 &quot;A String&quot;,
2692 ],
2693 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
2694 # Maximum number of source CIDR IP ranges allowed is 5000.
2695 &quot;A String&quot;,
2696 ],
2697 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
2698 #
2699 #
2700 # - UNSPECIFIED
2701 # - INTERNET
2702 # - INTRA_VPC
2703 # - NON_INTERNET
2704 # - VPC_NETWORKS
2705 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
2706 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
2707 #
2708 #
2709 # - UNSPECIFIED
2710 # - INTERNET
2711 # - INTRA_VPC
2712 # - NON_INTERNET
2713 # - VPC_NETWORKS
2714 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
2715 &quot;A String&quot;,
2716 ],
2717 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
2718 # of traffic. Should be specified as 2 letter country code defined as per
2719 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
2720 # Maximum number of source region codes allowed is 5000.
2721 &quot;A String&quot;,
2722 ],
2723 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
2724 # of the traffic.
2725 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
2726 # and there is no srcIpRange, this rule will be ignored.
2727 # Maximum number of source tag values allowed is 256.
2728 {
2729 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2730 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2731 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2732 # or its network is deleted.
2733 },
2734 ],
2735 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
2736 # The IPs in these lists will be matched against traffic source.
2737 &quot;A String&quot;,
2738 ],
2739 },
2740 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
2741 # must be a positive value between 0 and 2147483647.
2742 # Rules are evaluated from highest to lowest priority where 0 is the
2743 # highest priority and 2147483647 is the lowest priority.
2744 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
2745 # and can be updated.
2746 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
2747 # rule.
2748 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
2749 # Example:
2750 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
2751 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
2752 # &#x27;mirror&#x27;. Cannot be specified for other actions.
2753 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
2754 # This field allows you to control which load balancers get this rule.
2755 # For example, the following are valid values:
2756 #
2757 #
2758 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
2759 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2760 # - projects/project/global/
2761 # forwardingRules/forwardingRule
2762 # - projects/project/regions/region/forwardingRules/
2763 # forwardingRule
2764 &quot;A String&quot;,
2765 ],
2766 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
2767 # allows you to control which network&#x27;s VMs get this rule. If this field
2768 # is left blank, all VMs within the organization will receive the rule.
2769 &quot;A String&quot;,
2770 ],
2771 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
2772 # applies to. If targetSecureTag are specified, then the
2773 # firewall rule applies only to instances in the VPC network that have one
2774 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
2775 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
2776 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
2777 # to all instances on the specified network.
2778 # Maximum number of target label tags allowed is 256.
2779 {
2780 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
2781 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
2782 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
2783 # or its network is deleted.
2784 },
2785 ],
2786 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
2787 # applied with this rule.
2788 &quot;A String&quot;,
2789 ],
2790 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
2791 # Default value is INSTANCES.
2792 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
2793 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
2794 # be set for other actions.
2795 },
2796 ],
2797 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2798 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2799 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
2800 # unique in the organization in which the firewall policy is created.
2801 # This field is not applicable to network firewall policies.
2802 # This name must be set on creation and cannot be changed. The name must be
2803 # 1-63 characters long, and comply with RFC1035.
2804 # Specifically, the name must be 1-63 characters long and match the regular
2805 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2806 # character must be a lowercase letter, and all following characters must
2807 # be a dash, lowercase letter, or digit, except the last character, which
2808 # cannot be a dash.
2809 &quot;vpcNetworkScope&quot;: &quot;A String&quot;, # The scope of networks allowed to be associated with the firewall
2810 # policy. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.
2811 #
2812 # A firewall policy with the VPC scope set to GLOBAL_VPC_NETWORK
2813 # is allowed to be attached only to global networks.
2814 #
2815 # When the VPC scope is set to REGIONAL_VPC_NETWORK the firewall
2816 # policy is allowed to be attached only to regional networks in the same
2817 # scope as the firewall policy.
2818 #
2819 # Note: if not specified then GLOBAL_VPC_NETWORK will be used.
2820 }</pre>
2821 </div>
2822
2823 <div class="method">
2824 <code class="details" id="getAssociation">getAssociation(firewallPolicy, name=None, x__xgafv=None)</code>
2825 <pre>Gets an association with the specified name.
2826
2827 Args:
2828 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
2829 name: string, The name of the association to get from the firewall policy.
2830 x__xgafv: string, V1 error format.
2831 Allowed values
2832 1 - v1 error format
2833 2 - v2 error format
2834
2835 Returns:
2836 An object of the form:
2837
2838 {
2839 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
2840 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
2841 # of the firewall policy of the association.
2842 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
2843 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
2844 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
2845 # must be a positive value between 1 and 2147483647.
2846 # Firewall Policies are evaluated from highest to lowest priority where 1
2847 # is the highest priority and 2147483647 is the lowest priority.
2848 # The default value is `1000`. If two associations have the same priority
2849 # then lexicographical order on association names is applied.
2850 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
2851 }</pre>
2852 </div>
2853
2854 <div class="method">
2855 <code class="details" id="getIamPolicy">getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
2856 <pre>Gets the access control policy for a resource. May be empty if no such
2857 policy or resource exists.
2858
2859 Args:
2860 resource: string, Name or id of the resource for this request. (required)
2861 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
2862 x__xgafv: string, V1 error format.
2863 Allowed values
2864 1 - v1 error format
2865 2 - v2 error format
2866
2867 Returns:
2868 An object of the form:
2869
2870 { # An Identity and Access Management (IAM) policy, which specifies access
2871 # controls for Google Cloud resources.
2872 #
2873 #
2874 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2875 # `members`, or principals, to a single `role`. Principals can be user
2876 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2877 # `role` is a named list of permissions; each `role` can be an IAM predefined
2878 # role or a user-created custom role.
2879 #
2880 # For some types of Google Cloud resources, a `binding` can also specify a
2881 # `condition`, which is a logical expression that allows access to a resource
2882 # only if the expression evaluates to `true`. A condition can add constraints
2883 # based on attributes of the request, the resource, or both. To learn which
2884 # resources support conditions in their IAM policies, see the
2885 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2886 #
2887 # **JSON example:**
2888 #
2889 # ```
2890 # {
2891 # &quot;bindings&quot;: [
2892 # {
2893 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2894 # &quot;members&quot;: [
2895 # &quot;user:[email protected]&quot;,
2896 # &quot;group:[email protected]&quot;,
2897 # &quot;domain:google.com&quot;,
2898 # &quot;serviceAccount:[email protected]&quot;
2899 # ]
2900 # },
2901 # {
2902 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2903 # &quot;members&quot;: [
2904 # &quot;user:[email protected]&quot;
2905 # ],
2906 # &quot;condition&quot;: {
2907 # &quot;title&quot;: &quot;expirable access&quot;,
2908 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2909 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2910 # }
2911 # }
2912 # ],
2913 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2914 # &quot;version&quot;: 3
2915 # }
2916 # ```
2917 #
2918 # **YAML example:**
2919 #
2920 # ```
2921 # bindings:
2922 # - members:
2923 # - user:[email protected]
2924 # - group:[email protected]
2925 # - domain:google.com
2926 # - serviceAccount:[email protected]
2927 # role: roles/resourcemanager.organizationAdmin
2928 # - members:
2929 # - user:[email protected]
2930 # role: roles/resourcemanager.organizationViewer
2931 # condition:
2932 # title: expirable access
2933 # description: Does not grant access after Sep 2020
2934 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2935 # etag: BwWWja0YfJA=
2936 # version: 3
2937 # ```
2938 #
2939 # For a description of IAM and its features, see the
2940 # [IAM documentation](https://cloud.google.com/iam/docs/).
2941 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2942 { # Specifies the audit configuration for a service.
2943 # The configuration determines which permission types are logged, and what
2944 # identities, if any, are exempted from logging.
2945 # An AuditConfig must have one or more AuditLogConfigs.
2946 #
2947 # If there are AuditConfigs for both `allServices` and a specific service,
2948 # the union of the two AuditConfigs is used for that service: the log_types
2949 # specified in each AuditConfig are enabled, and the exempted_members in each
2950 # AuditLogConfig are exempted.
2951 #
2952 # Example Policy with multiple AuditConfigs:
2953 #
2954 # {
2955 # &quot;audit_configs&quot;: [
2956 # {
2957 # &quot;service&quot;: &quot;allServices&quot;,
2958 # &quot;audit_log_configs&quot;: [
2959 # {
2960 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2961 # &quot;exempted_members&quot;: [
2962 # &quot;user:[email protected]&quot;
2963 # ]
2964 # },
2965 # {
2966 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2967 # },
2968 # {
2969 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2970 # }
2971 # ]
2972 # },
2973 # {
2974 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2975 # &quot;audit_log_configs&quot;: [
2976 # {
2977 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2978 # },
2979 # {
2980 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2981 # &quot;exempted_members&quot;: [
2982 # &quot;user:[email protected]&quot;
2983 # ]
2984 # }
2985 # ]
2986 # }
2987 # ]
2988 # }
2989 #
2990 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2991 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2992 # `[email protected]` from DATA_WRITE logging.
2993 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2994 { # Provides the configuration for logging a type of permissions.
2995 # Example:
2996 #
2997 # {
2998 # &quot;audit_log_configs&quot;: [
2999 # {
3000 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3001 # &quot;exempted_members&quot;: [
3002 # &quot;user:[email protected]&quot;
3003 # ]
3004 # },
3005 # {
3006 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3007 # }
3008 # ]
3009 # }
3010 #
3011 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3012 # [email protected] from DATA_READ logging.
3013 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3014 # permission.
3015 # Follows the same format of Binding.members.
3016 &quot;A String&quot;,
3017 ],
3018 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3019 },
3020 ],
3021 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3022 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3023 # `allServices` is a special value that covers all services.
3024 },
3025 ],
3026 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3027 # may specify a `condition` that determines how and when the `bindings` are
3028 # applied. Each of the `bindings` must contain at least one principal.
3029 #
3030 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3031 # of these principals can be Google groups. Each occurrence of a principal
3032 # counts towards these limits. For example, if the `bindings` grant 50
3033 # different roles to `user:[email protected]`, and not to any other
3034 # principal, then you can add another 1,450 principals to the `bindings` in
3035 # the `Policy`.
3036 { # Associates `members`, or principals, with a `role`.
3037 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3038 #
3039 # If the condition evaluates to `true`, then this binding applies to the
3040 # current request.
3041 #
3042 # If the condition evaluates to `false`, then this binding does not apply to
3043 # the current request. However, a different role binding might grant the same
3044 # role to one or more of the principals in this binding.
3045 #
3046 # To learn which resources support conditions in their IAM policies, see the
3047 # [IAM
3048 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3049 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3050 # are documented at https://github.com/google/cel-spec.
3051 #
3052 # Example (Comparison):
3053 #
3054 # title: &quot;Summary size limit&quot;
3055 # description: &quot;Determines if a summary is less than 100 chars&quot;
3056 # expression: &quot;document.summary.size() &lt; 100&quot;
3057 #
3058 # Example (Equality):
3059 #
3060 # title: &quot;Requestor is owner&quot;
3061 # description: &quot;Determines if requestor is the document owner&quot;
3062 # expression: &quot;document.owner == request.auth.claims.email&quot;
3063 #
3064 # Example (Logic):
3065 #
3066 # title: &quot;Public documents&quot;
3067 # description: &quot;Determine whether the document should be publicly visible&quot;
3068 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3069 #
3070 # Example (Data Manipulation):
3071 #
3072 # title: &quot;Notification string&quot;
3073 # description: &quot;Create a notification string with a timestamp.&quot;
3074 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3075 #
3076 # The exact variables and functions that may be referenced within an expression
3077 # are determined by the service that evaluates it. See the service
3078 # documentation for additional information.
3079 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3080 # describes the expression, e.g. when hovered over it in a UI.
3081 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3082 # syntax.
3083 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3084 # reporting, e.g. a file name and a position in the file.
3085 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3086 # its purpose. This can be used e.g. in UIs which allow to enter the
3087 # expression.
3088 },
3089 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3090 # `members` can have the following values:
3091 #
3092 # * `allUsers`: A special identifier that represents anyone who is
3093 # on the internet; with or without a Google account.
3094 #
3095 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3096 # who is authenticated with a Google account or a service account.
3097 # Does not include identities that come from external identity providers
3098 # (IdPs) through identity federation.
3099 #
3100 # * `user:{emailid}`: An email address that represents a specific Google
3101 # account. For example, `[email protected]` .
3102 #
3103 #
3104 # * `serviceAccount:{emailid}`: An email address that represents a Google
3105 # service account. For example,
3106 # `[email protected]`.
3107 #
3108 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3109 # identifier for a
3110 # [Kubernetes service
3111 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3112 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3113 #
3114 # * `group:{emailid}`: An email address that represents a Google group.
3115 # For example, `[email protected]`.
3116 #
3117 #
3118 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3119 # users of that domain. For example, `google.com` or `example.com`.
3120 #
3121 #
3122 #
3123 #
3124 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3125 # A single identity in a workforce identity pool.
3126 #
3127 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3128 # All workforce identities in a group.
3129 #
3130 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3131 # All workforce identities with a specific attribute value.
3132 #
3133 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3134 # All identities in a workforce identity pool.
3135 #
3136 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3137 # A single identity in a workload identity pool.
3138 #
3139 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3140 # A workload identity pool group.
3141 #
3142 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3143 # All identities in a workload identity pool with a certain attribute.
3144 #
3145 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3146 # All identities in a workload identity pool.
3147 #
3148 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3149 # identifier) representing a user that has been recently deleted. For
3150 # example, `[email protected]?uid=123456789012345678901`. If the user is
3151 # recovered, this value reverts to `user:{emailid}` and the recovered user
3152 # retains the role in the binding.
3153 #
3154 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3155 # unique identifier) representing a service account that has been recently
3156 # deleted. For example,
3157 # `[email protected]?uid=123456789012345678901`.
3158 # If the service account is undeleted, this value reverts to
3159 # `serviceAccount:{emailid}` and the undeleted service account retains the
3160 # role in the binding.
3161 #
3162 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3163 # identifier) representing a Google group that has been recently
3164 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3165 # the group is recovered, this value reverts to `group:{emailid}` and the
3166 # recovered group retains the role in the binding.
3167 #
3168 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3169 # Deleted single identity in a workforce identity pool. For example,
3170 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3171 &quot;A String&quot;,
3172 ],
3173 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3174 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3175 #
3176 # For an overview of the IAM roles and permissions, see the
3177 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3178 # a list of the available pre-defined roles, see
3179 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3180 },
3181 ],
3182 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3183 # prevent simultaneous updates of a policy from overwriting each other.
3184 # It is strongly suggested that systems make use of the `etag` in the
3185 # read-modify-write cycle to perform policy updates in order to avoid race
3186 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3187 # systems are expected to put that etag in the request to `setIamPolicy` to
3188 # ensure that their change will be applied to the same version of the policy.
3189 #
3190 # **Important:** If you use IAM Conditions, you must include the `etag` field
3191 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3192 # you to overwrite a version `3` policy with a version `1` policy, and all of
3193 # the conditions in the version `3` policy are lost.
3194 &quot;version&quot;: 42, # Specifies the format of the policy.
3195 #
3196 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3197 # are rejected.
3198 #
3199 # Any operation that affects conditional role bindings must specify version
3200 # `3`. This requirement applies to the following operations:
3201 #
3202 # * Getting a policy that includes a conditional role binding
3203 # * Adding a conditional role binding to a policy
3204 # * Changing a conditional role binding in a policy
3205 # * Removing any role binding, with or without a condition, from a policy
3206 # that includes conditions
3207 #
3208 # **Important:** If you use IAM Conditions, you must include the `etag` field
3209 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3210 # you to overwrite a version `3` policy with a version `1` policy, and all of
3211 # the conditions in the version `3` policy are lost.
3212 #
3213 # If a policy does not include any conditions, operations on that policy may
3214 # specify any valid version or leave the field unset.
3215 #
3216 # To learn which resources support conditions in their IAM policies, see the
3217 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3218 }</pre>
3219 </div>
3220
3221 <div class="method">
3222 <code class="details" id="getPacketMirroringRule">getPacketMirroringRule(firewallPolicy, priority=None, x__xgafv=None)</code>
3223 <pre>Gets a packet mirroring rule of the specified priority.
3224
3225 Args:
3226 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
3227 priority: integer, The priority of the rule to get from the firewall policy.
3228 x__xgafv: string, V1 error format.
3229 Allowed values
3230 1 - v1 error format
3231 2 - v2 error format
3232
3233 Returns:
3234 An object of the form:
3235
3236 { # Represents a rule that describes one or more match conditions along with
3237 # the action to be taken when traffic matches this condition (allow or deny).
3238 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3239 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3240 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3241 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3242 # and &quot;goto_next&quot;.
3243 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3244 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3245 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3246 # the firewall policy rule is not enforced and traffic behaves as if it did
3247 # not exist. If this is unspecified, the firewall policy rule will be
3248 # enabled.
3249 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3250 # enabled, logs will be exported to the configured export destination in
3251 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3252 # cannot enable logging on &quot;goto_next&quot; rules.
3253 &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.
3254 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3255 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3256 # Exactly one field must be specified.
3257 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3258 # Maximum number of destination address groups is 10.
3259 &quot;A String&quot;,
3260 ],
3261 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3262 # traffic destination.
3263 # Maximum number of destination fqdn allowed is 100.
3264 &quot;A String&quot;,
3265 ],
3266 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3267 # Maximum number of destination CIDR IP ranges allowed is 5000.
3268 &quot;A String&quot;,
3269 ],
3270 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3271 #
3272 #
3273 # - UNSPECIFIED
3274 # - INTERNET
3275 # - NON_INTERNET
3276 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3277 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3278 #
3279 #
3280 # - UNSPECIFIED
3281 # - INTERNET
3282 # - NON_INTERNET
3283 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3284 # of traffic. Should be specified as 2 letter country code defined as per
3285 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3286 # Maximum number of dest region codes allowed is 5000.
3287 &quot;A String&quot;,
3288 ],
3289 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3290 # The IPs in these lists will be matched against traffic destination.
3291 &quot;A String&quot;,
3292 ],
3293 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3294 {
3295 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3296 # required when creating a firewall rule. This value can either be
3297 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3298 # protocol number.
3299 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3300 # only applicable for UDP or TCP protocol. Each entry must be either
3301 # an integer or a range. If not specified, this rule applies to
3302 # connections through any port.
3303 #
3304 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3305 &quot;A String&quot;,
3306 ],
3307 },
3308 ],
3309 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3310 # Maximum number of source address groups is 10.
3311 &quot;A String&quot;,
3312 ],
3313 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3314 # traffic source.
3315 # Maximum number of source fqdn allowed is 100.
3316 &quot;A String&quot;,
3317 ],
3318 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3319 # Maximum number of source CIDR IP ranges allowed is 5000.
3320 &quot;A String&quot;,
3321 ],
3322 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3323 #
3324 #
3325 # - UNSPECIFIED
3326 # - INTERNET
3327 # - INTRA_VPC
3328 # - NON_INTERNET
3329 # - VPC_NETWORKS
3330 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3331 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3332 #
3333 #
3334 # - UNSPECIFIED
3335 # - INTERNET
3336 # - INTRA_VPC
3337 # - NON_INTERNET
3338 # - VPC_NETWORKS
3339 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3340 &quot;A String&quot;,
3341 ],
3342 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3343 # of traffic. Should be specified as 2 letter country code defined as per
3344 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3345 # Maximum number of source region codes allowed is 5000.
3346 &quot;A String&quot;,
3347 ],
3348 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3349 # of the traffic.
3350 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3351 # and there is no srcIpRange, this rule will be ignored.
3352 # Maximum number of source tag values allowed is 256.
3353 {
3354 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3355 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3356 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3357 # or its network is deleted.
3358 },
3359 ],
3360 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3361 # The IPs in these lists will be matched against traffic source.
3362 &quot;A String&quot;,
3363 ],
3364 },
3365 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3366 # must be a positive value between 0 and 2147483647.
3367 # Rules are evaluated from highest to lowest priority where 0 is the
3368 # highest priority and 2147483647 is the lowest priority.
3369 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3370 # and can be updated.
3371 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3372 # rule.
3373 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3374 # Example:
3375 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3376 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3377 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3378 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3379 # This field allows you to control which load balancers get this rule.
3380 # For example, the following are valid values:
3381 #
3382 #
3383 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3384 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3385 # - projects/project/global/
3386 # forwardingRules/forwardingRule
3387 # - projects/project/regions/region/forwardingRules/
3388 # forwardingRule
3389 &quot;A String&quot;,
3390 ],
3391 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3392 # allows you to control which network&#x27;s VMs get this rule. If this field
3393 # is left blank, all VMs within the organization will receive the rule.
3394 &quot;A String&quot;,
3395 ],
3396 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3397 # applies to. If targetSecureTag are specified, then the
3398 # firewall rule applies only to instances in the VPC network that have one
3399 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3400 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3401 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3402 # to all instances on the specified network.
3403 # Maximum number of target label tags allowed is 256.
3404 {
3405 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3406 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3407 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3408 # or its network is deleted.
3409 },
3410 ],
3411 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3412 # applied with this rule.
3413 &quot;A String&quot;,
3414 ],
3415 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3416 # Default value is INSTANCES.
3417 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3418 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3419 # be set for other actions.
3420 }</pre>
3421 </div>
3422
3423 <div class="method">
3424 <code class="details" id="getRule">getRule(firewallPolicy, priority=None, x__xgafv=None)</code>
3425 <pre>Gets a rule of the specified priority.
3426
3427 Args:
3428 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
3429 priority: integer, The priority of the rule to get from the firewall policy.
3430 x__xgafv: string, V1 error format.
3431 Allowed values
3432 1 - v1 error format
3433 2 - v2 error format
3434
3435 Returns:
3436 An object of the form:
3437
3438 { # Represents a rule that describes one or more match conditions along with
3439 # the action to be taken when traffic matches this condition (allow or deny).
3440 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3441 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3442 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3443 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3444 # and &quot;goto_next&quot;.
3445 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3446 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3447 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3448 # the firewall policy rule is not enforced and traffic behaves as if it did
3449 # not exist. If this is unspecified, the firewall policy rule will be
3450 # enabled.
3451 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3452 # enabled, logs will be exported to the configured export destination in
3453 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3454 # cannot enable logging on &quot;goto_next&quot; rules.
3455 &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.
3456 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3457 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3458 # Exactly one field must be specified.
3459 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3460 # Maximum number of destination address groups is 10.
3461 &quot;A String&quot;,
3462 ],
3463 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3464 # traffic destination.
3465 # Maximum number of destination fqdn allowed is 100.
3466 &quot;A String&quot;,
3467 ],
3468 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3469 # Maximum number of destination CIDR IP ranges allowed is 5000.
3470 &quot;A String&quot;,
3471 ],
3472 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3473 #
3474 #
3475 # - UNSPECIFIED
3476 # - INTERNET
3477 # - NON_INTERNET
3478 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3479 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3480 #
3481 #
3482 # - UNSPECIFIED
3483 # - INTERNET
3484 # - NON_INTERNET
3485 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3486 # of traffic. Should be specified as 2 letter country code defined as per
3487 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3488 # Maximum number of dest region codes allowed is 5000.
3489 &quot;A String&quot;,
3490 ],
3491 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3492 # The IPs in these lists will be matched against traffic destination.
3493 &quot;A String&quot;,
3494 ],
3495 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3496 {
3497 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3498 # required when creating a firewall rule. This value can either be
3499 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3500 # protocol number.
3501 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3502 # only applicable for UDP or TCP protocol. Each entry must be either
3503 # an integer or a range. If not specified, this rule applies to
3504 # connections through any port.
3505 #
3506 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3507 &quot;A String&quot;,
3508 ],
3509 },
3510 ],
3511 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3512 # Maximum number of source address groups is 10.
3513 &quot;A String&quot;,
3514 ],
3515 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3516 # traffic source.
3517 # Maximum number of source fqdn allowed is 100.
3518 &quot;A String&quot;,
3519 ],
3520 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3521 # Maximum number of source CIDR IP ranges allowed is 5000.
3522 &quot;A String&quot;,
3523 ],
3524 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3525 #
3526 #
3527 # - UNSPECIFIED
3528 # - INTERNET
3529 # - INTRA_VPC
3530 # - NON_INTERNET
3531 # - VPC_NETWORKS
3532 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3533 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3534 #
3535 #
3536 # - UNSPECIFIED
3537 # - INTERNET
3538 # - INTRA_VPC
3539 # - NON_INTERNET
3540 # - VPC_NETWORKS
3541 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3542 &quot;A String&quot;,
3543 ],
3544 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3545 # of traffic. Should be specified as 2 letter country code defined as per
3546 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3547 # Maximum number of source region codes allowed is 5000.
3548 &quot;A String&quot;,
3549 ],
3550 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3551 # of the traffic.
3552 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3553 # and there is no srcIpRange, this rule will be ignored.
3554 # Maximum number of source tag values allowed is 256.
3555 {
3556 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3557 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3558 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3559 # or its network is deleted.
3560 },
3561 ],
3562 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3563 # The IPs in these lists will be matched against traffic source.
3564 &quot;A String&quot;,
3565 ],
3566 },
3567 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3568 # must be a positive value between 0 and 2147483647.
3569 # Rules are evaluated from highest to lowest priority where 0 is the
3570 # highest priority and 2147483647 is the lowest priority.
3571 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3572 # and can be updated.
3573 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3574 # rule.
3575 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3576 # Example:
3577 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3578 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3579 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3580 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3581 # This field allows you to control which load balancers get this rule.
3582 # For example, the following are valid values:
3583 #
3584 #
3585 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3586 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3587 # - projects/project/global/
3588 # forwardingRules/forwardingRule
3589 # - projects/project/regions/region/forwardingRules/
3590 # forwardingRule
3591 &quot;A String&quot;,
3592 ],
3593 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3594 # allows you to control which network&#x27;s VMs get this rule. If this field
3595 # is left blank, all VMs within the organization will receive the rule.
3596 &quot;A String&quot;,
3597 ],
3598 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3599 # applies to. If targetSecureTag are specified, then the
3600 # firewall rule applies only to instances in the VPC network that have one
3601 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3602 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3603 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3604 # to all instances on the specified network.
3605 # Maximum number of target label tags allowed is 256.
3606 {
3607 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3608 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3609 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3610 # or its network is deleted.
3611 },
3612 ],
3613 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3614 # applied with this rule.
3615 &quot;A String&quot;,
3616 ],
3617 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3618 # Default value is INSTANCES.
3619 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3620 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3621 # be set for other actions.
3622 }</pre>
3623 </div>
3624
3625 <div class="method">
3626 <code class="details" id="insert">insert(body=None, parentId=None, requestId=None, x__xgafv=None)</code>
3627 <pre>Creates a new policy in the specified project using the data included in
3628 the request.
3629
3630 Args:
3631 body: object, The request body.
3632 The object takes the form of:
3633
3634 { # Represents a Firewall Policy resource.
3635 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
3636 {
3637 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
3638 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
3639 # of the firewall policy of the association.
3640 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
3641 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
3642 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
3643 # must be a positive value between 1 and 2147483647.
3644 # Firewall Policies are evaluated from highest to lowest priority where 1
3645 # is the highest priority and 2147483647 is the lowest priority.
3646 # The default value is `1000`. If two associations have the same priority
3647 # then lexicographical order on association names is applied.
3648 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
3649 },
3650 ],
3651 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3652 # text format.
3653 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3654 # create the resource.
3655 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
3656 # Organization firewall policy. The name should be unique in the organization
3657 # in which the firewall policy is created.
3658 # This field is not applicable to network firewall policies.
3659 # This name must be set on creation and cannot be changed.
3660 # The name must be 1-63 characters long, and comply
3661 # with RFC1035. Specifically, the name must be 1-63 characters
3662 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
3663 # means the first character must be a lowercase letter, and all following
3664 # characters must be a dash, lowercase letter, or digit, except the last
3665 # character, which cannot be a dash.
3666 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
3667 # the metadata&#x27;s contents and used for optimistic locking. The
3668 # fingerprint is initially generated by Compute Engine and changes after
3669 # every request to modify or update metadata. You must always provide an
3670 # up-to-date fingerprint hash in order to update or change metadata,
3671 # otherwise the request will fail with error412 conditionNotMet.
3672 #
3673 # To see the latest fingerprint, make get() request to the
3674 # firewall policy.
3675 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
3676 # defined by the server.
3677 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
3678 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
3679 # [Output Only] numeric ID allocated by Google Cloud which uniquely
3680 # identifies the Organization Firewall Policy.
3681 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
3682 { # Represents a rule that describes one or more match conditions along with
3683 # the action to be taken when traffic matches this condition (allow or deny).
3684 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3685 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3686 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3687 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3688 # and &quot;goto_next&quot;.
3689 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3690 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3691 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3692 # the firewall policy rule is not enforced and traffic behaves as if it did
3693 # not exist. If this is unspecified, the firewall policy rule will be
3694 # enabled.
3695 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3696 # enabled, logs will be exported to the configured export destination in
3697 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3698 # cannot enable logging on &quot;goto_next&quot; rules.
3699 &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.
3700 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3701 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3702 # Exactly one field must be specified.
3703 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3704 # Maximum number of destination address groups is 10.
3705 &quot;A String&quot;,
3706 ],
3707 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3708 # traffic destination.
3709 # Maximum number of destination fqdn allowed is 100.
3710 &quot;A String&quot;,
3711 ],
3712 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3713 # Maximum number of destination CIDR IP ranges allowed is 5000.
3714 &quot;A String&quot;,
3715 ],
3716 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3717 #
3718 #
3719 # - UNSPECIFIED
3720 # - INTERNET
3721 # - NON_INTERNET
3722 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3723 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3724 #
3725 #
3726 # - UNSPECIFIED
3727 # - INTERNET
3728 # - NON_INTERNET
3729 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3730 # of traffic. Should be specified as 2 letter country code defined as per
3731 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3732 # Maximum number of dest region codes allowed is 5000.
3733 &quot;A String&quot;,
3734 ],
3735 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3736 # The IPs in these lists will be matched against traffic destination.
3737 &quot;A String&quot;,
3738 ],
3739 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3740 {
3741 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3742 # required when creating a firewall rule. This value can either be
3743 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3744 # protocol number.
3745 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3746 # only applicable for UDP or TCP protocol. Each entry must be either
3747 # an integer or a range. If not specified, this rule applies to
3748 # connections through any port.
3749 #
3750 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
3751 &quot;A String&quot;,
3752 ],
3753 },
3754 ],
3755 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
3756 # Maximum number of source address groups is 10.
3757 &quot;A String&quot;,
3758 ],
3759 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3760 # traffic source.
3761 # Maximum number of source fqdn allowed is 100.
3762 &quot;A String&quot;,
3763 ],
3764 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
3765 # Maximum number of source CIDR IP ranges allowed is 5000.
3766 &quot;A String&quot;,
3767 ],
3768 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
3769 #
3770 #
3771 # - UNSPECIFIED
3772 # - INTERNET
3773 # - INTRA_VPC
3774 # - NON_INTERNET
3775 # - VPC_NETWORKS
3776 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
3777 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
3778 #
3779 #
3780 # - UNSPECIFIED
3781 # - INTERNET
3782 # - INTRA_VPC
3783 # - NON_INTERNET
3784 # - VPC_NETWORKS
3785 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
3786 &quot;A String&quot;,
3787 ],
3788 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
3789 # of traffic. Should be specified as 2 letter country code defined as per
3790 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3791 # Maximum number of source region codes allowed is 5000.
3792 &quot;A String&quot;,
3793 ],
3794 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
3795 # of the traffic.
3796 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
3797 # and there is no srcIpRange, this rule will be ignored.
3798 # Maximum number of source tag values allowed is 256.
3799 {
3800 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3801 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3802 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3803 # or its network is deleted.
3804 },
3805 ],
3806 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3807 # The IPs in these lists will be matched against traffic source.
3808 &quot;A String&quot;,
3809 ],
3810 },
3811 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
3812 # must be a positive value between 0 and 2147483647.
3813 # Rules are evaluated from highest to lowest priority where 0 is the
3814 # highest priority and 2147483647 is the lowest priority.
3815 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
3816 # and can be updated.
3817 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
3818 # rule.
3819 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
3820 # Example:
3821 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
3822 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
3823 # &#x27;mirror&#x27;. Cannot be specified for other actions.
3824 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
3825 # This field allows you to control which load balancers get this rule.
3826 # For example, the following are valid values:
3827 #
3828 #
3829 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
3830 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3831 # - projects/project/global/
3832 # forwardingRules/forwardingRule
3833 # - projects/project/regions/region/forwardingRules/
3834 # forwardingRule
3835 &quot;A String&quot;,
3836 ],
3837 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
3838 # allows you to control which network&#x27;s VMs get this rule. If this field
3839 # is left blank, all VMs within the organization will receive the rule.
3840 &quot;A String&quot;,
3841 ],
3842 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
3843 # applies to. If targetSecureTag are specified, then the
3844 # firewall rule applies only to instances in the VPC network that have one
3845 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
3846 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
3847 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
3848 # to all instances on the specified network.
3849 # Maximum number of target label tags allowed is 256.
3850 {
3851 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
3852 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
3853 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
3854 # or its network is deleted.
3855 },
3856 ],
3857 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
3858 # applied with this rule.
3859 &quot;A String&quot;,
3860 ],
3861 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
3862 # Default value is INSTANCES.
3863 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
3864 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
3865 # be set for other actions.
3866 },
3867 ],
3868 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
3869 # This field is not applicable to network firewall policies.
3870 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
3871 # creation and defaults to USER_DEFINED.
3872 #
3873 # The USER_DEFINED value indicates a regular firewall policy.
3874 #
3875 # The SYSTEM value indicates a system-level policy managed by an
3876 # internal service like GKE. This SYSTEM value is reserved for
3877 # internal services and cannot be set by users during policy creation.
3878 # Policies with a SYSTEM source cannot be modified or deleted by
3879 # users.
3880 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
3881 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
3882 #
3883 # Note: if not specified then VPC_POLICY will be used.
3884 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
3885 # This field is not applicable to global firewall policies.
3886 # You must specify this field as part of the HTTP request URL. It is
3887 # not settable as a field in the request body.
3888 &quot;rolloutOperation&quot;: { # Represents progressive rollout input parameters and current status. # Configuration and status of the progressive rollout of this resource.
3889 &quot;rolloutInput&quot;: { # Represents progressive rollout input parameters. # Input parameters to be used by the next not yet scheduled rollout.
3890 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan. Ex.
3891 # organizations//locations/global/rolloutPlans/.
3892 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
3893 &quot;retryUuid&quot;: &quot;A String&quot;, # The UUID of the retry action. Only needed if this is a retry for an
3894 # existing rollout. This can be used after the user canceled a rollout
3895 # and want to retry it with no changes.
3896 },
3897 &quot;rolloutStatus&quot;: { # Represents progressive rollout current status. # [Output only] Current status of the rollout.
3898 &quot;nextRollout&quot;: { # [Output only] The next rollout.
3899 &quot;rolloutId&quot;: &quot;A String&quot;, # Output only. [Output only] The id of the next rollout.
3900 &quot;rolloutPlan&quot;: &quot;A String&quot;, # The name of the rollout plan to be used by the next not yet started
3901 # rollout. This field is auto populated based on RolloutInput when a
3902 # new rollout is scheduled. This can be manually changed before the
3903 # scheduled rollout starts.
3904 # Ex.
3905 # organizations//locations/global/rolloutPlans/
3906 },
3907 &quot;ongoingRollouts&quot;: [ # [Output only] The ongoing rollout.
3908 { # Represents the status of the progressive rollout instance, either
3909 # completed or ongoing.
3910 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
3911 # organizations//locations/global/rollouts/
3912 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
3913 # organizations//locations/global/rolloutPlans/
3914 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
3915 },
3916 ],
3917 &quot;previousRollout&quot;: { # Represents the status of the progressive rollout instance, either # [Output only] The last previously executed rollout.
3918 # completed or ongoing.
3919 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
3920 # organizations//locations/global/rollouts/
3921 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
3922 # organizations//locations/global/rolloutPlans/
3923 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
3924 },
3925 },
3926 },
3927 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
3928 # policy can not exceed a set number of tuples.
3929 &quot;rules&quot;: [ # A list of rules that belong to this policy.
3930 # There must always be a default rule (rule with priority 2147483647 and
3931 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
3932 # default rule with action &quot;allow&quot; will be added.
3933 { # Represents a rule that describes one or more match conditions along with
3934 # the action to be taken when traffic matches this condition (allow or deny).
3935 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
3936 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
3937 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
3938 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
3939 # and &quot;goto_next&quot;.
3940 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
3941 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
3942 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
3943 # the firewall policy rule is not enforced and traffic behaves as if it did
3944 # not exist. If this is unspecified, the firewall policy rule will be
3945 # enabled.
3946 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
3947 # enabled, logs will be exported to the configured export destination in
3948 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
3949 # cannot enable logging on &quot;goto_next&quot; rules.
3950 &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.
3951 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
3952 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
3953 # Exactly one field must be specified.
3954 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
3955 # Maximum number of destination address groups is 10.
3956 &quot;A String&quot;,
3957 ],
3958 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
3959 # traffic destination.
3960 # Maximum number of destination fqdn allowed is 100.
3961 &quot;A String&quot;,
3962 ],
3963 &quot;destIpRanges&quot;: [ # CIDR IP address range.
3964 # Maximum number of destination CIDR IP ranges allowed is 5000.
3965 &quot;A String&quot;,
3966 ],
3967 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
3968 #
3969 #
3970 # - UNSPECIFIED
3971 # - INTERNET
3972 # - NON_INTERNET
3973 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
3974 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
3975 #
3976 #
3977 # - UNSPECIFIED
3978 # - INTERNET
3979 # - NON_INTERNET
3980 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
3981 # of traffic. Should be specified as 2 letter country code defined as per
3982 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
3983 # Maximum number of dest region codes allowed is 5000.
3984 &quot;A String&quot;,
3985 ],
3986 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
3987 # The IPs in these lists will be matched against traffic destination.
3988 &quot;A String&quot;,
3989 ],
3990 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
3991 {
3992 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
3993 # required when creating a firewall rule. This value can either be
3994 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
3995 # protocol number.
3996 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
3997 # only applicable for UDP or TCP protocol. Each entry must be either
3998 # an integer or a range. If not specified, this rule applies to
3999 # connections through any port.
4000 #
4001 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4002 &quot;A String&quot;,
4003 ],
4004 },
4005 ],
4006 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4007 # Maximum number of source address groups is 10.
4008 &quot;A String&quot;,
4009 ],
4010 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4011 # traffic source.
4012 # Maximum number of source fqdn allowed is 100.
4013 &quot;A String&quot;,
4014 ],
4015 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4016 # Maximum number of source CIDR IP ranges allowed is 5000.
4017 &quot;A String&quot;,
4018 ],
4019 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4020 #
4021 #
4022 # - UNSPECIFIED
4023 # - INTERNET
4024 # - INTRA_VPC
4025 # - NON_INTERNET
4026 # - VPC_NETWORKS
4027 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4028 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4029 #
4030 #
4031 # - UNSPECIFIED
4032 # - INTERNET
4033 # - INTRA_VPC
4034 # - NON_INTERNET
4035 # - VPC_NETWORKS
4036 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4037 &quot;A String&quot;,
4038 ],
4039 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4040 # of traffic. Should be specified as 2 letter country code defined as per
4041 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4042 # Maximum number of source region codes allowed is 5000.
4043 &quot;A String&quot;,
4044 ],
4045 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4046 # of the traffic.
4047 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4048 # and there is no srcIpRange, this rule will be ignored.
4049 # Maximum number of source tag values allowed is 256.
4050 {
4051 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4052 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4053 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4054 # or its network is deleted.
4055 },
4056 ],
4057 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4058 # The IPs in these lists will be matched against traffic source.
4059 &quot;A String&quot;,
4060 ],
4061 },
4062 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4063 # must be a positive value between 0 and 2147483647.
4064 # Rules are evaluated from highest to lowest priority where 0 is the
4065 # highest priority and 2147483647 is the lowest priority.
4066 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4067 # and can be updated.
4068 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4069 # rule.
4070 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4071 # Example:
4072 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4073 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4074 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4075 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4076 # This field allows you to control which load balancers get this rule.
4077 # For example, the following are valid values:
4078 #
4079 #
4080 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4081 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4082 # - projects/project/global/
4083 # forwardingRules/forwardingRule
4084 # - projects/project/regions/region/forwardingRules/
4085 # forwardingRule
4086 &quot;A String&quot;,
4087 ],
4088 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4089 # allows you to control which network&#x27;s VMs get this rule. If this field
4090 # is left blank, all VMs within the organization will receive the rule.
4091 &quot;A String&quot;,
4092 ],
4093 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4094 # applies to. If targetSecureTag are specified, then the
4095 # firewall rule applies only to instances in the VPC network that have one
4096 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4097 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
4098 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
4099 # to all instances on the specified network.
4100 # Maximum number of target label tags allowed is 256.
4101 {
4102 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4103 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4104 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4105 # or its network is deleted.
4106 },
4107 ],
4108 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4109 # applied with this rule.
4110 &quot;A String&quot;,
4111 ],
4112 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
4113 # Default value is INSTANCES.
4114 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
4115 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
4116 # be set for other actions.
4117 },
4118 ],
4119 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4120 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4121 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
4122 # unique in the organization in which the firewall policy is created.
4123 # This field is not applicable to network firewall policies.
4124 # This name must be set on creation and cannot be changed. The name must be
4125 # 1-63 characters long, and comply with RFC1035.
4126 # Specifically, the name must be 1-63 characters long and match the regular
4127 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4128 # character must be a lowercase letter, and all following characters must
4129 # be a dash, lowercase letter, or digit, except the last character, which
4130 # cannot be a dash.
4131 &quot;vpcNetworkScope&quot;: &quot;A String&quot;, # The scope of networks allowed to be associated with the firewall
4132 # policy. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.
4133 #
4134 # A firewall policy with the VPC scope set to GLOBAL_VPC_NETWORK
4135 # is allowed to be attached only to global networks.
4136 #
4137 # When the VPC scope is set to REGIONAL_VPC_NETWORK the firewall
4138 # policy is allowed to be attached only to regional networks in the same
4139 # scope as the firewall policy.
4140 #
4141 # Note: if not specified then GLOBAL_VPC_NETWORK will be used.
4142 }
4143
4144 parentId: string, Parent ID for this request. The ID can be either be &quot;folders/[FOLDER_ID]&quot;
4145 if the parent is a folder or &quot;organizations/[ORGANIZATION_ID]&quot; if the
4146 parent is an organization.
4147 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4148 that if you must retry your request, the server will know to ignore the
4149 request if it has already been completed.
4150
4151 For example, consider a situation where you make an initial request and
4152 the request times out. If you make the request again with the same
4153 request ID, the server can check if original operation with the same
4154 request ID was received, and if so, will ignore the second request. This
4155 prevents clients from accidentally creating duplicate commitments.
4156
4157 The request ID must be
4158 a valid UUID with the exception that zero UUID is not supported
4159 (00000000-0000-0000-0000-000000000000).
4160 x__xgafv: string, V1 error format.
4161 Allowed values
4162 1 - v1 error format
4163 2 - v2 error format
4164
4165 Returns:
4166 An object of the form:
4167
4168 { # Represents an Operation resource.
4169 #
4170 # Google Compute Engine has three Operation resources:
4171 #
4172 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4173 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4174 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4175 #
4176 # You can use an operation resource to manage asynchronous API requests.
4177 # For more information, readHandling
4178 # API responses.
4179 #
4180 # Operations can be global, regional or zonal.
4181 #
4182 # - For global operations, use the `globalOperations`
4183 # resource.
4184 # - For regional operations, use the
4185 # `regionOperations` resource.
4186 # - For zonal operations, use
4187 # the `zoneOperations` resource.
4188 #
4189 #
4190 #
4191 # For more information, read
4192 # Global, Regional, and Zonal Resources.
4193 #
4194 # Note that completed Operation resources have a limited
4195 # retention period.
4196 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4197 # Not present otherwise.
4198 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4199 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4200 # set when the operation is created.
4201 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4202 # text format.
4203 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4204 # this field will be populated.
4205 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4206 # operation.
4207 {
4208 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4209 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4210 # details. There is a set of defined message types to use for providing
4211 # details.The syntax depends on the error code. For example,
4212 # QuotaExceededInfo will have details when the error code is
4213 # QUOTA_EXCEEDED.
4214 {
4215 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4216 #
4217 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4218 # is not enabled:
4219 #
4220 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4221 # &quot;domain&quot;: &quot;googleapis.com&quot;
4222 # &quot;metadata&quot;: {
4223 # &quot;resource&quot;: &quot;projects/123&quot;,
4224 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4225 # }
4226 # }
4227 #
4228 # This response indicates that the pubsub.googleapis.com API is not enabled.
4229 #
4230 # Example of an error that is returned when attempting to create a Spanner
4231 # instance in a region that is out of stock:
4232 #
4233 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4234 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4235 # &quot;metadata&quot;: {
4236 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4237 # }
4238 # }
4239 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4240 # is typically the registered service name of the tool or product that
4241 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4242 # generated by some common infrastructure, the error domain must be a
4243 # globally unique value that identifies the infrastructure. For Google API
4244 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4245 &quot;metadatas&quot;: { # Additional structured details about this error.
4246 #
4247 # Keys must match a regular expression of `a-z+` but should
4248 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4249 # length. When identifying the current value of an exceeded limit, the units
4250 # should be contained in the key, not the value. For example, rather than
4251 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4252 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4253 # instances that can be created in a single (batch) request.
4254 &quot;a_key&quot;: &quot;A String&quot;,
4255 },
4256 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4257 # proximate cause of the error. Error reasons are unique within a particular
4258 # domain of errors. This should be at most 63 characters and match a
4259 # regular expression of `A-Z+[A-Z0-9]`, which represents
4260 # UPPER_SNAKE_CASE.
4261 },
4262 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4263 #
4264 # For example, if a quota check failed with an error indicating the calling
4265 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4266 # directly to the right place in the developer console to flip the bit.
4267 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4268 { # Describes a URL link.
4269 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4270 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4271 },
4272 ],
4273 },
4274 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4275 # which can be attached to an RPC error.
4276 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4277 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4278 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4279 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4280 },
4281 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4282 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4283 &quot;a_key&quot;: &quot;A String&quot;,
4284 },
4285 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4286 # type or metric.
4287 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4288 # or metric.
4289 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4290 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4291 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4292 },
4293 },
4294 ],
4295 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4296 # This property is optional.
4297 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4298 },
4299 ],
4300 },
4301 &quot;getVersionOperationMetadata&quot;: {
4302 &quot;inlineSbomInfo&quot;: {
4303 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4304 # appropriate identifiers.
4305 &quot;a_key&quot;: &quot;A String&quot;,
4306 },
4307 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4308 # identifiers.
4309 &quot;a_key&quot;: &quot;A String&quot;,
4310 },
4311 },
4312 },
4313 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4314 # message that was returned, such as `NOT FOUND`.
4315 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4316 # status code that was returned. For example, a `404` means the
4317 # resource was not found.
4318 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4319 # defined by the server.
4320 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4321 # This value is inRFC3339
4322 # text format.
4323 &quot;instancesBulkInsertOperationMetadata&quot;: {
4324 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4325 # Example key: zones/us-central1-a
4326 &quot;a_key&quot;: {
4327 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4328 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4329 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4330 # error.
4331 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4332 # if the flow is rolling forward or rolling back.
4333 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4334 },
4335 },
4336 },
4337 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4338 # Operation resources.
4339 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4340 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4341 # group of operations results from a `bulkInsert` API request.
4342 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4343 # `update`, or `delete`, and so on.
4344 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4345 # There is no requirement that this be linear or support any granularity of
4346 # operations. This should not be used to guess when the operation will be
4347 # complete. This number should monotonically increase as the operation
4348 # progresses.
4349 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4350 # applicable when performing regional operations.
4351 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4352 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4353 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4354 # this field will contain information on all underlying zonal actions and
4355 # their state.
4356 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4357 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4358 # Example key: zones/us-central1-a
4359 &quot;a_key&quot;: {
4360 &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
4361 # populated.
4362 # different programming environments, including REST APIs and RPC APIs. It is
4363 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4364 # three pieces of data: error code, error message, and error details.
4365 #
4366 # You can find out more about this error model and how to work with it in the
4367 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4368 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4369 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4370 # message types for APIs to use.
4371 {
4372 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4373 },
4374 ],
4375 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4376 # user-facing error message should be localized and sent in the
4377 # google.rpc.Status.details field, or localized by the client.
4378 },
4379 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4380 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4381 },
4382 },
4383 },
4384 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4385 # This value is inRFC3339
4386 # text format.
4387 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4388 # following:
4389 # `PENDING`, `RUNNING`, or `DONE`.
4390 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4391 # operation.
4392 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4393 # of the target resource.
4394 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4395 # operations related to creating a snapshot, this points to the disk
4396 # that the snapshot was created from.
4397 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4398 # `[email protected]` or
4399 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4400 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4401 # operation, this field will be populated.
4402 {
4403 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4404 # Engine returns NO_RESULTS_ON_PAGE if there
4405 # are no results in the response.
4406 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4407 # value format. For example:
4408 #
4409 # &quot;data&quot;: [
4410 # {
4411 # &quot;key&quot;: &quot;scope&quot;,
4412 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4413 # }
4414 {
4415 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4416 # returned. For example, for warnings where there are no results in a list
4417 # request for a particular zone, this key might be scope and
4418 # the key value might be the zone name. Other examples might be a key
4419 # indicating a deprecated resource and a suggested replacement, or a
4420 # warning about invalid network settings (for example, if an instance
4421 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4422 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4423 },
4424 ],
4425 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4426 },
4427 ],
4428 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4429 # applicable when performing per-zone operations.
4430 }</pre>
4431 </div>
4432
4433 <div class="method">
4434 <code class="details" id="list">list(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)</code>
4435 <pre>Lists all the policies that have been configured for the specified
4436 folder or organization.
4437
4438 Args:
4439 filter: string, A filter expression that filters resources listed in the response. Most
4440 Compute resources support two types of filter expressions:
4441 expressions that support regular expressions and expressions that follow
4442 API improvement proposal AIP-160.
4443 These two types of filter expressions cannot be mixed in one request.
4444
4445 If you want to use AIP-160, your expression must specify the field name, an
4446 operator, and the value that you want to use for filtering. The value
4447 must be a string, a number, or a boolean. The operator
4448 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4449
4450 For example, if you are filtering Compute Engine instances, you can
4451 exclude instances named `example-instance` by specifying
4452 `name != example-instance`.
4453
4454 The `:*` comparison can be used to test whether a key has been defined.
4455 For example, to find all objects with `owner` label use:
4456 ```
4457 labels.owner:*
4458 ```
4459
4460 You can also filter nested fields. For example, you could specify
4461 `scheduling.automaticRestart = false` to include instances only
4462 if they are not scheduled for automatic restarts. You can use filtering
4463 on nested fields to filter based onresource labels.
4464
4465 To filter on multiple expressions, provide each separate expression within
4466 parentheses. For example:
4467 ```
4468 (scheduling.automaticRestart = true)
4469 (cpuPlatform = &quot;Intel Skylake&quot;)
4470 ```
4471 By default, each expression is an `AND` expression. However, you
4472 can include `AND` and `OR` expressions explicitly.
4473 For example:
4474 ```
4475 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4476 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4477 (scheduling.automaticRestart = true)
4478 ```
4479
4480 If you want to use a regular expression, use the `eq` (equal) or `ne`
4481 (not equal) operator against a single un-parenthesized expression with or
4482 without quotes or against multiple parenthesized expressions. Examples:
4483
4484 `fieldname eq unquoted literal`
4485 `fieldname eq &#x27;single quoted literal&#x27;`
4486 `fieldname eq &quot;double quoted literal&quot;`
4487 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4488
4489 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4490 The literal value must match the entire field.
4491
4492 For example, to filter for instances that do not end with name &quot;instance&quot;,
4493 you would use `name ne .*instance`.
4494
4495 You cannot combine constraints on multiple fields using regular
4496 expressions.
4497 maxResults: integer, The maximum number of results per page that should be returned.
4498 If the number of available results is larger than `maxResults`,
4499 Compute Engine returns a `nextPageToken` that can be used to get
4500 the next page of results in subsequent list requests. Acceptable values are
4501 `0` to `500`, inclusive. (Default: `500`)
4502 orderBy: string, Sorts list results by a certain order. By default, results
4503 are returned in alphanumerical order based on the resource name.
4504
4505 You can also sort results in descending order based on the creation
4506 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4507 results based on the `creationTimestamp` field in
4508 reverse chronological order (newest result first). Use this to sort
4509 resources like operations so that the newest operation is returned first.
4510
4511 Currently, only sorting by `name` or
4512 `creationTimestamp desc` is supported.
4513 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4514 `nextPageToken` returned by a previous list request to get
4515 the next page of results.
4516 parentId: string, Parent ID for this request. The ID can be either be &quot;folders/[FOLDER_ID]&quot;
4517 if the parent is a folder or &quot;organizations/[ORGANIZATION_ID]&quot; if the
4518 parent is an organization.
4519 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4520 of failure. The default value is false.
4521
4522 For example, when partial success behavior is enabled, aggregatedList for a
4523 single zone scope either returns all resources in the zone or no resources,
4524 with an error code.
4525 x__xgafv: string, V1 error format.
4526 Allowed values
4527 1 - v1 error format
4528 2 - v2 error format
4529
4530 Returns:
4531 An object of the form:
4532
4533 {
4534 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4535 &quot;items&quot;: [ # A list of FirewallPolicy resources.
4536 { # Represents a Firewall Policy resource.
4537 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
4538 {
4539 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
4540 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
4541 # of the firewall policy of the association.
4542 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
4543 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
4544 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
4545 # must be a positive value between 1 and 2147483647.
4546 # Firewall Policies are evaluated from highest to lowest priority where 1
4547 # is the highest priority and 2147483647 is the lowest priority.
4548 # The default value is `1000`. If two associations have the same priority
4549 # then lexicographical order on association names is applied.
4550 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
4551 },
4552 ],
4553 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4554 # text format.
4555 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4556 # create the resource.
4557 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
4558 # Organization firewall policy. The name should be unique in the organization
4559 # in which the firewall policy is created.
4560 # This field is not applicable to network firewall policies.
4561 # This name must be set on creation and cannot be changed.
4562 # The name must be 1-63 characters long, and comply
4563 # with RFC1035. Specifically, the name must be 1-63 characters
4564 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
4565 # means the first character must be a lowercase letter, and all following
4566 # characters must be a dash, lowercase letter, or digit, except the last
4567 # character, which cannot be a dash.
4568 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
4569 # the metadata&#x27;s contents and used for optimistic locking. The
4570 # fingerprint is initially generated by Compute Engine and changes after
4571 # every request to modify or update metadata. You must always provide an
4572 # up-to-date fingerprint hash in order to update or change metadata,
4573 # otherwise the request will fail with error412 conditionNotMet.
4574 #
4575 # To see the latest fingerprint, make get() request to the
4576 # firewall policy.
4577 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4578 # defined by the server.
4579 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
4580 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
4581 # [Output Only] numeric ID allocated by Google Cloud which uniquely
4582 # identifies the Organization Firewall Policy.
4583 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
4584 { # Represents a rule that describes one or more match conditions along with
4585 # the action to be taken when traffic matches this condition (allow or deny).
4586 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
4587 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
4588 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
4589 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
4590 # and &quot;goto_next&quot;.
4591 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
4592 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
4593 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
4594 # the firewall policy rule is not enforced and traffic behaves as if it did
4595 # not exist. If this is unspecified, the firewall policy rule will be
4596 # enabled.
4597 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4598 # enabled, logs will be exported to the configured export destination in
4599 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4600 # cannot enable logging on &quot;goto_next&quot; rules.
4601 &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.
4602 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4603 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4604 # Exactly one field must be specified.
4605 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
4606 # Maximum number of destination address groups is 10.
4607 &quot;A String&quot;,
4608 ],
4609 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4610 # traffic destination.
4611 # Maximum number of destination fqdn allowed is 100.
4612 &quot;A String&quot;,
4613 ],
4614 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4615 # Maximum number of destination CIDR IP ranges allowed is 5000.
4616 &quot;A String&quot;,
4617 ],
4618 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
4619 #
4620 #
4621 # - UNSPECIFIED
4622 # - INTERNET
4623 # - NON_INTERNET
4624 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
4625 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
4626 #
4627 #
4628 # - UNSPECIFIED
4629 # - INTERNET
4630 # - NON_INTERNET
4631 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
4632 # of traffic. Should be specified as 2 letter country code defined as per
4633 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4634 # Maximum number of dest region codes allowed is 5000.
4635 &quot;A String&quot;,
4636 ],
4637 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4638 # The IPs in these lists will be matched against traffic destination.
4639 &quot;A String&quot;,
4640 ],
4641 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4642 {
4643 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4644 # required when creating a firewall rule. This value can either be
4645 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4646 # protocol number.
4647 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4648 # only applicable for UDP or TCP protocol. Each entry must be either
4649 # an integer or a range. If not specified, this rule applies to
4650 # connections through any port.
4651 #
4652 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4653 &quot;A String&quot;,
4654 ],
4655 },
4656 ],
4657 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4658 # Maximum number of source address groups is 10.
4659 &quot;A String&quot;,
4660 ],
4661 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4662 # traffic source.
4663 # Maximum number of source fqdn allowed is 100.
4664 &quot;A String&quot;,
4665 ],
4666 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4667 # Maximum number of source CIDR IP ranges allowed is 5000.
4668 &quot;A String&quot;,
4669 ],
4670 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4671 #
4672 #
4673 # - UNSPECIFIED
4674 # - INTERNET
4675 # - INTRA_VPC
4676 # - NON_INTERNET
4677 # - VPC_NETWORKS
4678 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4679 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4680 #
4681 #
4682 # - UNSPECIFIED
4683 # - INTERNET
4684 # - INTRA_VPC
4685 # - NON_INTERNET
4686 # - VPC_NETWORKS
4687 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4688 &quot;A String&quot;,
4689 ],
4690 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4691 # of traffic. Should be specified as 2 letter country code defined as per
4692 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4693 # Maximum number of source region codes allowed is 5000.
4694 &quot;A String&quot;,
4695 ],
4696 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4697 # of the traffic.
4698 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4699 # and there is no srcIpRange, this rule will be ignored.
4700 # Maximum number of source tag values allowed is 256.
4701 {
4702 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4703 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4704 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4705 # or its network is deleted.
4706 },
4707 ],
4708 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4709 # The IPs in these lists will be matched against traffic source.
4710 &quot;A String&quot;,
4711 ],
4712 },
4713 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4714 # must be a positive value between 0 and 2147483647.
4715 # Rules are evaluated from highest to lowest priority where 0 is the
4716 # highest priority and 2147483647 is the lowest priority.
4717 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4718 # and can be updated.
4719 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4720 # rule.
4721 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4722 # Example:
4723 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4724 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4725 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4726 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4727 # This field allows you to control which load balancers get this rule.
4728 # For example, the following are valid values:
4729 #
4730 #
4731 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4732 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4733 # - projects/project/global/
4734 # forwardingRules/forwardingRule
4735 # - projects/project/regions/region/forwardingRules/
4736 # forwardingRule
4737 &quot;A String&quot;,
4738 ],
4739 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4740 # allows you to control which network&#x27;s VMs get this rule. If this field
4741 # is left blank, all VMs within the organization will receive the rule.
4742 &quot;A String&quot;,
4743 ],
4744 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4745 # applies to. If targetSecureTag are specified, then the
4746 # firewall rule applies only to instances in the VPC network that have one
4747 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4748 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
4749 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
4750 # to all instances on the specified network.
4751 # Maximum number of target label tags allowed is 256.
4752 {
4753 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4754 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4755 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4756 # or its network is deleted.
4757 },
4758 ],
4759 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4760 # applied with this rule.
4761 &quot;A String&quot;,
4762 ],
4763 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
4764 # Default value is INSTANCES.
4765 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
4766 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
4767 # be set for other actions.
4768 },
4769 ],
4770 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
4771 # This field is not applicable to network firewall policies.
4772 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
4773 # creation and defaults to USER_DEFINED.
4774 #
4775 # The USER_DEFINED value indicates a regular firewall policy.
4776 #
4777 # The SYSTEM value indicates a system-level policy managed by an
4778 # internal service like GKE. This SYSTEM value is reserved for
4779 # internal services and cannot be set by users during policy creation.
4780 # Policies with a SYSTEM source cannot be modified or deleted by
4781 # users.
4782 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
4783 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
4784 #
4785 # Note: if not specified then VPC_POLICY will be used.
4786 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
4787 # This field is not applicable to global firewall policies.
4788 # You must specify this field as part of the HTTP request URL. It is
4789 # not settable as a field in the request body.
4790 &quot;rolloutOperation&quot;: { # Represents progressive rollout input parameters and current status. # Configuration and status of the progressive rollout of this resource.
4791 &quot;rolloutInput&quot;: { # Represents progressive rollout input parameters. # Input parameters to be used by the next not yet scheduled rollout.
4792 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan. Ex.
4793 # organizations//locations/global/rolloutPlans/.
4794 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
4795 &quot;retryUuid&quot;: &quot;A String&quot;, # The UUID of the retry action. Only needed if this is a retry for an
4796 # existing rollout. This can be used after the user canceled a rollout
4797 # and want to retry it with no changes.
4798 },
4799 &quot;rolloutStatus&quot;: { # Represents progressive rollout current status. # [Output only] Current status of the rollout.
4800 &quot;nextRollout&quot;: { # [Output only] The next rollout.
4801 &quot;rolloutId&quot;: &quot;A String&quot;, # Output only. [Output only] The id of the next rollout.
4802 &quot;rolloutPlan&quot;: &quot;A String&quot;, # The name of the rollout plan to be used by the next not yet started
4803 # rollout. This field is auto populated based on RolloutInput when a
4804 # new rollout is scheduled. This can be manually changed before the
4805 # scheduled rollout starts.
4806 # Ex.
4807 # organizations//locations/global/rolloutPlans/
4808 },
4809 &quot;ongoingRollouts&quot;: [ # [Output only] The ongoing rollout.
4810 { # Represents the status of the progressive rollout instance, either
4811 # completed or ongoing.
4812 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
4813 # organizations//locations/global/rollouts/
4814 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
4815 # organizations//locations/global/rolloutPlans/
4816 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
4817 },
4818 ],
4819 &quot;previousRollout&quot;: { # Represents the status of the progressive rollout instance, either # [Output only] The last previously executed rollout.
4820 # completed or ongoing.
4821 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
4822 # organizations//locations/global/rollouts/
4823 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
4824 # organizations//locations/global/rolloutPlans/
4825 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
4826 },
4827 },
4828 },
4829 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
4830 # policy can not exceed a set number of tuples.
4831 &quot;rules&quot;: [ # A list of rules that belong to this policy.
4832 # There must always be a default rule (rule with priority 2147483647 and
4833 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
4834 # default rule with action &quot;allow&quot; will be added.
4835 { # Represents a rule that describes one or more match conditions along with
4836 # the action to be taken when traffic matches this condition (allow or deny).
4837 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
4838 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
4839 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
4840 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
4841 # and &quot;goto_next&quot;.
4842 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
4843 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
4844 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
4845 # the firewall policy rule is not enforced and traffic behaves as if it did
4846 # not exist. If this is unspecified, the firewall policy rule will be
4847 # enabled.
4848 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4849 # enabled, logs will be exported to the configured export destination in
4850 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4851 # cannot enable logging on &quot;goto_next&quot; rules.
4852 &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.
4853 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4854 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4855 # Exactly one field must be specified.
4856 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
4857 # Maximum number of destination address groups is 10.
4858 &quot;A String&quot;,
4859 ],
4860 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4861 # traffic destination.
4862 # Maximum number of destination fqdn allowed is 100.
4863 &quot;A String&quot;,
4864 ],
4865 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4866 # Maximum number of destination CIDR IP ranges allowed is 5000.
4867 &quot;A String&quot;,
4868 ],
4869 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
4870 #
4871 #
4872 # - UNSPECIFIED
4873 # - INTERNET
4874 # - NON_INTERNET
4875 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
4876 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
4877 #
4878 #
4879 # - UNSPECIFIED
4880 # - INTERNET
4881 # - NON_INTERNET
4882 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
4883 # of traffic. Should be specified as 2 letter country code defined as per
4884 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4885 # Maximum number of dest region codes allowed is 5000.
4886 &quot;A String&quot;,
4887 ],
4888 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4889 # The IPs in these lists will be matched against traffic destination.
4890 &quot;A String&quot;,
4891 ],
4892 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4893 {
4894 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4895 # required when creating a firewall rule. This value can either be
4896 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4897 # protocol number.
4898 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4899 # only applicable for UDP or TCP protocol. Each entry must be either
4900 # an integer or a range. If not specified, this rule applies to
4901 # connections through any port.
4902 #
4903 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4904 &quot;A String&quot;,
4905 ],
4906 },
4907 ],
4908 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
4909 # Maximum number of source address groups is 10.
4910 &quot;A String&quot;,
4911 ],
4912 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
4913 # traffic source.
4914 # Maximum number of source fqdn allowed is 100.
4915 &quot;A String&quot;,
4916 ],
4917 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4918 # Maximum number of source CIDR IP ranges allowed is 5000.
4919 &quot;A String&quot;,
4920 ],
4921 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
4922 #
4923 #
4924 # - UNSPECIFIED
4925 # - INTERNET
4926 # - INTRA_VPC
4927 # - NON_INTERNET
4928 # - VPC_NETWORKS
4929 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
4930 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
4931 #
4932 #
4933 # - UNSPECIFIED
4934 # - INTERNET
4935 # - INTRA_VPC
4936 # - NON_INTERNET
4937 # - VPC_NETWORKS
4938 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
4939 &quot;A String&quot;,
4940 ],
4941 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
4942 # of traffic. Should be specified as 2 letter country code defined as per
4943 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
4944 # Maximum number of source region codes allowed is 5000.
4945 &quot;A String&quot;,
4946 ],
4947 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
4948 # of the traffic.
4949 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
4950 # and there is no srcIpRange, this rule will be ignored.
4951 # Maximum number of source tag values allowed is 256.
4952 {
4953 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
4954 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
4955 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
4956 # or its network is deleted.
4957 },
4958 ],
4959 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
4960 # The IPs in these lists will be matched against traffic source.
4961 &quot;A String&quot;,
4962 ],
4963 },
4964 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4965 # must be a positive value between 0 and 2147483647.
4966 # Rules are evaluated from highest to lowest priority where 0 is the
4967 # highest priority and 2147483647 is the lowest priority.
4968 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
4969 # and can be updated.
4970 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
4971 # rule.
4972 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
4973 # Example:
4974 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
4975 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
4976 # &#x27;mirror&#x27;. Cannot be specified for other actions.
4977 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
4978 # This field allows you to control which load balancers get this rule.
4979 # For example, the following are valid values:
4980 #
4981 #
4982 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
4983 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
4984 # - projects/project/global/
4985 # forwardingRules/forwardingRule
4986 # - projects/project/regions/region/forwardingRules/
4987 # forwardingRule
4988 &quot;A String&quot;,
4989 ],
4990 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4991 # allows you to control which network&#x27;s VMs get this rule. If this field
4992 # is left blank, all VMs within the organization will receive the rule.
4993 &quot;A String&quot;,
4994 ],
4995 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
4996 # applies to. If targetSecureTag are specified, then the
4997 # firewall rule applies only to instances in the VPC network that have one
4998 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
4999 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5000 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5001 # to all instances on the specified network.
5002 # Maximum number of target label tags allowed is 256.
5003 {
5004 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5005 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5006 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5007 # or its network is deleted.
5008 },
5009 ],
5010 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5011 # applied with this rule.
5012 &quot;A String&quot;,
5013 ],
5014 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5015 # Default value is INSTANCES.
5016 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5017 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5018 # be set for other actions.
5019 },
5020 ],
5021 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5022 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5023 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
5024 # unique in the organization in which the firewall policy is created.
5025 # This field is not applicable to network firewall policies.
5026 # This name must be set on creation and cannot be changed. The name must be
5027 # 1-63 characters long, and comply with RFC1035.
5028 # Specifically, the name must be 1-63 characters long and match the regular
5029 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5030 # character must be a lowercase letter, and all following characters must
5031 # be a dash, lowercase letter, or digit, except the last character, which
5032 # cannot be a dash.
5033 &quot;vpcNetworkScope&quot;: &quot;A String&quot;, # The scope of networks allowed to be associated with the firewall
5034 # policy. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.
5035 #
5036 # A firewall policy with the VPC scope set to GLOBAL_VPC_NETWORK
5037 # is allowed to be attached only to global networks.
5038 #
5039 # When the VPC scope is set to REGIONAL_VPC_NETWORK the firewall
5040 # policy is allowed to be attached only to regional networks in the same
5041 # scope as the firewall policy.
5042 #
5043 # Note: if not specified then GLOBAL_VPC_NETWORK will be used.
5044 },
5045 ],
5046 &quot;kind&quot;: &quot;compute#firewallPolicyList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#firewallPolicyList for listsof FirewallPolicies
5047 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5048 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5049 # the query parameter pageToken in the next list request.
5050 # Subsequent list requests will have their own nextPageToken to
5051 # continue paging through the results.
5052 &quot;warning&quot;: { # [Output Only] Informational warning message.
5053 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5054 # Engine returns NO_RESULTS_ON_PAGE if there
5055 # are no results in the response.
5056 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5057 # value format. For example:
5058 #
5059 # &quot;data&quot;: [
5060 # {
5061 # &quot;key&quot;: &quot;scope&quot;,
5062 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5063 # }
5064 {
5065 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5066 # returned. For example, for warnings where there are no results in a list
5067 # request for a particular zone, this key might be scope and
5068 # the key value might be the zone name. Other examples might be a key
5069 # indicating a deprecated resource and a suggested replacement, or a
5070 # warning about invalid network settings (for example, if an instance
5071 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5072 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5073 },
5074 ],
5075 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5076 },
5077 }</pre>
5078 </div>
5079
5080 <div class="method">
5081 <code class="details" id="listAssociations">listAssociations(includeInheritedPolicies=None, targetResource=None, x__xgafv=None)</code>
5082 <pre>Lists associations of a specified target, i.e., organization or folder.
5083
5084 Args:
5085 includeInheritedPolicies: boolean, If set to &quot;true&quot;, the response will contain a list of all associations for
5086 the containing folders and the containing organization of the target. The
5087 parameter has no effect if the target is an organization.
5088 targetResource: string, The target resource to list associations. It is an organization, or a
5089 folder.
5090 x__xgafv: string, V1 error format.
5091 Allowed values
5092 1 - v1 error format
5093 2 - v2 error format
5094
5095 Returns:
5096 An object of the form:
5097
5098 {
5099 &quot;associations&quot;: [ # A list of associations.
5100 {
5101 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
5102 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
5103 # of the firewall policy of the association.
5104 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
5105 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
5106 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
5107 # must be a positive value between 1 and 2147483647.
5108 # Firewall Policies are evaluated from highest to lowest priority where 1
5109 # is the highest priority and 2147483647 is the lowest priority.
5110 # The default value is `1000`. If two associations have the same priority
5111 # then lexicographical order on association names is applied.
5112 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
5113 },
5114 ],
5115 &quot;kind&quot;: &quot;compute#firewallPoliciesListAssociationsResponse&quot;, # Output only. [Output Only] Type of firewallPolicy associations. Alwayscompute#FirewallPoliciesListAssociations for lists of
5116 # firewallPolicy associations.
5117 }</pre>
5118 </div>
5119
5120 <div class="method">
5121 <code class="details" id="list_next">list_next()</code>
5122 <pre>Retrieves the next page of results.
5123
5124 Args:
5125 previous_request: The request for the previous page. (required)
5126 previous_response: The response from the request for the previous page. (required)
5127
5128 Returns:
5129 A request object that you can call &#x27;execute()&#x27; on to request the next
5130 page. Returns None if there are no more items in the collection.
5131 </pre>
5132 </div>
5133
5134 <div class="method">
5135 <code class="details" id="move">move(firewallPolicy, parentId=None, requestId=None, x__xgafv=None)</code>
5136 <pre>Moves the specified firewall policy.
5137
5138 Args:
5139 firewallPolicy: string, Name of the firewall policy to update. (required)
5140 parentId: string, The new parent of the firewall policy. The ID can be either be
5141 &quot;folders/[FOLDER_ID]&quot; if the parent is a folder or
5142 &quot;organizations/[ORGANIZATION_ID]&quot; if the parent is an organization.
5143 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5144 that if you must retry your request, the server will know to ignore the
5145 request if it has already been completed.
5146
5147 For example, consider a situation where you make an initial request and
5148 the request times out. If you make the request again with the same
5149 request ID, the server can check if original operation with the same
5150 request ID was received, and if so, will ignore the second request. This
5151 prevents clients from accidentally creating duplicate commitments.
5152
5153 The request ID must be
5154 a valid UUID with the exception that zero UUID is not supported
5155 (00000000-0000-0000-0000-000000000000).
5156 x__xgafv: string, V1 error format.
5157 Allowed values
5158 1 - v1 error format
5159 2 - v2 error format
5160
5161 Returns:
5162 An object of the form:
5163
5164 { # Represents an Operation resource.
5165 #
5166 # Google Compute Engine has three Operation resources:
5167 #
5168 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
5169 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
5170 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
5171 #
5172 # You can use an operation resource to manage asynchronous API requests.
5173 # For more information, readHandling
5174 # API responses.
5175 #
5176 # Operations can be global, regional or zonal.
5177 #
5178 # - For global operations, use the `globalOperations`
5179 # resource.
5180 # - For regional operations, use the
5181 # `regionOperations` resource.
5182 # - For zonal operations, use
5183 # the `zoneOperations` resource.
5184 #
5185 #
5186 #
5187 # For more information, read
5188 # Global, Regional, and Zonal Resources.
5189 #
5190 # Note that completed Operation resources have a limited
5191 # retention period.
5192 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5193 # Not present otherwise.
5194 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5195 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5196 # set when the operation is created.
5197 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5198 # text format.
5199 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5200 # this field will be populated.
5201 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5202 # operation.
5203 {
5204 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5205 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5206 # details. There is a set of defined message types to use for providing
5207 # details.The syntax depends on the error code. For example,
5208 # QuotaExceededInfo will have details when the error code is
5209 # QUOTA_EXCEEDED.
5210 {
5211 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5212 #
5213 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5214 # is not enabled:
5215 #
5216 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5217 # &quot;domain&quot;: &quot;googleapis.com&quot;
5218 # &quot;metadata&quot;: {
5219 # &quot;resource&quot;: &quot;projects/123&quot;,
5220 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5221 # }
5222 # }
5223 #
5224 # This response indicates that the pubsub.googleapis.com API is not enabled.
5225 #
5226 # Example of an error that is returned when attempting to create a Spanner
5227 # instance in a region that is out of stock:
5228 #
5229 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5230 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5231 # &quot;metadata&quot;: {
5232 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5233 # }
5234 # }
5235 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5236 # is typically the registered service name of the tool or product that
5237 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5238 # generated by some common infrastructure, the error domain must be a
5239 # globally unique value that identifies the infrastructure. For Google API
5240 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5241 &quot;metadatas&quot;: { # Additional structured details about this error.
5242 #
5243 # Keys must match a regular expression of `a-z+` but should
5244 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5245 # length. When identifying the current value of an exceeded limit, the units
5246 # should be contained in the key, not the value. For example, rather than
5247 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5248 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5249 # instances that can be created in a single (batch) request.
5250 &quot;a_key&quot;: &quot;A String&quot;,
5251 },
5252 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5253 # proximate cause of the error. Error reasons are unique within a particular
5254 # domain of errors. This should be at most 63 characters and match a
5255 # regular expression of `A-Z+[A-Z0-9]`, which represents
5256 # UPPER_SNAKE_CASE.
5257 },
5258 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5259 #
5260 # For example, if a quota check failed with an error indicating the calling
5261 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5262 # directly to the right place in the developer console to flip the bit.
5263 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5264 { # Describes a URL link.
5265 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5266 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5267 },
5268 ],
5269 },
5270 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5271 # which can be attached to an RPC error.
5272 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5273 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5274 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5275 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5276 },
5277 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5278 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5279 &quot;a_key&quot;: &quot;A String&quot;,
5280 },
5281 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5282 # type or metric.
5283 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5284 # or metric.
5285 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5286 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5287 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5288 },
5289 },
5290 ],
5291 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5292 # This property is optional.
5293 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5294 },
5295 ],
5296 },
5297 &quot;getVersionOperationMetadata&quot;: {
5298 &quot;inlineSbomInfo&quot;: {
5299 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5300 # appropriate identifiers.
5301 &quot;a_key&quot;: &quot;A String&quot;,
5302 },
5303 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5304 # identifiers.
5305 &quot;a_key&quot;: &quot;A String&quot;,
5306 },
5307 },
5308 },
5309 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5310 # message that was returned, such as `NOT FOUND`.
5311 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5312 # status code that was returned. For example, a `404` means the
5313 # resource was not found.
5314 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5315 # defined by the server.
5316 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5317 # This value is inRFC3339
5318 # text format.
5319 &quot;instancesBulkInsertOperationMetadata&quot;: {
5320 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5321 # Example key: zones/us-central1-a
5322 &quot;a_key&quot;: {
5323 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5324 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5325 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5326 # error.
5327 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5328 # if the flow is rolling forward or rolling back.
5329 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5330 },
5331 },
5332 },
5333 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5334 # Operation resources.
5335 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5336 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5337 # group of operations results from a `bulkInsert` API request.
5338 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5339 # `update`, or `delete`, and so on.
5340 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5341 # There is no requirement that this be linear or support any granularity of
5342 # operations. This should not be used to guess when the operation will be
5343 # complete. This number should monotonically increase as the operation
5344 # progresses.
5345 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5346 # applicable when performing regional operations.
5347 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5348 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5349 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5350 # this field will contain information on all underlying zonal actions and
5351 # their state.
5352 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5353 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5354 # Example key: zones/us-central1-a
5355 &quot;a_key&quot;: {
5356 &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
5357 # populated.
5358 # different programming environments, including REST APIs and RPC APIs. It is
5359 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5360 # three pieces of data: error code, error message, and error details.
5361 #
5362 # You can find out more about this error model and how to work with it in the
5363 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5364 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5365 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5366 # message types for APIs to use.
5367 {
5368 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5369 },
5370 ],
5371 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5372 # user-facing error message should be localized and sent in the
5373 # google.rpc.Status.details field, or localized by the client.
5374 },
5375 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5376 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5377 },
5378 },
5379 },
5380 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5381 # This value is inRFC3339
5382 # text format.
5383 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5384 # following:
5385 # `PENDING`, `RUNNING`, or `DONE`.
5386 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5387 # operation.
5388 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5389 # of the target resource.
5390 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5391 # operations related to creating a snapshot, this points to the disk
5392 # that the snapshot was created from.
5393 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5394 # `[email protected]` or
5395 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5396 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5397 # operation, this field will be populated.
5398 {
5399 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5400 # Engine returns NO_RESULTS_ON_PAGE if there
5401 # are no results in the response.
5402 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5403 # value format. For example:
5404 #
5405 # &quot;data&quot;: [
5406 # {
5407 # &quot;key&quot;: &quot;scope&quot;,
5408 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5409 # }
5410 {
5411 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5412 # returned. For example, for warnings where there are no results in a list
5413 # request for a particular zone, this key might be scope and
5414 # the key value might be the zone name. Other examples might be a key
5415 # indicating a deprecated resource and a suggested replacement, or a
5416 # warning about invalid network settings (for example, if an instance
5417 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5418 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5419 },
5420 ],
5421 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5422 },
5423 ],
5424 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5425 # applicable when performing per-zone operations.
5426 }</pre>
5427 </div>
5428
5429 <div class="method">
5430 <code class="details" id="patch">patch(firewallPolicy, body=None, requestId=None, x__xgafv=None)</code>
5431 <pre>Patches the specified policy with the data included in the request.
5432
5433 Args:
5434 firewallPolicy: string, Name of the firewall policy to update. (required)
5435 body: object, The request body.
5436 The object takes the form of:
5437
5438 { # Represents a Firewall Policy resource.
5439 &quot;associations&quot;: [ # A list of associations that belong to this firewall policy.
5440 {
5441 &quot;attachmentTarget&quot;: &quot;A String&quot;, # The target that the firewall policy is attached to.
5442 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name
5443 # of the firewall policy of the association.
5444 &quot;firewallPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The firewall policy ID of the association.
5445 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
5446 &quot;priority&quot;: 42, # An integer indicating the priority of an association. The priority
5447 # must be a positive value between 1 and 2147483647.
5448 # Firewall Policies are evaluated from highest to lowest priority where 1
5449 # is the highest priority and 2147483647 is the lowest priority.
5450 # The default value is `1000`. If two associations have the same priority
5451 # then lexicographical order on association names is applied.
5452 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy of the association.
5453 },
5454 ],
5455 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5456 # text format.
5457 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5458 # create the resource.
5459 &quot;displayName&quot;: &quot;A String&quot;, # Deprecated, please use short name instead. User-provided name of the
5460 # Organization firewall policy. The name should be unique in the organization
5461 # in which the firewall policy is created.
5462 # This field is not applicable to network firewall policies.
5463 # This name must be set on creation and cannot be changed.
5464 # The name must be 1-63 characters long, and comply
5465 # with RFC1035. Specifically, the name must be 1-63 characters
5466 # long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which
5467 # means the first character must be a lowercase letter, and all following
5468 # characters must be a dash, lowercase letter, or digit, except the last
5469 # character, which cannot be a dash.
5470 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
5471 # the metadata&#x27;s contents and used for optimistic locking. The
5472 # fingerprint is initially generated by Compute Engine and changes after
5473 # every request to modify or update metadata. You must always provide an
5474 # up-to-date fingerprint hash in order to update or change metadata,
5475 # otherwise the request will fail with error412 conditionNotMet.
5476 #
5477 # To see the latest fingerprint, make get() request to the
5478 # firewall policy.
5479 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5480 # defined by the server.
5481 &quot;kind&quot;: &quot;compute#firewallPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies
5482 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. For Organization Firewall Policies it&#x27;s a
5483 # [Output Only] numeric ID allocated by Google Cloud which uniquely
5484 # identifies the Organization Firewall Policy.
5485 &quot;packetMirroringRules&quot;: [ # A list of packet mirroring rules that belong to this policy.
5486 { # Represents a rule that describes one or more match conditions along with
5487 # the action to be taken when traffic matches this condition (allow or deny).
5488 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5489 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5490 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5491 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5492 # and &quot;goto_next&quot;.
5493 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5494 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5495 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5496 # the firewall policy rule is not enforced and traffic behaves as if it did
5497 # not exist. If this is unspecified, the firewall policy rule will be
5498 # enabled.
5499 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5500 # enabled, logs will be exported to the configured export destination in
5501 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5502 # cannot enable logging on &quot;goto_next&quot; rules.
5503 &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.
5504 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5505 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5506 # Exactly one field must be specified.
5507 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5508 # Maximum number of destination address groups is 10.
5509 &quot;A String&quot;,
5510 ],
5511 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5512 # traffic destination.
5513 # Maximum number of destination fqdn allowed is 100.
5514 &quot;A String&quot;,
5515 ],
5516 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5517 # Maximum number of destination CIDR IP ranges allowed is 5000.
5518 &quot;A String&quot;,
5519 ],
5520 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5521 #
5522 #
5523 # - UNSPECIFIED
5524 # - INTERNET
5525 # - NON_INTERNET
5526 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5527 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5528 #
5529 #
5530 # - UNSPECIFIED
5531 # - INTERNET
5532 # - NON_INTERNET
5533 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5534 # of traffic. Should be specified as 2 letter country code defined as per
5535 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5536 # Maximum number of dest region codes allowed is 5000.
5537 &quot;A String&quot;,
5538 ],
5539 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5540 # The IPs in these lists will be matched against traffic destination.
5541 &quot;A String&quot;,
5542 ],
5543 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5544 {
5545 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5546 # required when creating a firewall rule. This value can either be
5547 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5548 # protocol number.
5549 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5550 # only applicable for UDP or TCP protocol. Each entry must be either
5551 # an integer or a range. If not specified, this rule applies to
5552 # connections through any port.
5553 #
5554 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5555 &quot;A String&quot;,
5556 ],
5557 },
5558 ],
5559 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5560 # Maximum number of source address groups is 10.
5561 &quot;A String&quot;,
5562 ],
5563 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5564 # traffic source.
5565 # Maximum number of source fqdn allowed is 100.
5566 &quot;A String&quot;,
5567 ],
5568 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5569 # Maximum number of source CIDR IP ranges allowed is 5000.
5570 &quot;A String&quot;,
5571 ],
5572 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5573 #
5574 #
5575 # - UNSPECIFIED
5576 # - INTERNET
5577 # - INTRA_VPC
5578 # - NON_INTERNET
5579 # - VPC_NETWORKS
5580 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5581 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5582 #
5583 #
5584 # - UNSPECIFIED
5585 # - INTERNET
5586 # - INTRA_VPC
5587 # - NON_INTERNET
5588 # - VPC_NETWORKS
5589 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5590 &quot;A String&quot;,
5591 ],
5592 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5593 # of traffic. Should be specified as 2 letter country code defined as per
5594 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5595 # Maximum number of source region codes allowed is 5000.
5596 &quot;A String&quot;,
5597 ],
5598 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5599 # of the traffic.
5600 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5601 # and there is no srcIpRange, this rule will be ignored.
5602 # Maximum number of source tag values allowed is 256.
5603 {
5604 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5605 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5606 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5607 # or its network is deleted.
5608 },
5609 ],
5610 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5611 # The IPs in these lists will be matched against traffic source.
5612 &quot;A String&quot;,
5613 ],
5614 },
5615 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5616 # must be a positive value between 0 and 2147483647.
5617 # Rules are evaluated from highest to lowest priority where 0 is the
5618 # highest priority and 2147483647 is the lowest priority.
5619 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5620 # and can be updated.
5621 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5622 # rule.
5623 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5624 # Example:
5625 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5626 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5627 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5628 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5629 # This field allows you to control which load balancers get this rule.
5630 # For example, the following are valid values:
5631 #
5632 #
5633 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5634 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5635 # - projects/project/global/
5636 # forwardingRules/forwardingRule
5637 # - projects/project/regions/region/forwardingRules/
5638 # forwardingRule
5639 &quot;A String&quot;,
5640 ],
5641 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5642 # allows you to control which network&#x27;s VMs get this rule. If this field
5643 # is left blank, all VMs within the organization will receive the rule.
5644 &quot;A String&quot;,
5645 ],
5646 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5647 # applies to. If targetSecureTag are specified, then the
5648 # firewall rule applies only to instances in the VPC network that have one
5649 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5650 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5651 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5652 # to all instances on the specified network.
5653 # Maximum number of target label tags allowed is 256.
5654 {
5655 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5656 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5657 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5658 # or its network is deleted.
5659 },
5660 ],
5661 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5662 # applied with this rule.
5663 &quot;A String&quot;,
5664 ],
5665 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5666 # Default value is INSTANCES.
5667 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5668 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5669 # be set for other actions.
5670 },
5671 ],
5672 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the firewall policy.
5673 # This field is not applicable to network firewall policies.
5674 &quot;policySource&quot;: &quot;A String&quot;, # Indicates the source of this Firewall Policy. This field is optional on
5675 # creation and defaults to USER_DEFINED.
5676 #
5677 # The USER_DEFINED value indicates a regular firewall policy.
5678 #
5679 # The SYSTEM value indicates a system-level policy managed by an
5680 # internal service like GKE. This SYSTEM value is reserved for
5681 # internal services and cannot be set by users during policy creation.
5682 # Policies with a SYSTEM source cannot be modified or deleted by
5683 # users.
5684 &quot;policyType&quot;: &quot;A String&quot;, # The type of the firewall policy. This field can be one of
5685 # VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.
5686 #
5687 # Note: if not specified then VPC_POLICY will be used.
5688 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional firewall policy resides.
5689 # This field is not applicable to global firewall policies.
5690 # You must specify this field as part of the HTTP request URL. It is
5691 # not settable as a field in the request body.
5692 &quot;rolloutOperation&quot;: { # Represents progressive rollout input parameters and current status. # Configuration and status of the progressive rollout of this resource.
5693 &quot;rolloutInput&quot;: { # Represents progressive rollout input parameters. # Input parameters to be used by the next not yet scheduled rollout.
5694 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan. Ex.
5695 # organizations//locations/global/rolloutPlans/.
5696 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
5697 &quot;retryUuid&quot;: &quot;A String&quot;, # The UUID of the retry action. Only needed if this is a retry for an
5698 # existing rollout. This can be used after the user canceled a rollout
5699 # and want to retry it with no changes.
5700 },
5701 &quot;rolloutStatus&quot;: { # Represents progressive rollout current status. # [Output only] Current status of the rollout.
5702 &quot;nextRollout&quot;: { # [Output only] The next rollout.
5703 &quot;rolloutId&quot;: &quot;A String&quot;, # Output only. [Output only] The id of the next rollout.
5704 &quot;rolloutPlan&quot;: &quot;A String&quot;, # The name of the rollout plan to be used by the next not yet started
5705 # rollout. This field is auto populated based on RolloutInput when a
5706 # new rollout is scheduled. This can be manually changed before the
5707 # scheduled rollout starts.
5708 # Ex.
5709 # organizations//locations/global/rolloutPlans/
5710 },
5711 &quot;ongoingRollouts&quot;: [ # [Output only] The ongoing rollout.
5712 { # Represents the status of the progressive rollout instance, either
5713 # completed or ongoing.
5714 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
5715 # organizations//locations/global/rollouts/
5716 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
5717 # organizations//locations/global/rolloutPlans/
5718 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
5719 },
5720 ],
5721 &quot;previousRollout&quot;: { # Represents the status of the progressive rollout instance, either # [Output only] The last previously executed rollout.
5722 # completed or ongoing.
5723 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout
5724 # organizations//locations/global/rollouts/
5725 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output only] The name of the rollout plan used by this rollout
5726 # organizations//locations/global/rolloutPlans/
5727 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output only] The state of the rollout.
5728 },
5729 },
5730 },
5731 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall
5732 # policy can not exceed a set number of tuples.
5733 &quot;rules&quot;: [ # A list of rules that belong to this policy.
5734 # There must always be a default rule (rule with priority 2147483647 and
5735 # match &quot;*&quot;). If no rules are provided when creating a firewall policy, a
5736 # default rule with action &quot;allow&quot; will be added.
5737 { # Represents a rule that describes one or more match conditions along with
5738 # the action to be taken when traffic matches this condition (allow or deny).
5739 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
5740 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
5741 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
5742 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
5743 # and &quot;goto_next&quot;.
5744 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
5745 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
5746 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
5747 # the firewall policy rule is not enforced and traffic behaves as if it did
5748 # not exist. If this is unspecified, the firewall policy rule will be
5749 # enabled.
5750 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5751 # enabled, logs will be exported to the configured export destination in
5752 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5753 # cannot enable logging on &quot;goto_next&quot; rules.
5754 &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.
5755 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5756 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5757 # Exactly one field must be specified.
5758 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
5759 # Maximum number of destination address groups is 10.
5760 &quot;A String&quot;,
5761 ],
5762 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5763 # traffic destination.
5764 # Maximum number of destination fqdn allowed is 100.
5765 &quot;A String&quot;,
5766 ],
5767 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5768 # Maximum number of destination CIDR IP ranges allowed is 5000.
5769 &quot;A String&quot;,
5770 ],
5771 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
5772 #
5773 #
5774 # - UNSPECIFIED
5775 # - INTERNET
5776 # - NON_INTERNET
5777 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
5778 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
5779 #
5780 #
5781 # - UNSPECIFIED
5782 # - INTERNET
5783 # - NON_INTERNET
5784 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
5785 # of traffic. Should be specified as 2 letter country code defined as per
5786 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5787 # Maximum number of dest region codes allowed is 5000.
5788 &quot;A String&quot;,
5789 ],
5790 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5791 # The IPs in these lists will be matched against traffic destination.
5792 &quot;A String&quot;,
5793 ],
5794 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5795 {
5796 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5797 # required when creating a firewall rule. This value can either be
5798 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5799 # protocol number.
5800 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5801 # only applicable for UDP or TCP protocol. Each entry must be either
5802 # an integer or a range. If not specified, this rule applies to
5803 # connections through any port.
5804 #
5805 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5806 &quot;A String&quot;,
5807 ],
5808 },
5809 ],
5810 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
5811 # Maximum number of source address groups is 10.
5812 &quot;A String&quot;,
5813 ],
5814 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
5815 # traffic source.
5816 # Maximum number of source fqdn allowed is 100.
5817 &quot;A String&quot;,
5818 ],
5819 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5820 # Maximum number of source CIDR IP ranges allowed is 5000.
5821 &quot;A String&quot;,
5822 ],
5823 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
5824 #
5825 #
5826 # - UNSPECIFIED
5827 # - INTERNET
5828 # - INTRA_VPC
5829 # - NON_INTERNET
5830 # - VPC_NETWORKS
5831 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
5832 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
5833 #
5834 #
5835 # - UNSPECIFIED
5836 # - INTERNET
5837 # - INTRA_VPC
5838 # - NON_INTERNET
5839 # - VPC_NETWORKS
5840 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
5841 &quot;A String&quot;,
5842 ],
5843 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
5844 # of traffic. Should be specified as 2 letter country code defined as per
5845 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
5846 # Maximum number of source region codes allowed is 5000.
5847 &quot;A String&quot;,
5848 ],
5849 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
5850 # of the traffic.
5851 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
5852 # and there is no srcIpRange, this rule will be ignored.
5853 # Maximum number of source tag values allowed is 256.
5854 {
5855 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5856 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5857 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5858 # or its network is deleted.
5859 },
5860 ],
5861 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
5862 # The IPs in these lists will be matched against traffic source.
5863 &quot;A String&quot;,
5864 ],
5865 },
5866 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5867 # must be a positive value between 0 and 2147483647.
5868 # Rules are evaluated from highest to lowest priority where 0 is the
5869 # highest priority and 2147483647 is the lowest priority.
5870 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
5871 # and can be updated.
5872 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
5873 # rule.
5874 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
5875 # Example:
5876 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
5877 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
5878 # &#x27;mirror&#x27;. Cannot be specified for other actions.
5879 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
5880 # This field allows you to control which load balancers get this rule.
5881 # For example, the following are valid values:
5882 #
5883 #
5884 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
5885 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
5886 # - projects/project/global/
5887 # forwardingRules/forwardingRule
5888 # - projects/project/regions/region/forwardingRules/
5889 # forwardingRule
5890 &quot;A String&quot;,
5891 ],
5892 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5893 # allows you to control which network&#x27;s VMs get this rule. If this field
5894 # is left blank, all VMs within the organization will receive the rule.
5895 &quot;A String&quot;,
5896 ],
5897 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
5898 # applies to. If targetSecureTag are specified, then the
5899 # firewall rule applies only to instances in the VPC network that have one
5900 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
5901 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
5902 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
5903 # to all instances on the specified network.
5904 # Maximum number of target label tags allowed is 256.
5905 {
5906 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
5907 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
5908 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
5909 # or its network is deleted.
5910 },
5911 ],
5912 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5913 # applied with this rule.
5914 &quot;A String&quot;,
5915 ],
5916 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
5917 # Default value is INSTANCES.
5918 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
5919 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
5920 # be set for other actions.
5921 },
5922 ],
5923 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5924 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5925 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the Organization firewall policy. The name should be
5926 # unique in the organization in which the firewall policy is created.
5927 # This field is not applicable to network firewall policies.
5928 # This name must be set on creation and cannot be changed. The name must be
5929 # 1-63 characters long, and comply with RFC1035.
5930 # Specifically, the name must be 1-63 characters long and match the regular
5931 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5932 # character must be a lowercase letter, and all following characters must
5933 # be a dash, lowercase letter, or digit, except the last character, which
5934 # cannot be a dash.
5935 &quot;vpcNetworkScope&quot;: &quot;A String&quot;, # The scope of networks allowed to be associated with the firewall
5936 # policy. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.
5937 #
5938 # A firewall policy with the VPC scope set to GLOBAL_VPC_NETWORK
5939 # is allowed to be attached only to global networks.
5940 #
5941 # When the VPC scope is set to REGIONAL_VPC_NETWORK the firewall
5942 # policy is allowed to be attached only to regional networks in the same
5943 # scope as the firewall policy.
5944 #
5945 # Note: if not specified then GLOBAL_VPC_NETWORK will be used.
5946 }
5947
5948 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5949 that if you must retry your request, the server will know to ignore the
5950 request if it has already been completed.
5951
5952 For example, consider a situation where you make an initial request and
5953 the request times out. If you make the request again with the same
5954 request ID, the server can check if original operation with the same
5955 request ID was received, and if so, will ignore the second request. This
5956 prevents clients from accidentally creating duplicate commitments.
5957
5958 The request ID must be
5959 a valid UUID with the exception that zero UUID is not supported
5960 (00000000-0000-0000-0000-000000000000).
5961 x__xgafv: string, V1 error format.
5962 Allowed values
5963 1 - v1 error format
5964 2 - v2 error format
5965
5966 Returns:
5967 An object of the form:
5968
5969 { # Represents an Operation resource.
5970 #
5971 # Google Compute Engine has three Operation resources:
5972 #
5973 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
5974 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
5975 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
5976 #
5977 # You can use an operation resource to manage asynchronous API requests.
5978 # For more information, readHandling
5979 # API responses.
5980 #
5981 # Operations can be global, regional or zonal.
5982 #
5983 # - For global operations, use the `globalOperations`
5984 # resource.
5985 # - For regional operations, use the
5986 # `regionOperations` resource.
5987 # - For zonal operations, use
5988 # the `zoneOperations` resource.
5989 #
5990 #
5991 #
5992 # For more information, read
5993 # Global, Regional, and Zonal Resources.
5994 #
5995 # Note that completed Operation resources have a limited
5996 # retention period.
5997 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5998 # Not present otherwise.
5999 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6000 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6001 # set when the operation is created.
6002 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6003 # text format.
6004 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6005 # this field will be populated.
6006 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6007 # operation.
6008 {
6009 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6010 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6011 # details. There is a set of defined message types to use for providing
6012 # details.The syntax depends on the error code. For example,
6013 # QuotaExceededInfo will have details when the error code is
6014 # QUOTA_EXCEEDED.
6015 {
6016 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6017 #
6018 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6019 # is not enabled:
6020 #
6021 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6022 # &quot;domain&quot;: &quot;googleapis.com&quot;
6023 # &quot;metadata&quot;: {
6024 # &quot;resource&quot;: &quot;projects/123&quot;,
6025 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6026 # }
6027 # }
6028 #
6029 # This response indicates that the pubsub.googleapis.com API is not enabled.
6030 #
6031 # Example of an error that is returned when attempting to create a Spanner
6032 # instance in a region that is out of stock:
6033 #
6034 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6035 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6036 # &quot;metadata&quot;: {
6037 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6038 # }
6039 # }
6040 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6041 # is typically the registered service name of the tool or product that
6042 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6043 # generated by some common infrastructure, the error domain must be a
6044 # globally unique value that identifies the infrastructure. For Google API
6045 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6046 &quot;metadatas&quot;: { # Additional structured details about this error.
6047 #
6048 # Keys must match a regular expression of `a-z+` but should
6049 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6050 # length. When identifying the current value of an exceeded limit, the units
6051 # should be contained in the key, not the value. For example, rather than
6052 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6053 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6054 # instances that can be created in a single (batch) request.
6055 &quot;a_key&quot;: &quot;A String&quot;,
6056 },
6057 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6058 # proximate cause of the error. Error reasons are unique within a particular
6059 # domain of errors. This should be at most 63 characters and match a
6060 # regular expression of `A-Z+[A-Z0-9]`, which represents
6061 # UPPER_SNAKE_CASE.
6062 },
6063 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6064 #
6065 # For example, if a quota check failed with an error indicating the calling
6066 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6067 # directly to the right place in the developer console to flip the bit.
6068 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6069 { # Describes a URL link.
6070 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6071 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6072 },
6073 ],
6074 },
6075 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6076 # which can be attached to an RPC error.
6077 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6078 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6079 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6080 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6081 },
6082 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6083 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6084 &quot;a_key&quot;: &quot;A String&quot;,
6085 },
6086 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6087 # type or metric.
6088 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6089 # or metric.
6090 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6091 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6092 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6093 },
6094 },
6095 ],
6096 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6097 # This property is optional.
6098 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6099 },
6100 ],
6101 },
6102 &quot;getVersionOperationMetadata&quot;: {
6103 &quot;inlineSbomInfo&quot;: {
6104 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6105 # appropriate identifiers.
6106 &quot;a_key&quot;: &quot;A String&quot;,
6107 },
6108 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6109 # identifiers.
6110 &quot;a_key&quot;: &quot;A String&quot;,
6111 },
6112 },
6113 },
6114 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6115 # message that was returned, such as `NOT FOUND`.
6116 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6117 # status code that was returned. For example, a `404` means the
6118 # resource was not found.
6119 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6120 # defined by the server.
6121 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6122 # This value is inRFC3339
6123 # text format.
6124 &quot;instancesBulkInsertOperationMetadata&quot;: {
6125 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6126 # Example key: zones/us-central1-a
6127 &quot;a_key&quot;: {
6128 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6129 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6130 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6131 # error.
6132 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6133 # if the flow is rolling forward or rolling back.
6134 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6135 },
6136 },
6137 },
6138 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6139 # Operation resources.
6140 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6141 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6142 # group of operations results from a `bulkInsert` API request.
6143 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6144 # `update`, or `delete`, and so on.
6145 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6146 # There is no requirement that this be linear or support any granularity of
6147 # operations. This should not be used to guess when the operation will be
6148 # complete. This number should monotonically increase as the operation
6149 # progresses.
6150 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6151 # applicable when performing regional operations.
6152 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6153 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6154 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6155 # this field will contain information on all underlying zonal actions and
6156 # their state.
6157 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6158 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6159 # Example key: zones/us-central1-a
6160 &quot;a_key&quot;: {
6161 &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
6162 # populated.
6163 # different programming environments, including REST APIs and RPC APIs. It is
6164 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6165 # three pieces of data: error code, error message, and error details.
6166 #
6167 # You can find out more about this error model and how to work with it in the
6168 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6169 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6170 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6171 # message types for APIs to use.
6172 {
6173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6174 },
6175 ],
6176 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6177 # user-facing error message should be localized and sent in the
6178 # google.rpc.Status.details field, or localized by the client.
6179 },
6180 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6181 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6182 },
6183 },
6184 },
6185 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6186 # This value is inRFC3339
6187 # text format.
6188 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6189 # following:
6190 # `PENDING`, `RUNNING`, or `DONE`.
6191 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6192 # operation.
6193 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6194 # of the target resource.
6195 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6196 # operations related to creating a snapshot, this points to the disk
6197 # that the snapshot was created from.
6198 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6199 # `[email protected]` or
6200 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6201 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6202 # operation, this field will be populated.
6203 {
6204 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6205 # Engine returns NO_RESULTS_ON_PAGE if there
6206 # are no results in the response.
6207 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6208 # value format. For example:
6209 #
6210 # &quot;data&quot;: [
6211 # {
6212 # &quot;key&quot;: &quot;scope&quot;,
6213 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6214 # }
6215 {
6216 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6217 # returned. For example, for warnings where there are no results in a list
6218 # request for a particular zone, this key might be scope and
6219 # the key value might be the zone name. Other examples might be a key
6220 # indicating a deprecated resource and a suggested replacement, or a
6221 # warning about invalid network settings (for example, if an instance
6222 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6223 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6224 },
6225 ],
6226 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6227 },
6228 ],
6229 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6230 # applicable when performing per-zone operations.
6231 }</pre>
6232 </div>
6233
6234 <div class="method">
6235 <code class="details" id="patchPacketMirroringRule">patchPacketMirroringRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code>
6236 <pre>Patches a packet mirroring rule of the specified priority.
6237
6238 Args:
6239 firewallPolicy: string, Name of the firewall policy to update. (required)
6240 body: object, The request body.
6241 The object takes the form of:
6242
6243 { # Represents a rule that describes one or more match conditions along with
6244 # the action to be taken when traffic matches this condition (allow or deny).
6245 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
6246 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
6247 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
6248 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
6249 # and &quot;goto_next&quot;.
6250 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
6251 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
6252 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
6253 # the firewall policy rule is not enforced and traffic behaves as if it did
6254 # not exist. If this is unspecified, the firewall policy rule will be
6255 # enabled.
6256 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
6257 # enabled, logs will be exported to the configured export destination in
6258 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
6259 # cannot enable logging on &quot;goto_next&quot; rules.
6260 &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.
6261 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
6262 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
6263 # Exactly one field must be specified.
6264 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
6265 # Maximum number of destination address groups is 10.
6266 &quot;A String&quot;,
6267 ],
6268 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6269 # traffic destination.
6270 # Maximum number of destination fqdn allowed is 100.
6271 &quot;A String&quot;,
6272 ],
6273 &quot;destIpRanges&quot;: [ # CIDR IP address range.
6274 # Maximum number of destination CIDR IP ranges allowed is 5000.
6275 &quot;A String&quot;,
6276 ],
6277 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
6278 #
6279 #
6280 # - UNSPECIFIED
6281 # - INTERNET
6282 # - NON_INTERNET
6283 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
6284 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
6285 #
6286 #
6287 # - UNSPECIFIED
6288 # - INTERNET
6289 # - NON_INTERNET
6290 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
6291 # of traffic. Should be specified as 2 letter country code defined as per
6292 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6293 # Maximum number of dest region codes allowed is 5000.
6294 &quot;A String&quot;,
6295 ],
6296 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6297 # The IPs in these lists will be matched against traffic destination.
6298 &quot;A String&quot;,
6299 ],
6300 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
6301 {
6302 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
6303 # required when creating a firewall rule. This value can either be
6304 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
6305 # protocol number.
6306 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
6307 # only applicable for UDP or TCP protocol. Each entry must be either
6308 # an integer or a range. If not specified, this rule applies to
6309 # connections through any port.
6310 #
6311 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
6312 &quot;A String&quot;,
6313 ],
6314 },
6315 ],
6316 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
6317 # Maximum number of source address groups is 10.
6318 &quot;A String&quot;,
6319 ],
6320 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6321 # traffic source.
6322 # Maximum number of source fqdn allowed is 100.
6323 &quot;A String&quot;,
6324 ],
6325 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
6326 # Maximum number of source CIDR IP ranges allowed is 5000.
6327 &quot;A String&quot;,
6328 ],
6329 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
6330 #
6331 #
6332 # - UNSPECIFIED
6333 # - INTERNET
6334 # - INTRA_VPC
6335 # - NON_INTERNET
6336 # - VPC_NETWORKS
6337 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
6338 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
6339 #
6340 #
6341 # - UNSPECIFIED
6342 # - INTERNET
6343 # - INTRA_VPC
6344 # - NON_INTERNET
6345 # - VPC_NETWORKS
6346 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
6347 &quot;A String&quot;,
6348 ],
6349 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
6350 # of traffic. Should be specified as 2 letter country code defined as per
6351 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6352 # Maximum number of source region codes allowed is 5000.
6353 &quot;A String&quot;,
6354 ],
6355 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
6356 # of the traffic.
6357 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
6358 # and there is no srcIpRange, this rule will be ignored.
6359 # Maximum number of source tag values allowed is 256.
6360 {
6361 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6362 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6363 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6364 # or its network is deleted.
6365 },
6366 ],
6367 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6368 # The IPs in these lists will be matched against traffic source.
6369 &quot;A String&quot;,
6370 ],
6371 },
6372 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
6373 # must be a positive value between 0 and 2147483647.
6374 # Rules are evaluated from highest to lowest priority where 0 is the
6375 # highest priority and 2147483647 is the lowest priority.
6376 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
6377 # and can be updated.
6378 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
6379 # rule.
6380 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
6381 # Example:
6382 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
6383 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
6384 # &#x27;mirror&#x27;. Cannot be specified for other actions.
6385 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
6386 # This field allows you to control which load balancers get this rule.
6387 # For example, the following are valid values:
6388 #
6389 #
6390 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
6391 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
6392 # - projects/project/global/
6393 # forwardingRules/forwardingRule
6394 # - projects/project/regions/region/forwardingRules/
6395 # forwardingRule
6396 &quot;A String&quot;,
6397 ],
6398 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
6399 # allows you to control which network&#x27;s VMs get this rule. If this field
6400 # is left blank, all VMs within the organization will receive the rule.
6401 &quot;A String&quot;,
6402 ],
6403 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
6404 # applies to. If targetSecureTag are specified, then the
6405 # firewall rule applies only to instances in the VPC network that have one
6406 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
6407 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
6408 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
6409 # to all instances on the specified network.
6410 # Maximum number of target label tags allowed is 256.
6411 {
6412 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6413 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6414 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6415 # or its network is deleted.
6416 },
6417 ],
6418 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
6419 # applied with this rule.
6420 &quot;A String&quot;,
6421 ],
6422 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
6423 # Default value is INSTANCES.
6424 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
6425 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
6426 # be set for other actions.
6427 }
6428
6429 priority: integer, The priority of the rule to patch.
6430 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6431 that if you must retry your request, the server will know to ignore the
6432 request if it has already been completed.
6433
6434 For example, consider a situation where you make an initial request and
6435 the request times out. If you make the request again with the same
6436 request ID, the server can check if original operation with the same
6437 request ID was received, and if so, will ignore the second request. This
6438 prevents clients from accidentally creating duplicate commitments.
6439
6440 The request ID must be
6441 a valid UUID with the exception that zero UUID is not supported
6442 (00000000-0000-0000-0000-000000000000).
6443 x__xgafv: string, V1 error format.
6444 Allowed values
6445 1 - v1 error format
6446 2 - v2 error format
6447
6448 Returns:
6449 An object of the form:
6450
6451 { # Represents an Operation resource.
6452 #
6453 # Google Compute Engine has three Operation resources:
6454 #
6455 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6456 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6457 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6458 #
6459 # You can use an operation resource to manage asynchronous API requests.
6460 # For more information, readHandling
6461 # API responses.
6462 #
6463 # Operations can be global, regional or zonal.
6464 #
6465 # - For global operations, use the `globalOperations`
6466 # resource.
6467 # - For regional operations, use the
6468 # `regionOperations` resource.
6469 # - For zonal operations, use
6470 # the `zoneOperations` resource.
6471 #
6472 #
6473 #
6474 # For more information, read
6475 # Global, Regional, and Zonal Resources.
6476 #
6477 # Note that completed Operation resources have a limited
6478 # retention period.
6479 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6480 # Not present otherwise.
6481 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6482 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6483 # set when the operation is created.
6484 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6485 # text format.
6486 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6487 # this field will be populated.
6488 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6489 # operation.
6490 {
6491 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6492 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6493 # details. There is a set of defined message types to use for providing
6494 # details.The syntax depends on the error code. For example,
6495 # QuotaExceededInfo will have details when the error code is
6496 # QUOTA_EXCEEDED.
6497 {
6498 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6499 #
6500 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6501 # is not enabled:
6502 #
6503 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6504 # &quot;domain&quot;: &quot;googleapis.com&quot;
6505 # &quot;metadata&quot;: {
6506 # &quot;resource&quot;: &quot;projects/123&quot;,
6507 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6508 # }
6509 # }
6510 #
6511 # This response indicates that the pubsub.googleapis.com API is not enabled.
6512 #
6513 # Example of an error that is returned when attempting to create a Spanner
6514 # instance in a region that is out of stock:
6515 #
6516 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6517 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6518 # &quot;metadata&quot;: {
6519 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6520 # }
6521 # }
6522 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6523 # is typically the registered service name of the tool or product that
6524 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6525 # generated by some common infrastructure, the error domain must be a
6526 # globally unique value that identifies the infrastructure. For Google API
6527 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6528 &quot;metadatas&quot;: { # Additional structured details about this error.
6529 #
6530 # Keys must match a regular expression of `a-z+` but should
6531 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6532 # length. When identifying the current value of an exceeded limit, the units
6533 # should be contained in the key, not the value. For example, rather than
6534 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6535 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6536 # instances that can be created in a single (batch) request.
6537 &quot;a_key&quot;: &quot;A String&quot;,
6538 },
6539 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6540 # proximate cause of the error. Error reasons are unique within a particular
6541 # domain of errors. This should be at most 63 characters and match a
6542 # regular expression of `A-Z+[A-Z0-9]`, which represents
6543 # UPPER_SNAKE_CASE.
6544 },
6545 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6546 #
6547 # For example, if a quota check failed with an error indicating the calling
6548 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6549 # directly to the right place in the developer console to flip the bit.
6550 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6551 { # Describes a URL link.
6552 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6553 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6554 },
6555 ],
6556 },
6557 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6558 # which can be attached to an RPC error.
6559 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6560 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6561 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6562 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6563 },
6564 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6565 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6566 &quot;a_key&quot;: &quot;A String&quot;,
6567 },
6568 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6569 # type or metric.
6570 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6571 # or metric.
6572 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6573 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6574 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6575 },
6576 },
6577 ],
6578 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6579 # This property is optional.
6580 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6581 },
6582 ],
6583 },
6584 &quot;getVersionOperationMetadata&quot;: {
6585 &quot;inlineSbomInfo&quot;: {
6586 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6587 # appropriate identifiers.
6588 &quot;a_key&quot;: &quot;A String&quot;,
6589 },
6590 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6591 # identifiers.
6592 &quot;a_key&quot;: &quot;A String&quot;,
6593 },
6594 },
6595 },
6596 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6597 # message that was returned, such as `NOT FOUND`.
6598 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6599 # status code that was returned. For example, a `404` means the
6600 # resource was not found.
6601 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6602 # defined by the server.
6603 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6604 # This value is inRFC3339
6605 # text format.
6606 &quot;instancesBulkInsertOperationMetadata&quot;: {
6607 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6608 # Example key: zones/us-central1-a
6609 &quot;a_key&quot;: {
6610 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6611 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6612 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6613 # error.
6614 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6615 # if the flow is rolling forward or rolling back.
6616 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6617 },
6618 },
6619 },
6620 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6621 # Operation resources.
6622 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6623 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6624 # group of operations results from a `bulkInsert` API request.
6625 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6626 # `update`, or `delete`, and so on.
6627 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6628 # There is no requirement that this be linear or support any granularity of
6629 # operations. This should not be used to guess when the operation will be
6630 # complete. This number should monotonically increase as the operation
6631 # progresses.
6632 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6633 # applicable when performing regional operations.
6634 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6635 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6636 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6637 # this field will contain information on all underlying zonal actions and
6638 # their state.
6639 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6640 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6641 # Example key: zones/us-central1-a
6642 &quot;a_key&quot;: {
6643 &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
6644 # populated.
6645 # different programming environments, including REST APIs and RPC APIs. It is
6646 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6647 # three pieces of data: error code, error message, and error details.
6648 #
6649 # You can find out more about this error model and how to work with it in the
6650 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6651 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6652 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6653 # message types for APIs to use.
6654 {
6655 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6656 },
6657 ],
6658 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6659 # user-facing error message should be localized and sent in the
6660 # google.rpc.Status.details field, or localized by the client.
6661 },
6662 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6663 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6664 },
6665 },
6666 },
6667 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6668 # This value is inRFC3339
6669 # text format.
6670 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6671 # following:
6672 # `PENDING`, `RUNNING`, or `DONE`.
6673 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6674 # operation.
6675 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6676 # of the target resource.
6677 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6678 # operations related to creating a snapshot, this points to the disk
6679 # that the snapshot was created from.
6680 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6681 # `[email protected]` or
6682 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6683 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6684 # operation, this field will be populated.
6685 {
6686 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6687 # Engine returns NO_RESULTS_ON_PAGE if there
6688 # are no results in the response.
6689 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6690 # value format. For example:
6691 #
6692 # &quot;data&quot;: [
6693 # {
6694 # &quot;key&quot;: &quot;scope&quot;,
6695 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6696 # }
6697 {
6698 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6699 # returned. For example, for warnings where there are no results in a list
6700 # request for a particular zone, this key might be scope and
6701 # the key value might be the zone name. Other examples might be a key
6702 # indicating a deprecated resource and a suggested replacement, or a
6703 # warning about invalid network settings (for example, if an instance
6704 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6705 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6706 },
6707 ],
6708 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6709 },
6710 ],
6711 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6712 # applicable when performing per-zone operations.
6713 }</pre>
6714 </div>
6715
6716 <div class="method">
6717 <code class="details" id="patchRule">patchRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code>
6718 <pre>Patches a rule of the specified priority.
6719
6720 Args:
6721 firewallPolicy: string, Name of the firewall policy to update. (required)
6722 body: object, The request body.
6723 The object takes the form of:
6724
6725 { # Represents a rule that describes one or more match conditions along with
6726 # the action to be taken when traffic matches this condition (allow or deny).
6727 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
6728 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
6729 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
6730 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
6731 # and &quot;goto_next&quot;.
6732 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
6733 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
6734 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
6735 # the firewall policy rule is not enforced and traffic behaves as if it did
6736 # not exist. If this is unspecified, the firewall policy rule will be
6737 # enabled.
6738 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
6739 # enabled, logs will be exported to the configured export destination in
6740 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
6741 # cannot enable logging on &quot;goto_next&quot; rules.
6742 &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.
6743 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
6744 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
6745 # Exactly one field must be specified.
6746 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
6747 # Maximum number of destination address groups is 10.
6748 &quot;A String&quot;,
6749 ],
6750 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6751 # traffic destination.
6752 # Maximum number of destination fqdn allowed is 100.
6753 &quot;A String&quot;,
6754 ],
6755 &quot;destIpRanges&quot;: [ # CIDR IP address range.
6756 # Maximum number of destination CIDR IP ranges allowed is 5000.
6757 &quot;A String&quot;,
6758 ],
6759 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
6760 #
6761 #
6762 # - UNSPECIFIED
6763 # - INTERNET
6764 # - NON_INTERNET
6765 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
6766 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
6767 #
6768 #
6769 # - UNSPECIFIED
6770 # - INTERNET
6771 # - NON_INTERNET
6772 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
6773 # of traffic. Should be specified as 2 letter country code defined as per
6774 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6775 # Maximum number of dest region codes allowed is 5000.
6776 &quot;A String&quot;,
6777 ],
6778 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6779 # The IPs in these lists will be matched against traffic destination.
6780 &quot;A String&quot;,
6781 ],
6782 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
6783 {
6784 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
6785 # required when creating a firewall rule. This value can either be
6786 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
6787 # protocol number.
6788 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
6789 # only applicable for UDP or TCP protocol. Each entry must be either
6790 # an integer or a range. If not specified, this rule applies to
6791 # connections through any port.
6792 #
6793 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
6794 &quot;A String&quot;,
6795 ],
6796 },
6797 ],
6798 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
6799 # Maximum number of source address groups is 10.
6800 &quot;A String&quot;,
6801 ],
6802 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
6803 # traffic source.
6804 # Maximum number of source fqdn allowed is 100.
6805 &quot;A String&quot;,
6806 ],
6807 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
6808 # Maximum number of source CIDR IP ranges allowed is 5000.
6809 &quot;A String&quot;,
6810 ],
6811 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
6812 #
6813 #
6814 # - UNSPECIFIED
6815 # - INTERNET
6816 # - INTRA_VPC
6817 # - NON_INTERNET
6818 # - VPC_NETWORKS
6819 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
6820 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
6821 #
6822 #
6823 # - UNSPECIFIED
6824 # - INTERNET
6825 # - INTRA_VPC
6826 # - NON_INTERNET
6827 # - VPC_NETWORKS
6828 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
6829 &quot;A String&quot;,
6830 ],
6831 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
6832 # of traffic. Should be specified as 2 letter country code defined as per
6833 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
6834 # Maximum number of source region codes allowed is 5000.
6835 &quot;A String&quot;,
6836 ],
6837 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
6838 # of the traffic.
6839 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
6840 # and there is no srcIpRange, this rule will be ignored.
6841 # Maximum number of source tag values allowed is 256.
6842 {
6843 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6844 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6845 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6846 # or its network is deleted.
6847 },
6848 ],
6849 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
6850 # The IPs in these lists will be matched against traffic source.
6851 &quot;A String&quot;,
6852 ],
6853 },
6854 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
6855 # must be a positive value between 0 and 2147483647.
6856 # Rules are evaluated from highest to lowest priority where 0 is the
6857 # highest priority and 2147483647 is the lowest priority.
6858 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
6859 # and can be updated.
6860 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
6861 # rule.
6862 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
6863 # Example:
6864 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
6865 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
6866 # &#x27;mirror&#x27;. Cannot be specified for other actions.
6867 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
6868 # This field allows you to control which load balancers get this rule.
6869 # For example, the following are valid values:
6870 #
6871 #
6872 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
6873 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
6874 # - projects/project/global/
6875 # forwardingRules/forwardingRule
6876 # - projects/project/regions/region/forwardingRules/
6877 # forwardingRule
6878 &quot;A String&quot;,
6879 ],
6880 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
6881 # allows you to control which network&#x27;s VMs get this rule. If this field
6882 # is left blank, all VMs within the organization will receive the rule.
6883 &quot;A String&quot;,
6884 ],
6885 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
6886 # applies to. If targetSecureTag are specified, then the
6887 # firewall rule applies only to instances in the VPC network that have one
6888 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
6889 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
6890 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
6891 # to all instances on the specified network.
6892 # Maximum number of target label tags allowed is 256.
6893 {
6894 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
6895 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
6896 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
6897 # or its network is deleted.
6898 },
6899 ],
6900 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
6901 # applied with this rule.
6902 &quot;A String&quot;,
6903 ],
6904 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
6905 # Default value is INSTANCES.
6906 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
6907 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
6908 # be set for other actions.
6909 }
6910
6911 priority: integer, The priority of the rule to patch.
6912 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6913 that if you must retry your request, the server will know to ignore the
6914 request if it has already been completed.
6915
6916 For example, consider a situation where you make an initial request and
6917 the request times out. If you make the request again with the same
6918 request ID, the server can check if original operation with the same
6919 request ID was received, and if so, will ignore the second request. This
6920 prevents clients from accidentally creating duplicate commitments.
6921
6922 The request ID must be
6923 a valid UUID with the exception that zero UUID is not supported
6924 (00000000-0000-0000-0000-000000000000).
6925 x__xgafv: string, V1 error format.
6926 Allowed values
6927 1 - v1 error format
6928 2 - v2 error format
6929
6930 Returns:
6931 An object of the form:
6932
6933 { # Represents an Operation resource.
6934 #
6935 # Google Compute Engine has three Operation resources:
6936 #
6937 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6938 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6939 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6940 #
6941 # You can use an operation resource to manage asynchronous API requests.
6942 # For more information, readHandling
6943 # API responses.
6944 #
6945 # Operations can be global, regional or zonal.
6946 #
6947 # - For global operations, use the `globalOperations`
6948 # resource.
6949 # - For regional operations, use the
6950 # `regionOperations` resource.
6951 # - For zonal operations, use
6952 # the `zoneOperations` resource.
6953 #
6954 #
6955 #
6956 # For more information, read
6957 # Global, Regional, and Zonal Resources.
6958 #
6959 # Note that completed Operation resources have a limited
6960 # retention period.
6961 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6962 # Not present otherwise.
6963 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6964 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6965 # set when the operation is created.
6966 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6967 # text format.
6968 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6969 # this field will be populated.
6970 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6971 # operation.
6972 {
6973 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6974 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6975 # details. There is a set of defined message types to use for providing
6976 # details.The syntax depends on the error code. For example,
6977 # QuotaExceededInfo will have details when the error code is
6978 # QUOTA_EXCEEDED.
6979 {
6980 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6981 #
6982 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6983 # is not enabled:
6984 #
6985 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6986 # &quot;domain&quot;: &quot;googleapis.com&quot;
6987 # &quot;metadata&quot;: {
6988 # &quot;resource&quot;: &quot;projects/123&quot;,
6989 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6990 # }
6991 # }
6992 #
6993 # This response indicates that the pubsub.googleapis.com API is not enabled.
6994 #
6995 # Example of an error that is returned when attempting to create a Spanner
6996 # instance in a region that is out of stock:
6997 #
6998 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6999 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7000 # &quot;metadata&quot;: {
7001 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7002 # }
7003 # }
7004 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7005 # is typically the registered service name of the tool or product that
7006 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7007 # generated by some common infrastructure, the error domain must be a
7008 # globally unique value that identifies the infrastructure. For Google API
7009 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7010 &quot;metadatas&quot;: { # Additional structured details about this error.
7011 #
7012 # Keys must match a regular expression of `a-z+` but should
7013 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7014 # length. When identifying the current value of an exceeded limit, the units
7015 # should be contained in the key, not the value. For example, rather than
7016 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7017 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7018 # instances that can be created in a single (batch) request.
7019 &quot;a_key&quot;: &quot;A String&quot;,
7020 },
7021 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7022 # proximate cause of the error. Error reasons are unique within a particular
7023 # domain of errors. This should be at most 63 characters and match a
7024 # regular expression of `A-Z+[A-Z0-9]`, which represents
7025 # UPPER_SNAKE_CASE.
7026 },
7027 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7028 #
7029 # For example, if a quota check failed with an error indicating the calling
7030 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7031 # directly to the right place in the developer console to flip the bit.
7032 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7033 { # Describes a URL link.
7034 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7035 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7036 },
7037 ],
7038 },
7039 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7040 # which can be attached to an RPC error.
7041 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7042 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7043 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7044 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7045 },
7046 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7047 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7048 &quot;a_key&quot;: &quot;A String&quot;,
7049 },
7050 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7051 # type or metric.
7052 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7053 # or metric.
7054 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7055 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7056 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7057 },
7058 },
7059 ],
7060 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7061 # This property is optional.
7062 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7063 },
7064 ],
7065 },
7066 &quot;getVersionOperationMetadata&quot;: {
7067 &quot;inlineSbomInfo&quot;: {
7068 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7069 # appropriate identifiers.
7070 &quot;a_key&quot;: &quot;A String&quot;,
7071 },
7072 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7073 # identifiers.
7074 &quot;a_key&quot;: &quot;A String&quot;,
7075 },
7076 },
7077 },
7078 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7079 # message that was returned, such as `NOT FOUND`.
7080 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7081 # status code that was returned. For example, a `404` means the
7082 # resource was not found.
7083 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7084 # defined by the server.
7085 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7086 # This value is inRFC3339
7087 # text format.
7088 &quot;instancesBulkInsertOperationMetadata&quot;: {
7089 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7090 # Example key: zones/us-central1-a
7091 &quot;a_key&quot;: {
7092 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7093 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7094 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7095 # error.
7096 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7097 # if the flow is rolling forward or rolling back.
7098 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7099 },
7100 },
7101 },
7102 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7103 # Operation resources.
7104 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7105 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7106 # group of operations results from a `bulkInsert` API request.
7107 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7108 # `update`, or `delete`, and so on.
7109 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7110 # There is no requirement that this be linear or support any granularity of
7111 # operations. This should not be used to guess when the operation will be
7112 # complete. This number should monotonically increase as the operation
7113 # progresses.
7114 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7115 # applicable when performing regional operations.
7116 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7117 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7118 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7119 # this field will contain information on all underlying zonal actions and
7120 # their state.
7121 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7122 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7123 # Example key: zones/us-central1-a
7124 &quot;a_key&quot;: {
7125 &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
7126 # populated.
7127 # different programming environments, including REST APIs and RPC APIs. It is
7128 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7129 # three pieces of data: error code, error message, and error details.
7130 #
7131 # You can find out more about this error model and how to work with it in the
7132 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7133 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7134 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7135 # message types for APIs to use.
7136 {
7137 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7138 },
7139 ],
7140 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7141 # user-facing error message should be localized and sent in the
7142 # google.rpc.Status.details field, or localized by the client.
7143 },
7144 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7145 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7146 },
7147 },
7148 },
7149 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7150 # This value is inRFC3339
7151 # text format.
7152 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7153 # following:
7154 # `PENDING`, `RUNNING`, or `DONE`.
7155 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7156 # operation.
7157 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7158 # of the target resource.
7159 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7160 # operations related to creating a snapshot, this points to the disk
7161 # that the snapshot was created from.
7162 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7163 # `[email protected]` or
7164 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7165 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7166 # operation, this field will be populated.
7167 {
7168 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7169 # Engine returns NO_RESULTS_ON_PAGE if there
7170 # are no results in the response.
7171 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7172 # value format. For example:
7173 #
7174 # &quot;data&quot;: [
7175 # {
7176 # &quot;key&quot;: &quot;scope&quot;,
7177 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7178 # }
7179 {
7180 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7181 # returned. For example, for warnings where there are no results in a list
7182 # request for a particular zone, this key might be scope and
7183 # the key value might be the zone name. Other examples might be a key
7184 # indicating a deprecated resource and a suggested replacement, or a
7185 # warning about invalid network settings (for example, if an instance
7186 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7187 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7188 },
7189 ],
7190 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7191 },
7192 ],
7193 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7194 # applicable when performing per-zone operations.
7195 }</pre>
7196 </div>
7197
7198 <div class="method">
7199 <code class="details" id="removeAssociation">removeAssociation(firewallPolicy, name=None, requestId=None, x__xgafv=None)</code>
7200 <pre>Removes an association for the specified firewall policy.
7201
7202 Args:
7203 firewallPolicy: string, Name of the firewall policy to update. (required)
7204 name: string, Name for the attachment that will be removed.
7205 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7206 that if you must retry your request, the server will know to ignore the
7207 request if it has already been completed.
7208
7209 For example, consider a situation where you make an initial request and
7210 the request times out. If you make the request again with the same
7211 request ID, the server can check if original operation with the same
7212 request ID was received, and if so, will ignore the second request. This
7213 prevents clients from accidentally creating duplicate commitments.
7214
7215 The request ID must be
7216 a valid UUID with the exception that zero UUID is not supported
7217 (00000000-0000-0000-0000-000000000000).
7218 x__xgafv: string, V1 error format.
7219 Allowed values
7220 1 - v1 error format
7221 2 - v2 error format
7222
7223 Returns:
7224 An object of the form:
7225
7226 { # Represents an Operation resource.
7227 #
7228 # Google Compute Engine has three Operation resources:
7229 #
7230 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
7231 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
7232 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
7233 #
7234 # You can use an operation resource to manage asynchronous API requests.
7235 # For more information, readHandling
7236 # API responses.
7237 #
7238 # Operations can be global, regional or zonal.
7239 #
7240 # - For global operations, use the `globalOperations`
7241 # resource.
7242 # - For regional operations, use the
7243 # `regionOperations` resource.
7244 # - For zonal operations, use
7245 # the `zoneOperations` resource.
7246 #
7247 #
7248 #
7249 # For more information, read
7250 # Global, Regional, and Zonal Resources.
7251 #
7252 # Note that completed Operation resources have a limited
7253 # retention period.
7254 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7255 # Not present otherwise.
7256 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7257 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7258 # set when the operation is created.
7259 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7260 # text format.
7261 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7262 # this field will be populated.
7263 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7264 # operation.
7265 {
7266 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7267 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7268 # details. There is a set of defined message types to use for providing
7269 # details.The syntax depends on the error code. For example,
7270 # QuotaExceededInfo will have details when the error code is
7271 # QUOTA_EXCEEDED.
7272 {
7273 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7274 #
7275 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7276 # is not enabled:
7277 #
7278 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7279 # &quot;domain&quot;: &quot;googleapis.com&quot;
7280 # &quot;metadata&quot;: {
7281 # &quot;resource&quot;: &quot;projects/123&quot;,
7282 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7283 # }
7284 # }
7285 #
7286 # This response indicates that the pubsub.googleapis.com API is not enabled.
7287 #
7288 # Example of an error that is returned when attempting to create a Spanner
7289 # instance in a region that is out of stock:
7290 #
7291 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7292 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7293 # &quot;metadata&quot;: {
7294 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7295 # }
7296 # }
7297 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7298 # is typically the registered service name of the tool or product that
7299 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7300 # generated by some common infrastructure, the error domain must be a
7301 # globally unique value that identifies the infrastructure. For Google API
7302 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7303 &quot;metadatas&quot;: { # Additional structured details about this error.
7304 #
7305 # Keys must match a regular expression of `a-z+` but should
7306 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7307 # length. When identifying the current value of an exceeded limit, the units
7308 # should be contained in the key, not the value. For example, rather than
7309 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7310 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7311 # instances that can be created in a single (batch) request.
7312 &quot;a_key&quot;: &quot;A String&quot;,
7313 },
7314 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7315 # proximate cause of the error. Error reasons are unique within a particular
7316 # domain of errors. This should be at most 63 characters and match a
7317 # regular expression of `A-Z+[A-Z0-9]`, which represents
7318 # UPPER_SNAKE_CASE.
7319 },
7320 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7321 #
7322 # For example, if a quota check failed with an error indicating the calling
7323 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7324 # directly to the right place in the developer console to flip the bit.
7325 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7326 { # Describes a URL link.
7327 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7328 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7329 },
7330 ],
7331 },
7332 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7333 # which can be attached to an RPC error.
7334 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7335 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7336 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7337 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7338 },
7339 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7340 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7341 &quot;a_key&quot;: &quot;A String&quot;,
7342 },
7343 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7344 # type or metric.
7345 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7346 # or metric.
7347 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7348 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7349 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7350 },
7351 },
7352 ],
7353 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7354 # This property is optional.
7355 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7356 },
7357 ],
7358 },
7359 &quot;getVersionOperationMetadata&quot;: {
7360 &quot;inlineSbomInfo&quot;: {
7361 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7362 # appropriate identifiers.
7363 &quot;a_key&quot;: &quot;A String&quot;,
7364 },
7365 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7366 # identifiers.
7367 &quot;a_key&quot;: &quot;A String&quot;,
7368 },
7369 },
7370 },
7371 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7372 # message that was returned, such as `NOT FOUND`.
7373 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7374 # status code that was returned. For example, a `404` means the
7375 # resource was not found.
7376 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7377 # defined by the server.
7378 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7379 # This value is inRFC3339
7380 # text format.
7381 &quot;instancesBulkInsertOperationMetadata&quot;: {
7382 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7383 # Example key: zones/us-central1-a
7384 &quot;a_key&quot;: {
7385 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7386 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7387 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7388 # error.
7389 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7390 # if the flow is rolling forward or rolling back.
7391 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7392 },
7393 },
7394 },
7395 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7396 # Operation resources.
7397 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7398 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7399 # group of operations results from a `bulkInsert` API request.
7400 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7401 # `update`, or `delete`, and so on.
7402 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7403 # There is no requirement that this be linear or support any granularity of
7404 # operations. This should not be used to guess when the operation will be
7405 # complete. This number should monotonically increase as the operation
7406 # progresses.
7407 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7408 # applicable when performing regional operations.
7409 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7410 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7411 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7412 # this field will contain information on all underlying zonal actions and
7413 # their state.
7414 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7415 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7416 # Example key: zones/us-central1-a
7417 &quot;a_key&quot;: {
7418 &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
7419 # populated.
7420 # different programming environments, including REST APIs and RPC APIs. It is
7421 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7422 # three pieces of data: error code, error message, and error details.
7423 #
7424 # You can find out more about this error model and how to work with it in the
7425 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7426 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7427 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7428 # message types for APIs to use.
7429 {
7430 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7431 },
7432 ],
7433 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7434 # user-facing error message should be localized and sent in the
7435 # google.rpc.Status.details field, or localized by the client.
7436 },
7437 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7438 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7439 },
7440 },
7441 },
7442 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7443 # This value is inRFC3339
7444 # text format.
7445 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7446 # following:
7447 # `PENDING`, `RUNNING`, or `DONE`.
7448 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7449 # operation.
7450 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7451 # of the target resource.
7452 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7453 # operations related to creating a snapshot, this points to the disk
7454 # that the snapshot was created from.
7455 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7456 # `[email protected]` or
7457 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7458 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7459 # operation, this field will be populated.
7460 {
7461 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7462 # Engine returns NO_RESULTS_ON_PAGE if there
7463 # are no results in the response.
7464 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7465 # value format. For example:
7466 #
7467 # &quot;data&quot;: [
7468 # {
7469 # &quot;key&quot;: &quot;scope&quot;,
7470 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7471 # }
7472 {
7473 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7474 # returned. For example, for warnings where there are no results in a list
7475 # request for a particular zone, this key might be scope and
7476 # the key value might be the zone name. Other examples might be a key
7477 # indicating a deprecated resource and a suggested replacement, or a
7478 # warning about invalid network settings (for example, if an instance
7479 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7480 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7481 },
7482 ],
7483 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7484 },
7485 ],
7486 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7487 # applicable when performing per-zone operations.
7488 }</pre>
7489 </div>
7490
7491 <div class="method">
7492 <code class="details" id="removePacketMirroringRule">removePacketMirroringRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code>
7493 <pre>Deletes a packet mirroring rule of the specified priority.
7494
7495 Args:
7496 firewallPolicy: string, Name of the firewall policy to update. (required)
7497 priority: integer, The priority of the rule to remove from the firewall policy.
7498 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7499 that if you must retry your request, the server will know to ignore the
7500 request if it has already been completed.
7501
7502 For example, consider a situation where you make an initial request and
7503 the request times out. If you make the request again with the same
7504 request ID, the server can check if original operation with the same
7505 request ID was received, and if so, will ignore the second request. This
7506 prevents clients from accidentally creating duplicate commitments.
7507
7508 The request ID must be
7509 a valid UUID with the exception that zero UUID is not supported
7510 (00000000-0000-0000-0000-000000000000).
7511 x__xgafv: string, V1 error format.
7512 Allowed values
7513 1 - v1 error format
7514 2 - v2 error format
7515
7516 Returns:
7517 An object of the form:
7518
7519 { # Represents an Operation resource.
7520 #
7521 # Google Compute Engine has three Operation resources:
7522 #
7523 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
7524 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
7525 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
7526 #
7527 # You can use an operation resource to manage asynchronous API requests.
7528 # For more information, readHandling
7529 # API responses.
7530 #
7531 # Operations can be global, regional or zonal.
7532 #
7533 # - For global operations, use the `globalOperations`
7534 # resource.
7535 # - For regional operations, use the
7536 # `regionOperations` resource.
7537 # - For zonal operations, use
7538 # the `zoneOperations` resource.
7539 #
7540 #
7541 #
7542 # For more information, read
7543 # Global, Regional, and Zonal Resources.
7544 #
7545 # Note that completed Operation resources have a limited
7546 # retention period.
7547 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7548 # Not present otherwise.
7549 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7550 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7551 # set when the operation is created.
7552 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7553 # text format.
7554 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7555 # this field will be populated.
7556 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7557 # operation.
7558 {
7559 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7560 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7561 # details. There is a set of defined message types to use for providing
7562 # details.The syntax depends on the error code. For example,
7563 # QuotaExceededInfo will have details when the error code is
7564 # QUOTA_EXCEEDED.
7565 {
7566 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7567 #
7568 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7569 # is not enabled:
7570 #
7571 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7572 # &quot;domain&quot;: &quot;googleapis.com&quot;
7573 # &quot;metadata&quot;: {
7574 # &quot;resource&quot;: &quot;projects/123&quot;,
7575 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7576 # }
7577 # }
7578 #
7579 # This response indicates that the pubsub.googleapis.com API is not enabled.
7580 #
7581 # Example of an error that is returned when attempting to create a Spanner
7582 # instance in a region that is out of stock:
7583 #
7584 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7585 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7586 # &quot;metadata&quot;: {
7587 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7588 # }
7589 # }
7590 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7591 # is typically the registered service name of the tool or product that
7592 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7593 # generated by some common infrastructure, the error domain must be a
7594 # globally unique value that identifies the infrastructure. For Google API
7595 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7596 &quot;metadatas&quot;: { # Additional structured details about this error.
7597 #
7598 # Keys must match a regular expression of `a-z+` but should
7599 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7600 # length. When identifying the current value of an exceeded limit, the units
7601 # should be contained in the key, not the value. For example, rather than
7602 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7603 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7604 # instances that can be created in a single (batch) request.
7605 &quot;a_key&quot;: &quot;A String&quot;,
7606 },
7607 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7608 # proximate cause of the error. Error reasons are unique within a particular
7609 # domain of errors. This should be at most 63 characters and match a
7610 # regular expression of `A-Z+[A-Z0-9]`, which represents
7611 # UPPER_SNAKE_CASE.
7612 },
7613 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7614 #
7615 # For example, if a quota check failed with an error indicating the calling
7616 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7617 # directly to the right place in the developer console to flip the bit.
7618 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7619 { # Describes a URL link.
7620 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7621 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7622 },
7623 ],
7624 },
7625 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7626 # which can be attached to an RPC error.
7627 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7628 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7629 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7630 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7631 },
7632 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7633 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7634 &quot;a_key&quot;: &quot;A String&quot;,
7635 },
7636 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7637 # type or metric.
7638 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7639 # or metric.
7640 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7641 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7642 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7643 },
7644 },
7645 ],
7646 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7647 # This property is optional.
7648 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7649 },
7650 ],
7651 },
7652 &quot;getVersionOperationMetadata&quot;: {
7653 &quot;inlineSbomInfo&quot;: {
7654 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7655 # appropriate identifiers.
7656 &quot;a_key&quot;: &quot;A String&quot;,
7657 },
7658 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7659 # identifiers.
7660 &quot;a_key&quot;: &quot;A String&quot;,
7661 },
7662 },
7663 },
7664 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7665 # message that was returned, such as `NOT FOUND`.
7666 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7667 # status code that was returned. For example, a `404` means the
7668 # resource was not found.
7669 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7670 # defined by the server.
7671 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7672 # This value is inRFC3339
7673 # text format.
7674 &quot;instancesBulkInsertOperationMetadata&quot;: {
7675 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7676 # Example key: zones/us-central1-a
7677 &quot;a_key&quot;: {
7678 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7679 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7680 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7681 # error.
7682 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7683 # if the flow is rolling forward or rolling back.
7684 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7685 },
7686 },
7687 },
7688 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7689 # Operation resources.
7690 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7691 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7692 # group of operations results from a `bulkInsert` API request.
7693 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7694 # `update`, or `delete`, and so on.
7695 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7696 # There is no requirement that this be linear or support any granularity of
7697 # operations. This should not be used to guess when the operation will be
7698 # complete. This number should monotonically increase as the operation
7699 # progresses.
7700 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7701 # applicable when performing regional operations.
7702 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7703 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7704 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7705 # this field will contain information on all underlying zonal actions and
7706 # their state.
7707 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7708 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7709 # Example key: zones/us-central1-a
7710 &quot;a_key&quot;: {
7711 &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
7712 # populated.
7713 # different programming environments, including REST APIs and RPC APIs. It is
7714 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7715 # three pieces of data: error code, error message, and error details.
7716 #
7717 # You can find out more about this error model and how to work with it in the
7718 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7719 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7720 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7721 # message types for APIs to use.
7722 {
7723 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7724 },
7725 ],
7726 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7727 # user-facing error message should be localized and sent in the
7728 # google.rpc.Status.details field, or localized by the client.
7729 },
7730 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7731 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7732 },
7733 },
7734 },
7735 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7736 # This value is inRFC3339
7737 # text format.
7738 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7739 # following:
7740 # `PENDING`, `RUNNING`, or `DONE`.
7741 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7742 # operation.
7743 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7744 # of the target resource.
7745 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7746 # operations related to creating a snapshot, this points to the disk
7747 # that the snapshot was created from.
7748 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7749 # `[email protected]` or
7750 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7751 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7752 # operation, this field will be populated.
7753 {
7754 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7755 # Engine returns NO_RESULTS_ON_PAGE if there
7756 # are no results in the response.
7757 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7758 # value format. For example:
7759 #
7760 # &quot;data&quot;: [
7761 # {
7762 # &quot;key&quot;: &quot;scope&quot;,
7763 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7764 # }
7765 {
7766 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7767 # returned. For example, for warnings where there are no results in a list
7768 # request for a particular zone, this key might be scope and
7769 # the key value might be the zone name. Other examples might be a key
7770 # indicating a deprecated resource and a suggested replacement, or a
7771 # warning about invalid network settings (for example, if an instance
7772 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7773 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7774 },
7775 ],
7776 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7777 },
7778 ],
7779 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7780 # applicable when performing per-zone operations.
7781 }</pre>
7782 </div>
7783
7784 <div class="method">
7785 <code class="details" id="removeRule">removeRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code>
7786 <pre>Deletes a rule of the specified priority.
7787
7788 Args:
7789 firewallPolicy: string, Name of the firewall policy to update. (required)
7790 priority: integer, The priority of the rule to remove from the firewall policy.
7791 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7792 that if you must retry your request, the server will know to ignore the
7793 request if it has already been completed.
7794
7795 For example, consider a situation where you make an initial request and
7796 the request times out. If you make the request again with the same
7797 request ID, the server can check if original operation with the same
7798 request ID was received, and if so, will ignore the second request. This
7799 prevents clients from accidentally creating duplicate commitments.
7800
7801 The request ID must be
7802 a valid UUID with the exception that zero UUID is not supported
7803 (00000000-0000-0000-0000-000000000000).
7804 x__xgafv: string, V1 error format.
7805 Allowed values
7806 1 - v1 error format
7807 2 - v2 error format
7808
7809 Returns:
7810 An object of the form:
7811
7812 { # Represents an Operation resource.
7813 #
7814 # Google Compute Engine has three Operation resources:
7815 #
7816 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
7817 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
7818 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
7819 #
7820 # You can use an operation resource to manage asynchronous API requests.
7821 # For more information, readHandling
7822 # API responses.
7823 #
7824 # Operations can be global, regional or zonal.
7825 #
7826 # - For global operations, use the `globalOperations`
7827 # resource.
7828 # - For regional operations, use the
7829 # `regionOperations` resource.
7830 # - For zonal operations, use
7831 # the `zoneOperations` resource.
7832 #
7833 #
7834 #
7835 # For more information, read
7836 # Global, Regional, and Zonal Resources.
7837 #
7838 # Note that completed Operation resources have a limited
7839 # retention period.
7840 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7841 # Not present otherwise.
7842 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7843 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7844 # set when the operation is created.
7845 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7846 # text format.
7847 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7848 # this field will be populated.
7849 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7850 # operation.
7851 {
7852 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7853 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7854 # details. There is a set of defined message types to use for providing
7855 # details.The syntax depends on the error code. For example,
7856 # QuotaExceededInfo will have details when the error code is
7857 # QUOTA_EXCEEDED.
7858 {
7859 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7860 #
7861 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7862 # is not enabled:
7863 #
7864 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7865 # &quot;domain&quot;: &quot;googleapis.com&quot;
7866 # &quot;metadata&quot;: {
7867 # &quot;resource&quot;: &quot;projects/123&quot;,
7868 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7869 # }
7870 # }
7871 #
7872 # This response indicates that the pubsub.googleapis.com API is not enabled.
7873 #
7874 # Example of an error that is returned when attempting to create a Spanner
7875 # instance in a region that is out of stock:
7876 #
7877 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7878 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7879 # &quot;metadata&quot;: {
7880 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7881 # }
7882 # }
7883 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7884 # is typically the registered service name of the tool or product that
7885 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7886 # generated by some common infrastructure, the error domain must be a
7887 # globally unique value that identifies the infrastructure. For Google API
7888 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7889 &quot;metadatas&quot;: { # Additional structured details about this error.
7890 #
7891 # Keys must match a regular expression of `a-z+` but should
7892 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7893 # length. When identifying the current value of an exceeded limit, the units
7894 # should be contained in the key, not the value. For example, rather than
7895 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7896 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7897 # instances that can be created in a single (batch) request.
7898 &quot;a_key&quot;: &quot;A String&quot;,
7899 },
7900 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7901 # proximate cause of the error. Error reasons are unique within a particular
7902 # domain of errors. This should be at most 63 characters and match a
7903 # regular expression of `A-Z+[A-Z0-9]`, which represents
7904 # UPPER_SNAKE_CASE.
7905 },
7906 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7907 #
7908 # For example, if a quota check failed with an error indicating the calling
7909 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7910 # directly to the right place in the developer console to flip the bit.
7911 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7912 { # Describes a URL link.
7913 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7914 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7915 },
7916 ],
7917 },
7918 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7919 # which can be attached to an RPC error.
7920 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7921 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7922 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7923 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7924 },
7925 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7926 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7927 &quot;a_key&quot;: &quot;A String&quot;,
7928 },
7929 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7930 # type or metric.
7931 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7932 # or metric.
7933 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7934 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7935 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7936 },
7937 },
7938 ],
7939 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7940 # This property is optional.
7941 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7942 },
7943 ],
7944 },
7945 &quot;getVersionOperationMetadata&quot;: {
7946 &quot;inlineSbomInfo&quot;: {
7947 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7948 # appropriate identifiers.
7949 &quot;a_key&quot;: &quot;A String&quot;,
7950 },
7951 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7952 # identifiers.
7953 &quot;a_key&quot;: &quot;A String&quot;,
7954 },
7955 },
7956 },
7957 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7958 # message that was returned, such as `NOT FOUND`.
7959 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7960 # status code that was returned. For example, a `404` means the
7961 # resource was not found.
7962 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7963 # defined by the server.
7964 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7965 # This value is inRFC3339
7966 # text format.
7967 &quot;instancesBulkInsertOperationMetadata&quot;: {
7968 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7969 # Example key: zones/us-central1-a
7970 &quot;a_key&quot;: {
7971 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7972 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7973 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7974 # error.
7975 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7976 # if the flow is rolling forward or rolling back.
7977 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7978 },
7979 },
7980 },
7981 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7982 # Operation resources.
7983 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7984 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7985 # group of operations results from a `bulkInsert` API request.
7986 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7987 # `update`, or `delete`, and so on.
7988 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7989 # There is no requirement that this be linear or support any granularity of
7990 # operations. This should not be used to guess when the operation will be
7991 # complete. This number should monotonically increase as the operation
7992 # progresses.
7993 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7994 # applicable when performing regional operations.
7995 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7996 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7997 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7998 # this field will contain information on all underlying zonal actions and
7999 # their state.
8000 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8001 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8002 # Example key: zones/us-central1-a
8003 &quot;a_key&quot;: {
8004 &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
8005 # populated.
8006 # different programming environments, including REST APIs and RPC APIs. It is
8007 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8008 # three pieces of data: error code, error message, and error details.
8009 #
8010 # You can find out more about this error model and how to work with it in the
8011 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8012 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8013 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8014 # message types for APIs to use.
8015 {
8016 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8017 },
8018 ],
8019 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8020 # user-facing error message should be localized and sent in the
8021 # google.rpc.Status.details field, or localized by the client.
8022 },
8023 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8024 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8025 },
8026 },
8027 },
8028 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8029 # This value is inRFC3339
8030 # text format.
8031 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8032 # following:
8033 # `PENDING`, `RUNNING`, or `DONE`.
8034 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8035 # operation.
8036 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8037 # of the target resource.
8038 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8039 # operations related to creating a snapshot, this points to the disk
8040 # that the snapshot was created from.
8041 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8042 # `[email protected]` or
8043 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8044 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8045 # operation, this field will be populated.
8046 {
8047 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8048 # Engine returns NO_RESULTS_ON_PAGE if there
8049 # are no results in the response.
8050 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8051 # value format. For example:
8052 #
8053 # &quot;data&quot;: [
8054 # {
8055 # &quot;key&quot;: &quot;scope&quot;,
8056 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8057 # }
8058 {
8059 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8060 # returned. For example, for warnings where there are no results in a list
8061 # request for a particular zone, this key might be scope and
8062 # the key value might be the zone name. Other examples might be a key
8063 # indicating a deprecated resource and a suggested replacement, or a
8064 # warning about invalid network settings (for example, if an instance
8065 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8066 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8067 },
8068 ],
8069 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8070 },
8071 ],
8072 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8073 # applicable when performing per-zone operations.
8074 }</pre>
8075 </div>
8076
8077 <div class="method">
8078 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
8079 <pre>Sets the access control policy on the specified resource.
8080 Replaces any existing policy.
8081
8082 Args:
8083 resource: string, Name or id of the resource for this request. (required)
8084 body: object, The request body.
8085 The object takes the form of:
8086
8087 {
8088 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
8089 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
8090 { # Associates `members`, or principals, with a `role`.
8091 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8092 #
8093 # If the condition evaluates to `true`, then this binding applies to the
8094 # current request.
8095 #
8096 # If the condition evaluates to `false`, then this binding does not apply to
8097 # the current request. However, a different role binding might grant the same
8098 # role to one or more of the principals in this binding.
8099 #
8100 # To learn which resources support conditions in their IAM policies, see the
8101 # [IAM
8102 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8103 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8104 # are documented at https://github.com/google/cel-spec.
8105 #
8106 # Example (Comparison):
8107 #
8108 # title: &quot;Summary size limit&quot;
8109 # description: &quot;Determines if a summary is less than 100 chars&quot;
8110 # expression: &quot;document.summary.size() &lt; 100&quot;
8111 #
8112 # Example (Equality):
8113 #
8114 # title: &quot;Requestor is owner&quot;
8115 # description: &quot;Determines if requestor is the document owner&quot;
8116 # expression: &quot;document.owner == request.auth.claims.email&quot;
8117 #
8118 # Example (Logic):
8119 #
8120 # title: &quot;Public documents&quot;
8121 # description: &quot;Determine whether the document should be publicly visible&quot;
8122 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8123 #
8124 # Example (Data Manipulation):
8125 #
8126 # title: &quot;Notification string&quot;
8127 # description: &quot;Create a notification string with a timestamp.&quot;
8128 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8129 #
8130 # The exact variables and functions that may be referenced within an expression
8131 # are determined by the service that evaluates it. See the service
8132 # documentation for additional information.
8133 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8134 # describes the expression, e.g. when hovered over it in a UI.
8135 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8136 # syntax.
8137 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8138 # reporting, e.g. a file name and a position in the file.
8139 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8140 # its purpose. This can be used e.g. in UIs which allow to enter the
8141 # expression.
8142 },
8143 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8144 # `members` can have the following values:
8145 #
8146 # * `allUsers`: A special identifier that represents anyone who is
8147 # on the internet; with or without a Google account.
8148 #
8149 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8150 # who is authenticated with a Google account or a service account.
8151 # Does not include identities that come from external identity providers
8152 # (IdPs) through identity federation.
8153 #
8154 # * `user:{emailid}`: An email address that represents a specific Google
8155 # account. For example, `[email protected]` .
8156 #
8157 #
8158 # * `serviceAccount:{emailid}`: An email address that represents a Google
8159 # service account. For example,
8160 # `[email protected]`.
8161 #
8162 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8163 # identifier for a
8164 # [Kubernetes service
8165 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8166 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8167 #
8168 # * `group:{emailid}`: An email address that represents a Google group.
8169 # For example, `[email protected]`.
8170 #
8171 #
8172 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8173 # users of that domain. For example, `google.com` or `example.com`.
8174 #
8175 #
8176 #
8177 #
8178 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8179 # A single identity in a workforce identity pool.
8180 #
8181 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8182 # All workforce identities in a group.
8183 #
8184 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8185 # All workforce identities with a specific attribute value.
8186 #
8187 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8188 # All identities in a workforce identity pool.
8189 #
8190 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8191 # A single identity in a workload identity pool.
8192 #
8193 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8194 # A workload identity pool group.
8195 #
8196 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8197 # All identities in a workload identity pool with a certain attribute.
8198 #
8199 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8200 # All identities in a workload identity pool.
8201 #
8202 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8203 # identifier) representing a user that has been recently deleted. For
8204 # example, `[email protected]?uid=123456789012345678901`. If the user is
8205 # recovered, this value reverts to `user:{emailid}` and the recovered user
8206 # retains the role in the binding.
8207 #
8208 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8209 # unique identifier) representing a service account that has been recently
8210 # deleted. For example,
8211 # `[email protected]?uid=123456789012345678901`.
8212 # If the service account is undeleted, this value reverts to
8213 # `serviceAccount:{emailid}` and the undeleted service account retains the
8214 # role in the binding.
8215 #
8216 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8217 # identifier) representing a Google group that has been recently
8218 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8219 # the group is recovered, this value reverts to `group:{emailid}` and the
8220 # recovered group retains the role in the binding.
8221 #
8222 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8223 # Deleted single identity in a workforce identity pool. For example,
8224 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8225 &quot;A String&quot;,
8226 ],
8227 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8228 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8229 #
8230 # For an overview of the IAM roles and permissions, see the
8231 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8232 # a list of the available pre-defined roles, see
8233 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8234 },
8235 ],
8236 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
8237 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
8238 &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
8239 # the policy is limited to a few 10s of KB. An empty policy is in general a
8240 # valid policy but certain services (like Projects) might reject them.
8241 # controls for Google Cloud resources.
8242 #
8243 #
8244 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8245 # `members`, or principals, to a single `role`. Principals can be user
8246 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8247 # `role` is a named list of permissions; each `role` can be an IAM predefined
8248 # role or a user-created custom role.
8249 #
8250 # For some types of Google Cloud resources, a `binding` can also specify a
8251 # `condition`, which is a logical expression that allows access to a resource
8252 # only if the expression evaluates to `true`. A condition can add constraints
8253 # based on attributes of the request, the resource, or both. To learn which
8254 # resources support conditions in their IAM policies, see the
8255 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8256 #
8257 # **JSON example:**
8258 #
8259 # ```
8260 # {
8261 # &quot;bindings&quot;: [
8262 # {
8263 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8264 # &quot;members&quot;: [
8265 # &quot;user:[email protected]&quot;,
8266 # &quot;group:[email protected]&quot;,
8267 # &quot;domain:google.com&quot;,
8268 # &quot;serviceAccount:[email protected]&quot;
8269 # ]
8270 # },
8271 # {
8272 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8273 # &quot;members&quot;: [
8274 # &quot;user:[email protected]&quot;
8275 # ],
8276 # &quot;condition&quot;: {
8277 # &quot;title&quot;: &quot;expirable access&quot;,
8278 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8279 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8280 # }
8281 # }
8282 # ],
8283 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8284 # &quot;version&quot;: 3
8285 # }
8286 # ```
8287 #
8288 # **YAML example:**
8289 #
8290 # ```
8291 # bindings:
8292 # - members:
8293 # - user:[email protected]
8294 # - group:[email protected]
8295 # - domain:google.com
8296 # - serviceAccount:[email protected]
8297 # role: roles/resourcemanager.organizationAdmin
8298 # - members:
8299 # - user:[email protected]
8300 # role: roles/resourcemanager.organizationViewer
8301 # condition:
8302 # title: expirable access
8303 # description: Does not grant access after Sep 2020
8304 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8305 # etag: BwWWja0YfJA=
8306 # version: 3
8307 # ```
8308 #
8309 # For a description of IAM and its features, see the
8310 # [IAM documentation](https://cloud.google.com/iam/docs/).
8311 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8312 { # Specifies the audit configuration for a service.
8313 # The configuration determines which permission types are logged, and what
8314 # identities, if any, are exempted from logging.
8315 # An AuditConfig must have one or more AuditLogConfigs.
8316 #
8317 # If there are AuditConfigs for both `allServices` and a specific service,
8318 # the union of the two AuditConfigs is used for that service: the log_types
8319 # specified in each AuditConfig are enabled, and the exempted_members in each
8320 # AuditLogConfig are exempted.
8321 #
8322 # Example Policy with multiple AuditConfigs:
8323 #
8324 # {
8325 # &quot;audit_configs&quot;: [
8326 # {
8327 # &quot;service&quot;: &quot;allServices&quot;,
8328 # &quot;audit_log_configs&quot;: [
8329 # {
8330 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8331 # &quot;exempted_members&quot;: [
8332 # &quot;user:[email protected]&quot;
8333 # ]
8334 # },
8335 # {
8336 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8337 # },
8338 # {
8339 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8340 # }
8341 # ]
8342 # },
8343 # {
8344 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8345 # &quot;audit_log_configs&quot;: [
8346 # {
8347 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8348 # },
8349 # {
8350 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8351 # &quot;exempted_members&quot;: [
8352 # &quot;user:[email protected]&quot;
8353 # ]
8354 # }
8355 # ]
8356 # }
8357 # ]
8358 # }
8359 #
8360 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8361 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8362 # `[email protected]` from DATA_WRITE logging.
8363 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8364 { # Provides the configuration for logging a type of permissions.
8365 # Example:
8366 #
8367 # {
8368 # &quot;audit_log_configs&quot;: [
8369 # {
8370 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8371 # &quot;exempted_members&quot;: [
8372 # &quot;user:[email protected]&quot;
8373 # ]
8374 # },
8375 # {
8376 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8377 # }
8378 # ]
8379 # }
8380 #
8381 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8382 # [email protected] from DATA_READ logging.
8383 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8384 # permission.
8385 # Follows the same format of Binding.members.
8386 &quot;A String&quot;,
8387 ],
8388 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8389 },
8390 ],
8391 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8392 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8393 # `allServices` is a special value that covers all services.
8394 },
8395 ],
8396 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8397 # may specify a `condition` that determines how and when the `bindings` are
8398 # applied. Each of the `bindings` must contain at least one principal.
8399 #
8400 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8401 # of these principals can be Google groups. Each occurrence of a principal
8402 # counts towards these limits. For example, if the `bindings` grant 50
8403 # different roles to `user:[email protected]`, and not to any other
8404 # principal, then you can add another 1,450 principals to the `bindings` in
8405 # the `Policy`.
8406 { # Associates `members`, or principals, with a `role`.
8407 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8408 #
8409 # If the condition evaluates to `true`, then this binding applies to the
8410 # current request.
8411 #
8412 # If the condition evaluates to `false`, then this binding does not apply to
8413 # the current request. However, a different role binding might grant the same
8414 # role to one or more of the principals in this binding.
8415 #
8416 # To learn which resources support conditions in their IAM policies, see the
8417 # [IAM
8418 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8419 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8420 # are documented at https://github.com/google/cel-spec.
8421 #
8422 # Example (Comparison):
8423 #
8424 # title: &quot;Summary size limit&quot;
8425 # description: &quot;Determines if a summary is less than 100 chars&quot;
8426 # expression: &quot;document.summary.size() &lt; 100&quot;
8427 #
8428 # Example (Equality):
8429 #
8430 # title: &quot;Requestor is owner&quot;
8431 # description: &quot;Determines if requestor is the document owner&quot;
8432 # expression: &quot;document.owner == request.auth.claims.email&quot;
8433 #
8434 # Example (Logic):
8435 #
8436 # title: &quot;Public documents&quot;
8437 # description: &quot;Determine whether the document should be publicly visible&quot;
8438 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8439 #
8440 # Example (Data Manipulation):
8441 #
8442 # title: &quot;Notification string&quot;
8443 # description: &quot;Create a notification string with a timestamp.&quot;
8444 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8445 #
8446 # The exact variables and functions that may be referenced within an expression
8447 # are determined by the service that evaluates it. See the service
8448 # documentation for additional information.
8449 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8450 # describes the expression, e.g. when hovered over it in a UI.
8451 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8452 # syntax.
8453 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8454 # reporting, e.g. a file name and a position in the file.
8455 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8456 # its purpose. This can be used e.g. in UIs which allow to enter the
8457 # expression.
8458 },
8459 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8460 # `members` can have the following values:
8461 #
8462 # * `allUsers`: A special identifier that represents anyone who is
8463 # on the internet; with or without a Google account.
8464 #
8465 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8466 # who is authenticated with a Google account or a service account.
8467 # Does not include identities that come from external identity providers
8468 # (IdPs) through identity federation.
8469 #
8470 # * `user:{emailid}`: An email address that represents a specific Google
8471 # account. For example, `[email protected]` .
8472 #
8473 #
8474 # * `serviceAccount:{emailid}`: An email address that represents a Google
8475 # service account. For example,
8476 # `[email protected]`.
8477 #
8478 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8479 # identifier for a
8480 # [Kubernetes service
8481 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8482 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8483 #
8484 # * `group:{emailid}`: An email address that represents a Google group.
8485 # For example, `[email protected]`.
8486 #
8487 #
8488 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8489 # users of that domain. For example, `google.com` or `example.com`.
8490 #
8491 #
8492 #
8493 #
8494 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8495 # A single identity in a workforce identity pool.
8496 #
8497 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8498 # All workforce identities in a group.
8499 #
8500 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8501 # All workforce identities with a specific attribute value.
8502 #
8503 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8504 # All identities in a workforce identity pool.
8505 #
8506 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8507 # A single identity in a workload identity pool.
8508 #
8509 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8510 # A workload identity pool group.
8511 #
8512 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8513 # All identities in a workload identity pool with a certain attribute.
8514 #
8515 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8516 # All identities in a workload identity pool.
8517 #
8518 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8519 # identifier) representing a user that has been recently deleted. For
8520 # example, `[email protected]?uid=123456789012345678901`. If the user is
8521 # recovered, this value reverts to `user:{emailid}` and the recovered user
8522 # retains the role in the binding.
8523 #
8524 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8525 # unique identifier) representing a service account that has been recently
8526 # deleted. For example,
8527 # `[email protected]?uid=123456789012345678901`.
8528 # If the service account is undeleted, this value reverts to
8529 # `serviceAccount:{emailid}` and the undeleted service account retains the
8530 # role in the binding.
8531 #
8532 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8533 # identifier) representing a Google group that has been recently
8534 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8535 # the group is recovered, this value reverts to `group:{emailid}` and the
8536 # recovered group retains the role in the binding.
8537 #
8538 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8539 # Deleted single identity in a workforce identity pool. For example,
8540 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8541 &quot;A String&quot;,
8542 ],
8543 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8544 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8545 #
8546 # For an overview of the IAM roles and permissions, see the
8547 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8548 # a list of the available pre-defined roles, see
8549 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8550 },
8551 ],
8552 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8553 # prevent simultaneous updates of a policy from overwriting each other.
8554 # It is strongly suggested that systems make use of the `etag` in the
8555 # read-modify-write cycle to perform policy updates in order to avoid race
8556 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8557 # systems are expected to put that etag in the request to `setIamPolicy` to
8558 # ensure that their change will be applied to the same version of the policy.
8559 #
8560 # **Important:** If you use IAM Conditions, you must include the `etag` field
8561 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8562 # you to overwrite a version `3` policy with a version `1` policy, and all of
8563 # the conditions in the version `3` policy are lost.
8564 &quot;version&quot;: 42, # Specifies the format of the policy.
8565 #
8566 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8567 # are rejected.
8568 #
8569 # Any operation that affects conditional role bindings must specify version
8570 # `3`. This requirement applies to the following operations:
8571 #
8572 # * Getting a policy that includes a conditional role binding
8573 # * Adding a conditional role binding to a policy
8574 # * Changing a conditional role binding in a policy
8575 # * Removing any role binding, with or without a condition, from a policy
8576 # that includes conditions
8577 #
8578 # **Important:** If you use IAM Conditions, you must include the `etag` field
8579 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8580 # you to overwrite a version `3` policy with a version `1` policy, and all of
8581 # the conditions in the version `3` policy are lost.
8582 #
8583 # If a policy does not include any conditions, operations on that policy may
8584 # specify any valid version or leave the field unset.
8585 #
8586 # To learn which resources support conditions in their IAM policies, see the
8587 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8588 },
8589 }
8590
8591 x__xgafv: string, V1 error format.
8592 Allowed values
8593 1 - v1 error format
8594 2 - v2 error format
8595
8596 Returns:
8597 An object of the form:
8598
8599 { # An Identity and Access Management (IAM) policy, which specifies access
8600 # controls for Google Cloud resources.
8601 #
8602 #
8603 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8604 # `members`, or principals, to a single `role`. Principals can be user
8605 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8606 # `role` is a named list of permissions; each `role` can be an IAM predefined
8607 # role or a user-created custom role.
8608 #
8609 # For some types of Google Cloud resources, a `binding` can also specify a
8610 # `condition`, which is a logical expression that allows access to a resource
8611 # only if the expression evaluates to `true`. A condition can add constraints
8612 # based on attributes of the request, the resource, or both. To learn which
8613 # resources support conditions in their IAM policies, see the
8614 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8615 #
8616 # **JSON example:**
8617 #
8618 # ```
8619 # {
8620 # &quot;bindings&quot;: [
8621 # {
8622 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8623 # &quot;members&quot;: [
8624 # &quot;user:[email protected]&quot;,
8625 # &quot;group:[email protected]&quot;,
8626 # &quot;domain:google.com&quot;,
8627 # &quot;serviceAccount:[email protected]&quot;
8628 # ]
8629 # },
8630 # {
8631 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8632 # &quot;members&quot;: [
8633 # &quot;user:[email protected]&quot;
8634 # ],
8635 # &quot;condition&quot;: {
8636 # &quot;title&quot;: &quot;expirable access&quot;,
8637 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8638 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8639 # }
8640 # }
8641 # ],
8642 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8643 # &quot;version&quot;: 3
8644 # }
8645 # ```
8646 #
8647 # **YAML example:**
8648 #
8649 # ```
8650 # bindings:
8651 # - members:
8652 # - user:[email protected]
8653 # - group:[email protected]
8654 # - domain:google.com
8655 # - serviceAccount:[email protected]
8656 # role: roles/resourcemanager.organizationAdmin
8657 # - members:
8658 # - user:[email protected]
8659 # role: roles/resourcemanager.organizationViewer
8660 # condition:
8661 # title: expirable access
8662 # description: Does not grant access after Sep 2020
8663 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8664 # etag: BwWWja0YfJA=
8665 # version: 3
8666 # ```
8667 #
8668 # For a description of IAM and its features, see the
8669 # [IAM documentation](https://cloud.google.com/iam/docs/).
8670 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8671 { # Specifies the audit configuration for a service.
8672 # The configuration determines which permission types are logged, and what
8673 # identities, if any, are exempted from logging.
8674 # An AuditConfig must have one or more AuditLogConfigs.
8675 #
8676 # If there are AuditConfigs for both `allServices` and a specific service,
8677 # the union of the two AuditConfigs is used for that service: the log_types
8678 # specified in each AuditConfig are enabled, and the exempted_members in each
8679 # AuditLogConfig are exempted.
8680 #
8681 # Example Policy with multiple AuditConfigs:
8682 #
8683 # {
8684 # &quot;audit_configs&quot;: [
8685 # {
8686 # &quot;service&quot;: &quot;allServices&quot;,
8687 # &quot;audit_log_configs&quot;: [
8688 # {
8689 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8690 # &quot;exempted_members&quot;: [
8691 # &quot;user:[email protected]&quot;
8692 # ]
8693 # },
8694 # {
8695 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8696 # },
8697 # {
8698 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8699 # }
8700 # ]
8701 # },
8702 # {
8703 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8704 # &quot;audit_log_configs&quot;: [
8705 # {
8706 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8707 # },
8708 # {
8709 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8710 # &quot;exempted_members&quot;: [
8711 # &quot;user:[email protected]&quot;
8712 # ]
8713 # }
8714 # ]
8715 # }
8716 # ]
8717 # }
8718 #
8719 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8720 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8721 # `[email protected]` from DATA_WRITE logging.
8722 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8723 { # Provides the configuration for logging a type of permissions.
8724 # Example:
8725 #
8726 # {
8727 # &quot;audit_log_configs&quot;: [
8728 # {
8729 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8730 # &quot;exempted_members&quot;: [
8731 # &quot;user:[email protected]&quot;
8732 # ]
8733 # },
8734 # {
8735 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8736 # }
8737 # ]
8738 # }
8739 #
8740 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8741 # [email protected] from DATA_READ logging.
8742 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8743 # permission.
8744 # Follows the same format of Binding.members.
8745 &quot;A String&quot;,
8746 ],
8747 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8748 },
8749 ],
8750 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8751 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8752 # `allServices` is a special value that covers all services.
8753 },
8754 ],
8755 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8756 # may specify a `condition` that determines how and when the `bindings` are
8757 # applied. Each of the `bindings` must contain at least one principal.
8758 #
8759 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8760 # of these principals can be Google groups. Each occurrence of a principal
8761 # counts towards these limits. For example, if the `bindings` grant 50
8762 # different roles to `user:[email protected]`, and not to any other
8763 # principal, then you can add another 1,450 principals to the `bindings` in
8764 # the `Policy`.
8765 { # Associates `members`, or principals, with a `role`.
8766 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8767 #
8768 # If the condition evaluates to `true`, then this binding applies to the
8769 # current request.
8770 #
8771 # If the condition evaluates to `false`, then this binding does not apply to
8772 # the current request. However, a different role binding might grant the same
8773 # role to one or more of the principals in this binding.
8774 #
8775 # To learn which resources support conditions in their IAM policies, see the
8776 # [IAM
8777 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8778 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8779 # are documented at https://github.com/google/cel-spec.
8780 #
8781 # Example (Comparison):
8782 #
8783 # title: &quot;Summary size limit&quot;
8784 # description: &quot;Determines if a summary is less than 100 chars&quot;
8785 # expression: &quot;document.summary.size() &lt; 100&quot;
8786 #
8787 # Example (Equality):
8788 #
8789 # title: &quot;Requestor is owner&quot;
8790 # description: &quot;Determines if requestor is the document owner&quot;
8791 # expression: &quot;document.owner == request.auth.claims.email&quot;
8792 #
8793 # Example (Logic):
8794 #
8795 # title: &quot;Public documents&quot;
8796 # description: &quot;Determine whether the document should be publicly visible&quot;
8797 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8798 #
8799 # Example (Data Manipulation):
8800 #
8801 # title: &quot;Notification string&quot;
8802 # description: &quot;Create a notification string with a timestamp.&quot;
8803 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8804 #
8805 # The exact variables and functions that may be referenced within an expression
8806 # are determined by the service that evaluates it. See the service
8807 # documentation for additional information.
8808 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8809 # describes the expression, e.g. when hovered over it in a UI.
8810 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8811 # syntax.
8812 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8813 # reporting, e.g. a file name and a position in the file.
8814 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8815 # its purpose. This can be used e.g. in UIs which allow to enter the
8816 # expression.
8817 },
8818 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8819 # `members` can have the following values:
8820 #
8821 # * `allUsers`: A special identifier that represents anyone who is
8822 # on the internet; with or without a Google account.
8823 #
8824 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8825 # who is authenticated with a Google account or a service account.
8826 # Does not include identities that come from external identity providers
8827 # (IdPs) through identity federation.
8828 #
8829 # * `user:{emailid}`: An email address that represents a specific Google
8830 # account. For example, `[email protected]` .
8831 #
8832 #
8833 # * `serviceAccount:{emailid}`: An email address that represents a Google
8834 # service account. For example,
8835 # `[email protected]`.
8836 #
8837 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8838 # identifier for a
8839 # [Kubernetes service
8840 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8841 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8842 #
8843 # * `group:{emailid}`: An email address that represents a Google group.
8844 # For example, `[email protected]`.
8845 #
8846 #
8847 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8848 # users of that domain. For example, `google.com` or `example.com`.
8849 #
8850 #
8851 #
8852 #
8853 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8854 # A single identity in a workforce identity pool.
8855 #
8856 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8857 # All workforce identities in a group.
8858 #
8859 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8860 # All workforce identities with a specific attribute value.
8861 #
8862 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8863 # All identities in a workforce identity pool.
8864 #
8865 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8866 # A single identity in a workload identity pool.
8867 #
8868 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8869 # A workload identity pool group.
8870 #
8871 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8872 # All identities in a workload identity pool with a certain attribute.
8873 #
8874 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8875 # All identities in a workload identity pool.
8876 #
8877 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8878 # identifier) representing a user that has been recently deleted. For
8879 # example, `[email protected]?uid=123456789012345678901`. If the user is
8880 # recovered, this value reverts to `user:{emailid}` and the recovered user
8881 # retains the role in the binding.
8882 #
8883 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8884 # unique identifier) representing a service account that has been recently
8885 # deleted. For example,
8886 # `[email protected]?uid=123456789012345678901`.
8887 # If the service account is undeleted, this value reverts to
8888 # `serviceAccount:{emailid}` and the undeleted service account retains the
8889 # role in the binding.
8890 #
8891 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8892 # identifier) representing a Google group that has been recently
8893 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8894 # the group is recovered, this value reverts to `group:{emailid}` and the
8895 # recovered group retains the role in the binding.
8896 #
8897 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8898 # Deleted single identity in a workforce identity pool. For example,
8899 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8900 &quot;A String&quot;,
8901 ],
8902 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8903 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8904 #
8905 # For an overview of the IAM roles and permissions, see the
8906 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8907 # a list of the available pre-defined roles, see
8908 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8909 },
8910 ],
8911 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8912 # prevent simultaneous updates of a policy from overwriting each other.
8913 # It is strongly suggested that systems make use of the `etag` in the
8914 # read-modify-write cycle to perform policy updates in order to avoid race
8915 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8916 # systems are expected to put that etag in the request to `setIamPolicy` to
8917 # ensure that their change will be applied to the same version of the policy.
8918 #
8919 # **Important:** If you use IAM Conditions, you must include the `etag` field
8920 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8921 # you to overwrite a version `3` policy with a version `1` policy, and all of
8922 # the conditions in the version `3` policy are lost.
8923 &quot;version&quot;: 42, # Specifies the format of the policy.
8924 #
8925 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8926 # are rejected.
8927 #
8928 # Any operation that affects conditional role bindings must specify version
8929 # `3`. This requirement applies to the following operations:
8930 #
8931 # * Getting a policy that includes a conditional role binding
8932 # * Adding a conditional role binding to a policy
8933 # * Changing a conditional role binding in a policy
8934 # * Removing any role binding, with or without a condition, from a policy
8935 # that includes conditions
8936 #
8937 # **Important:** If you use IAM Conditions, you must include the `etag` field
8938 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8939 # you to overwrite a version `3` policy with a version `1` policy, and all of
8940 # the conditions in the version `3` policy are lost.
8941 #
8942 # If a policy does not include any conditions, operations on that policy may
8943 # specify any valid version or leave the field unset.
8944 #
8945 # To learn which resources support conditions in their IAM policies, see the
8946 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8947 }</pre>
8948 </div>
8949
8950 <div class="method">
8951 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
8952 <pre>Returns permissions that a caller has on the specified resource.
8953
8954 Args:
8955 resource: string, Name or id of the resource for this request. (required)
8956 body: object, The request body.
8957 The object takes the form of:
8958
8959 {
8960 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
8961 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
8962 &quot;A String&quot;,
8963 ],
8964 }
8965
8966 x__xgafv: string, V1 error format.
8967 Allowed values
8968 1 - v1 error format
8969 2 - v2 error format
8970
8971 Returns:
8972 An object of the form:
8973
8974 {
8975 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
8976 # allowed.
8977 &quot;A String&quot;,
8978 ],
8979 }</pre>
8980 </div>
8981
8982 </body></html>