Debian Codegraph @

docs/dyn/compute_alpha.firewalls.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.firewalls.html">firewalls</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(project, firewall, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified firewall.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, firewall, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the specified firewall.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Creates a firewall rule in the specified project using the data</p>
89 <p class="toc_element">
90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves the list of firewall rules available to the specified</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(project, firewall, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates the specified firewall rule with the data included in the</p>
98 <p class="toc_element">
99 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101 <p class="toc_element">
102 <code><a href="#update">update(project, firewall, body=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Updates the specified firewall rule with the data included in the</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="delete">delete(project, firewall, requestId=None, x__xgafv=None)</code>
112 <pre>Deletes the specified firewall.
113
114 Args:
115 project: string, Project ID for this request. (required)
116 firewall: string, Name of the firewall rule to delete. (required)
117 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
118 that if you must retry your request, the server will know to ignore the
119 request if it has already been completed.
120
121 For example, consider a situation where you make an initial request and
122 the request times out. If you make the request again with the same
123 request ID, the server can check if original operation with the same
124 request ID was received, and if so, will ignore the second request. This
125 prevents clients from accidentally creating duplicate commitments.
126
127 The request ID must be
128 a valid UUID with the exception that zero UUID is not supported
129 (00000000-0000-0000-0000-000000000000).
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135 Returns:
136 An object of the form:
137
138 { # Represents an Operation resource.
139 #
140 # Google Compute Engine has three Operation resources:
141 #
142 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
143 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
144 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
145 #
146 # You can use an operation resource to manage asynchronous API requests.
147 # For more information, readHandling
148 # API responses.
149 #
150 # Operations can be global, regional or zonal.
151 #
152 # - For global operations, use the `globalOperations`
153 # resource.
154 # - For regional operations, use the
155 # `regionOperations` resource.
156 # - For zonal operations, use
157 # the `zoneOperations` resource.
158 #
159 #
160 #
161 # For more information, read
162 # Global, Regional, and Zonal Resources.
163 #
164 # Note that completed Operation resources have a limited
165 # retention period.
166 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
167 # Not present otherwise.
168 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
169 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
170 # set when the operation is created.
171 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
172 # text format.
173 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
174 # this field will be populated.
175 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
176 # operation.
177 {
178 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
179 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
180 # details. There is a set of defined message types to use for providing
181 # details.The syntax depends on the error code. For example,
182 # QuotaExceededInfo will have details when the error code is
183 # QUOTA_EXCEEDED.
184 {
185 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
186 #
187 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
188 # is not enabled:
189 #
190 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
191 # &quot;domain&quot;: &quot;googleapis.com&quot;
192 # &quot;metadata&quot;: {
193 # &quot;resource&quot;: &quot;projects/123&quot;,
194 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
195 # }
196 # }
197 #
198 # This response indicates that the pubsub.googleapis.com API is not enabled.
199 #
200 # Example of an error that is returned when attempting to create a Spanner
201 # instance in a region that is out of stock:
202 #
203 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
204 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
205 # &quot;metadata&quot;: {
206 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
207 # }
208 # }
209 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
210 # is typically the registered service name of the tool or product that
211 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
212 # generated by some common infrastructure, the error domain must be a
213 # globally unique value that identifies the infrastructure. For Google API
214 # infrastructure, the error domain is &quot;googleapis.com&quot;.
215 &quot;metadatas&quot;: { # Additional structured details about this error.
216 #
217 # Keys must match a regular expression of `a-z+` but should
218 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
219 # length. When identifying the current value of an exceeded limit, the units
220 # should be contained in the key, not the value. For example, rather than
221 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
222 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
223 # instances that can be created in a single (batch) request.
224 &quot;a_key&quot;: &quot;A String&quot;,
225 },
226 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
227 # proximate cause of the error. Error reasons are unique within a particular
228 # domain of errors. This should be at most 63 characters and match a
229 # regular expression of `A-Z+[A-Z0-9]`, which represents
230 # UPPER_SNAKE_CASE.
231 },
232 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
233 #
234 # For example, if a quota check failed with an error indicating the calling
235 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
236 # directly to the right place in the developer console to flip the bit.
237 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
238 { # Describes a URL link.
239 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
240 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
241 },
242 ],
243 },
244 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
245 # which can be attached to an RPC error.
246 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
247 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
248 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
249 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
250 },
251 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
252 &quot;dimensions&quot;: { # The map holding related quota dimensions.
253 &quot;a_key&quot;: &quot;A String&quot;,
254 },
255 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
256 # type or metric.
257 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
258 # or metric.
259 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
260 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
261 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
262 },
263 },
264 ],
265 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
266 # This property is optional.
267 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
268 },
269 ],
270 },
271 &quot;getVersionOperationMetadata&quot;: {
272 &quot;inlineSbomInfo&quot;: {
273 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
274 # appropriate identifiers.
275 &quot;a_key&quot;: &quot;A String&quot;,
276 },
277 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
278 # identifiers.
279 &quot;a_key&quot;: &quot;A String&quot;,
280 },
281 },
282 },
283 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
284 # message that was returned, such as `NOT FOUND`.
285 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
286 # status code that was returned. For example, a `404` means the
287 # resource was not found.
288 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
289 # defined by the server.
290 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
291 # This value is inRFC3339
292 # text format.
293 &quot;instancesBulkInsertOperationMetadata&quot;: {
294 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
295 # Example key: zones/us-central1-a
296 &quot;a_key&quot;: {
297 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
298 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
299 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
300 # error.
301 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
302 # if the flow is rolling forward or rolling back.
303 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
304 },
305 },
306 },
307 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
308 # Operation resources.
309 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
310 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
311 # group of operations results from a `bulkInsert` API request.
312 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
313 # `update`, or `delete`, and so on.
314 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
315 # There is no requirement that this be linear or support any granularity of
316 # operations. This should not be used to guess when the operation will be
317 # complete. This number should monotonically increase as the operation
318 # progresses.
319 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
320 # applicable when performing regional operations.
321 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
322 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
323 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
324 # this field will contain information on all underlying zonal actions and
325 # their state.
326 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
327 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
328 # Example key: zones/us-central1-a
329 &quot;a_key&quot;: {
330 &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
331 # populated.
332 # different programming environments, including REST APIs and RPC APIs. It is
333 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
334 # three pieces of data: error code, error message, and error details.
335 #
336 # You can find out more about this error model and how to work with it in the
337 # [API Design Guide](https://cloud.google.com/apis/design/errors).
338 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
339 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
340 # message types for APIs to use.
341 {
342 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
343 },
344 ],
345 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
346 # user-facing error message should be localized and sent in the
347 # google.rpc.Status.details field, or localized by the client.
348 },
349 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
350 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
351 },
352 },
353 },
354 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
355 # This value is inRFC3339
356 # text format.
357 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
358 # following:
359 # `PENDING`, `RUNNING`, or `DONE`.
360 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
361 # operation.
362 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
363 # of the target resource.
364 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
365 # operations related to creating a snapshot, this points to the disk
366 # that the snapshot was created from.
367 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
368 # `[email protected]` or
369 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
370 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
371 # operation, this field will be populated.
372 {
373 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
374 # Engine returns NO_RESULTS_ON_PAGE if there
375 # are no results in the response.
376 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
377 # value format. For example:
378 #
379 # &quot;data&quot;: [
380 # {
381 # &quot;key&quot;: &quot;scope&quot;,
382 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
383 # }
384 {
385 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
386 # returned. For example, for warnings where there are no results in a list
387 # request for a particular zone, this key might be scope and
388 # the key value might be the zone name. Other examples might be a key
389 # indicating a deprecated resource and a suggested replacement, or a
390 # warning about invalid network settings (for example, if an instance
391 # attempts to perform IP forwarding but is not enabled for IP forwarding).
392 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
393 },
394 ],
395 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
396 },
397 ],
398 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
399 # applicable when performing per-zone operations.
400 }</pre>
401 </div>
402
403 <div class="method">
404 <code class="details" id="get">get(project, firewall, x__xgafv=None)</code>
405 <pre>Returns the specified firewall.
406
407 Args:
408 project: string, Project ID for this request. (required)
409 firewall: string, Name of the firewall rule to return. (required)
410 x__xgafv: string, V1 error format.
411 Allowed values
412 1 - v1 error format
413 2 - v2 error format
414
415 Returns:
416 An object of the form:
417
418 { # Represents a Firewall Rule resource.
419 #
420 # Firewall rules allow or deny ingress traffic to, and egress traffic from your
421 # instances. For more information, readFirewall rules.
422 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a
423 # protocol and port-range tuple that describes a permitted connection.
424 {
425 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
426 # required when creating a firewall rule. This value can either be one of the
427 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
428 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
429 # This field is only applicable for the UDP or TCP protocol.
430 # Each entry must be either an integer or a range.
431 # If not specified, this rule applies to connections through any port.
432 #
433 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
434 # and [&quot;12345-12349&quot;].
435 &quot;A String&quot;,
436 ],
437 },
438 ],
439 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
440 # text format.
441 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a
442 # protocol and port-range tuple that describes a denied connection.
443 {
444 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
445 # required when creating a firewall rule. This value can either be one of the
446 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
447 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
448 # This field is only applicable for the UDP or TCP protocol.
449 # Each entry must be either an integer or a range.
450 # If not specified, this rule applies to connections through any port.
451 #
452 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
453 # and [&quot;12345-12349&quot;].
454 &quot;A String&quot;,
455 ],
456 },
457 ],
458 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
459 # create the resource.
460 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to
461 # traffic that has destination IP address in these ranges. These ranges must
462 # be expressed inCIDR format. Both IPv4 and IPv6 are supported.
463 &quot;A String&quot;,
464 ],
465 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or
466 # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot
467 # specify the sourceTags fields.
468 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the
469 # firewall rule is not enforced and the network behaves as if it did not
470 # exist. If this is unspecified, the firewall rule will be enabled.
471 &quot;enableLogging&quot;: True or False, # Deprecated in favor of enable in LogConfig.
472 # This field denotes whether to enable logging for a particular
473 # firewall rule. If logging is enabled, logs will be exported t
474 # Cloud Logging.
475 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
476 # defined by the server.
477 &quot;kind&quot;: &quot;compute#firewall&quot;, # Output only. [Output Only] Type of the resource. Always compute#firewall
478 # for firewall rules.
479 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If
480 # logging is enabled, logs will be exported to Cloud Logging.
481 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall
482 # rule.
483 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if
484 # logging is enabled for that rule. This field denotes whether to include
485 # or exclude metadata for firewall logs.
486 },
487 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
488 # The name must be 1-63 characters long, and comply withRFC1035.
489 # Specifically, the name must be 1-63 characters long and match the regular
490 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character
491 # must be a lowercase letter, and all following characters (except for the
492 # last character) must be a dash, lowercase letter, or digit. The last
493 # character must be a lowercase letter or digit.
494 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not
495 # specified when creating a firewall rule, the default network
496 # is used:
497 #
498 # global/networks/default
499 #
500 # If you choose to specify this field, you can specify the network as a full
501 # or partial URL. For example, the following are all valid URLs:
502 #
503 # -
504 # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
505 # - projects/myproject/global/networks/my-network
506 # - global/networks/default
507 &quot;params&quot;: { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
508 # as part of resource payload.
509 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
510 # Tag keys and values have the same definition as resource
511 # manager tags. The field is allowed for INSERT
512 # only. The keys/values to set on the resource should be specified in
513 # either ID { : } or Namespaced format
514 # { : }.
515 # For example the following are valid inputs:
516 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
517 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
518 # Note:
519 # * Invalid combinations of ID &amp; namespaced format is not supported. For
520 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
521 &quot;a_key&quot;: &quot;A String&quot;,
522 },
523 },
524 &quot;priority&quot;: 42, # Priority for this rule.
525 # This is an integer between `0` and `65535`, both inclusive.
526 # The default value is `1000`.
527 # Relative priorities determine which rule takes effect if multiple rules
528 # apply. Lower values indicate higher priority. For example, a rule with
529 # priority `0` has higher precedence than a rule with priority `1`.
530 # DENY rules take precedence over ALLOW rules if they have equal priority.
531 # Note that VPC networks have implied
532 # rules with a priority of `65535`. To avoid conflicts with the implied
533 # rules, use a priority number less than `65535`.
534 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
535 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
536 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic
537 # that has a source IP address in these ranges. These ranges must be
538 # expressed inCIDR format. One or both of sourceRanges
539 # and sourceTags may be set.
540 # If both fields are set, the rule applies to traffic that has a
541 # source IP address within sourceRanges OR a source IP
542 # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match
543 # both fields for the rule to
544 # apply. Both IPv4 and IPv6 are supported.
545 &quot;A String&quot;,
546 ],
547 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to
548 # traffic originating from an instance with a service account in this list.
549 # Source service accounts cannot be used to control traffic to an instance&#x27;s
550 # external IP address because service accounts are associated with an
551 # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.
552 # If both are set, the firewall applies to traffic that
553 # has a source IP address within the sourceRanges OR a source
554 # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match
555 # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.
556 &quot;A String&quot;,
557 ],
558 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic
559 # with source IPs that match the primary network interfaces of VM instances
560 # that have the tag and are in the same VPC network.
561 # Source tags cannot be used to control traffic to an instance&#x27;s external IP
562 # address, it only applies to traffic between instances in the same virtual
563 # network. Because tags are associated with instances, not IP addresses.
564 # One or both of sourceRanges and sourceTags may be
565 # set. If both fields are set, the firewall applies to traffic that has a
566 # source IP address within sourceRanges OR a source IP from a
567 # resource with a matching tag listed in the sourceTags
568 # field. The connection does not need to match both fields for the
569 # firewall to apply.
570 &quot;A String&quot;,
571 ],
572 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the
573 # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.
574 # If neither targetServiceAccounts nor targetTags
575 # are specified, the firewall rule applies to all instances on the specified
576 # network.
577 &quot;A String&quot;,
578 ],
579 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule
580 # applies to. If targetTags are specified, then the firewall
581 # rule applies only to instances in the VPC network that have one of those
582 # tags. If no targetTags are specified, the firewall rule
583 # applies to all instances on the specified network.
584 &quot;A String&quot;,
585 ],
586 }</pre>
587 </div>
588
589 <div class="method">
590 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
591 <pre>Creates a firewall rule in the specified project using the data
592 included in the request.
593
594 Args:
595 project: string, Project ID for this request. (required)
596 body: object, The request body.
597 The object takes the form of:
598
599 { # Represents a Firewall Rule resource.
600 #
601 # Firewall rules allow or deny ingress traffic to, and egress traffic from your
602 # instances. For more information, readFirewall rules.
603 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a
604 # protocol and port-range tuple that describes a permitted connection.
605 {
606 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
607 # required when creating a firewall rule. This value can either be one of the
608 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
609 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
610 # This field is only applicable for the UDP or TCP protocol.
611 # Each entry must be either an integer or a range.
612 # If not specified, this rule applies to connections through any port.
613 #
614 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
615 # and [&quot;12345-12349&quot;].
616 &quot;A String&quot;,
617 ],
618 },
619 ],
620 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
621 # text format.
622 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a
623 # protocol and port-range tuple that describes a denied connection.
624 {
625 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
626 # required when creating a firewall rule. This value can either be one of the
627 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
628 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
629 # This field is only applicable for the UDP or TCP protocol.
630 # Each entry must be either an integer or a range.
631 # If not specified, this rule applies to connections through any port.
632 #
633 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
634 # and [&quot;12345-12349&quot;].
635 &quot;A String&quot;,
636 ],
637 },
638 ],
639 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
640 # create the resource.
641 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to
642 # traffic that has destination IP address in these ranges. These ranges must
643 # be expressed inCIDR format. Both IPv4 and IPv6 are supported.
644 &quot;A String&quot;,
645 ],
646 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or
647 # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot
648 # specify the sourceTags fields.
649 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the
650 # firewall rule is not enforced and the network behaves as if it did not
651 # exist. If this is unspecified, the firewall rule will be enabled.
652 &quot;enableLogging&quot;: True or False, # Deprecated in favor of enable in LogConfig.
653 # This field denotes whether to enable logging for a particular
654 # firewall rule. If logging is enabled, logs will be exported t
655 # Cloud Logging.
656 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
657 # defined by the server.
658 &quot;kind&quot;: &quot;compute#firewall&quot;, # Output only. [Output Only] Type of the resource. Always compute#firewall
659 # for firewall rules.
660 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If
661 # logging is enabled, logs will be exported to Cloud Logging.
662 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall
663 # rule.
664 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if
665 # logging is enabled for that rule. This field denotes whether to include
666 # or exclude metadata for firewall logs.
667 },
668 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
669 # The name must be 1-63 characters long, and comply withRFC1035.
670 # Specifically, the name must be 1-63 characters long and match the regular
671 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character
672 # must be a lowercase letter, and all following characters (except for the
673 # last character) must be a dash, lowercase letter, or digit. The last
674 # character must be a lowercase letter or digit.
675 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not
676 # specified when creating a firewall rule, the default network
677 # is used:
678 #
679 # global/networks/default
680 #
681 # If you choose to specify this field, you can specify the network as a full
682 # or partial URL. For example, the following are all valid URLs:
683 #
684 # -
685 # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
686 # - projects/myproject/global/networks/my-network
687 # - global/networks/default
688 &quot;params&quot;: { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
689 # as part of resource payload.
690 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
691 # Tag keys and values have the same definition as resource
692 # manager tags. The field is allowed for INSERT
693 # only. The keys/values to set on the resource should be specified in
694 # either ID { : } or Namespaced format
695 # { : }.
696 # For example the following are valid inputs:
697 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
698 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
699 # Note:
700 # * Invalid combinations of ID &amp; namespaced format is not supported. For
701 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
702 &quot;a_key&quot;: &quot;A String&quot;,
703 },
704 },
705 &quot;priority&quot;: 42, # Priority for this rule.
706 # This is an integer between `0` and `65535`, both inclusive.
707 # The default value is `1000`.
708 # Relative priorities determine which rule takes effect if multiple rules
709 # apply. Lower values indicate higher priority. For example, a rule with
710 # priority `0` has higher precedence than a rule with priority `1`.
711 # DENY rules take precedence over ALLOW rules if they have equal priority.
712 # Note that VPC networks have implied
713 # rules with a priority of `65535`. To avoid conflicts with the implied
714 # rules, use a priority number less than `65535`.
715 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
716 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
717 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic
718 # that has a source IP address in these ranges. These ranges must be
719 # expressed inCIDR format. One or both of sourceRanges
720 # and sourceTags may be set.
721 # If both fields are set, the rule applies to traffic that has a
722 # source IP address within sourceRanges OR a source IP
723 # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match
724 # both fields for the rule to
725 # apply. Both IPv4 and IPv6 are supported.
726 &quot;A String&quot;,
727 ],
728 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to
729 # traffic originating from an instance with a service account in this list.
730 # Source service accounts cannot be used to control traffic to an instance&#x27;s
731 # external IP address because service accounts are associated with an
732 # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.
733 # If both are set, the firewall applies to traffic that
734 # has a source IP address within the sourceRanges OR a source
735 # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match
736 # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.
737 &quot;A String&quot;,
738 ],
739 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic
740 # with source IPs that match the primary network interfaces of VM instances
741 # that have the tag and are in the same VPC network.
742 # Source tags cannot be used to control traffic to an instance&#x27;s external IP
743 # address, it only applies to traffic between instances in the same virtual
744 # network. Because tags are associated with instances, not IP addresses.
745 # One or both of sourceRanges and sourceTags may be
746 # set. If both fields are set, the firewall applies to traffic that has a
747 # source IP address within sourceRanges OR a source IP from a
748 # resource with a matching tag listed in the sourceTags
749 # field. The connection does not need to match both fields for the
750 # firewall to apply.
751 &quot;A String&quot;,
752 ],
753 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the
754 # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.
755 # If neither targetServiceAccounts nor targetTags
756 # are specified, the firewall rule applies to all instances on the specified
757 # network.
758 &quot;A String&quot;,
759 ],
760 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule
761 # applies to. If targetTags are specified, then the firewall
762 # rule applies only to instances in the VPC network that have one of those
763 # tags. If no targetTags are specified, the firewall rule
764 # applies to all instances on the specified network.
765 &quot;A String&quot;,
766 ],
767 }
768
769 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
770 that if you must retry your request, the server will know to ignore the
771 request if it has already been completed.
772
773 For example, consider a situation where you make an initial request and
774 the request times out. If you make the request again with the same
775 request ID, the server can check if original operation with the same
776 request ID was received, and if so, will ignore the second request. This
777 prevents clients from accidentally creating duplicate commitments.
778
779 The request ID must be
780 a valid UUID with the exception that zero UUID is not supported
781 (00000000-0000-0000-0000-000000000000).
782 x__xgafv: string, V1 error format.
783 Allowed values
784 1 - v1 error format
785 2 - v2 error format
786
787 Returns:
788 An object of the form:
789
790 { # Represents an Operation resource.
791 #
792 # Google Compute Engine has three Operation resources:
793 #
794 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
795 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
796 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
797 #
798 # You can use an operation resource to manage asynchronous API requests.
799 # For more information, readHandling
800 # API responses.
801 #
802 # Operations can be global, regional or zonal.
803 #
804 # - For global operations, use the `globalOperations`
805 # resource.
806 # - For regional operations, use the
807 # `regionOperations` resource.
808 # - For zonal operations, use
809 # the `zoneOperations` resource.
810 #
811 #
812 #
813 # For more information, read
814 # Global, Regional, and Zonal Resources.
815 #
816 # Note that completed Operation resources have a limited
817 # retention period.
818 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
819 # Not present otherwise.
820 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
821 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
822 # set when the operation is created.
823 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
824 # text format.
825 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
826 # this field will be populated.
827 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
828 # operation.
829 {
830 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
831 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
832 # details. There is a set of defined message types to use for providing
833 # details.The syntax depends on the error code. For example,
834 # QuotaExceededInfo will have details when the error code is
835 # QUOTA_EXCEEDED.
836 {
837 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
838 #
839 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
840 # is not enabled:
841 #
842 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
843 # &quot;domain&quot;: &quot;googleapis.com&quot;
844 # &quot;metadata&quot;: {
845 # &quot;resource&quot;: &quot;projects/123&quot;,
846 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
847 # }
848 # }
849 #
850 # This response indicates that the pubsub.googleapis.com API is not enabled.
851 #
852 # Example of an error that is returned when attempting to create a Spanner
853 # instance in a region that is out of stock:
854 #
855 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
856 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
857 # &quot;metadata&quot;: {
858 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
859 # }
860 # }
861 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
862 # is typically the registered service name of the tool or product that
863 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
864 # generated by some common infrastructure, the error domain must be a
865 # globally unique value that identifies the infrastructure. For Google API
866 # infrastructure, the error domain is &quot;googleapis.com&quot;.
867 &quot;metadatas&quot;: { # Additional structured details about this error.
868 #
869 # Keys must match a regular expression of `a-z+` but should
870 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
871 # length. When identifying the current value of an exceeded limit, the units
872 # should be contained in the key, not the value. For example, rather than
873 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
874 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
875 # instances that can be created in a single (batch) request.
876 &quot;a_key&quot;: &quot;A String&quot;,
877 },
878 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
879 # proximate cause of the error. Error reasons are unique within a particular
880 # domain of errors. This should be at most 63 characters and match a
881 # regular expression of `A-Z+[A-Z0-9]`, which represents
882 # UPPER_SNAKE_CASE.
883 },
884 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
885 #
886 # For example, if a quota check failed with an error indicating the calling
887 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
888 # directly to the right place in the developer console to flip the bit.
889 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
890 { # Describes a URL link.
891 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
892 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
893 },
894 ],
895 },
896 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
897 # which can be attached to an RPC error.
898 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
899 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
900 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
901 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
902 },
903 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
904 &quot;dimensions&quot;: { # The map holding related quota dimensions.
905 &quot;a_key&quot;: &quot;A String&quot;,
906 },
907 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
908 # type or metric.
909 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
910 # or metric.
911 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
912 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
913 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
914 },
915 },
916 ],
917 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
918 # This property is optional.
919 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
920 },
921 ],
922 },
923 &quot;getVersionOperationMetadata&quot;: {
924 &quot;inlineSbomInfo&quot;: {
925 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
926 # appropriate identifiers.
927 &quot;a_key&quot;: &quot;A String&quot;,
928 },
929 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
930 # identifiers.
931 &quot;a_key&quot;: &quot;A String&quot;,
932 },
933 },
934 },
935 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
936 # message that was returned, such as `NOT FOUND`.
937 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
938 # status code that was returned. For example, a `404` means the
939 # resource was not found.
940 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
941 # defined by the server.
942 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
943 # This value is inRFC3339
944 # text format.
945 &quot;instancesBulkInsertOperationMetadata&quot;: {
946 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
947 # Example key: zones/us-central1-a
948 &quot;a_key&quot;: {
949 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
950 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
951 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
952 # error.
953 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
954 # if the flow is rolling forward or rolling back.
955 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
956 },
957 },
958 },
959 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
960 # Operation resources.
961 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
962 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
963 # group of operations results from a `bulkInsert` API request.
964 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
965 # `update`, or `delete`, and so on.
966 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
967 # There is no requirement that this be linear or support any granularity of
968 # operations. This should not be used to guess when the operation will be
969 # complete. This number should monotonically increase as the operation
970 # progresses.
971 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
972 # applicable when performing regional operations.
973 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
974 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
975 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
976 # this field will contain information on all underlying zonal actions and
977 # their state.
978 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
979 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
980 # Example key: zones/us-central1-a
981 &quot;a_key&quot;: {
982 &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
983 # populated.
984 # different programming environments, including REST APIs and RPC APIs. It is
985 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
986 # three pieces of data: error code, error message, and error details.
987 #
988 # You can find out more about this error model and how to work with it in the
989 # [API Design Guide](https://cloud.google.com/apis/design/errors).
990 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
991 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
992 # message types for APIs to use.
993 {
994 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
995 },
996 ],
997 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
998 # user-facing error message should be localized and sent in the
999 # google.rpc.Status.details field, or localized by the client.
1000 },
1001 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1002 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1003 },
1004 },
1005 },
1006 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1007 # This value is inRFC3339
1008 # text format.
1009 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1010 # following:
1011 # `PENDING`, `RUNNING`, or `DONE`.
1012 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1013 # operation.
1014 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1015 # of the target resource.
1016 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1017 # operations related to creating a snapshot, this points to the disk
1018 # that the snapshot was created from.
1019 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1020 # `[email protected]` or
1021 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1022 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1023 # operation, this field will be populated.
1024 {
1025 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1026 # Engine returns NO_RESULTS_ON_PAGE if there
1027 # are no results in the response.
1028 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1029 # value format. For example:
1030 #
1031 # &quot;data&quot;: [
1032 # {
1033 # &quot;key&quot;: &quot;scope&quot;,
1034 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1035 # }
1036 {
1037 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1038 # returned. For example, for warnings where there are no results in a list
1039 # request for a particular zone, this key might be scope and
1040 # the key value might be the zone name. Other examples might be a key
1041 # indicating a deprecated resource and a suggested replacement, or a
1042 # warning about invalid network settings (for example, if an instance
1043 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1044 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1045 },
1046 ],
1047 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1048 },
1049 ],
1050 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1051 # applicable when performing per-zone operations.
1052 }</pre>
1053 </div>
1054
1055 <div class="method">
1056 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1057 <pre>Retrieves the list of firewall rules available to the specified
1058 project.
1059
1060 Args:
1061 project: string, Project ID for this request. (required)
1062 filter: string, A filter expression that filters resources listed in the response. Most
1063 Compute resources support two types of filter expressions:
1064 expressions that support regular expressions and expressions that follow
1065 API improvement proposal AIP-160.
1066 These two types of filter expressions cannot be mixed in one request.
1067
1068 If you want to use AIP-160, your expression must specify the field name, an
1069 operator, and the value that you want to use for filtering. The value
1070 must be a string, a number, or a boolean. The operator
1071 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1072
1073 For example, if you are filtering Compute Engine instances, you can
1074 exclude instances named `example-instance` by specifying
1075 `name != example-instance`.
1076
1077 The `:*` comparison can be used to test whether a key has been defined.
1078 For example, to find all objects with `owner` label use:
1079 ```
1080 labels.owner:*
1081 ```
1082
1083 You can also filter nested fields. For example, you could specify
1084 `scheduling.automaticRestart = false` to include instances only
1085 if they are not scheduled for automatic restarts. You can use filtering
1086 on nested fields to filter based onresource labels.
1087
1088 To filter on multiple expressions, provide each separate expression within
1089 parentheses. For example:
1090 ```
1091 (scheduling.automaticRestart = true)
1092 (cpuPlatform = &quot;Intel Skylake&quot;)
1093 ```
1094 By default, each expression is an `AND` expression. However, you
1095 can include `AND` and `OR` expressions explicitly.
1096 For example:
1097 ```
1098 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1099 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1100 (scheduling.automaticRestart = true)
1101 ```
1102
1103 If you want to use a regular expression, use the `eq` (equal) or `ne`
1104 (not equal) operator against a single un-parenthesized expression with or
1105 without quotes or against multiple parenthesized expressions. Examples:
1106
1107 `fieldname eq unquoted literal`
1108 `fieldname eq &#x27;single quoted literal&#x27;`
1109 `fieldname eq &quot;double quoted literal&quot;`
1110 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1111
1112 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1113 The literal value must match the entire field.
1114
1115 For example, to filter for instances that do not end with name &quot;instance&quot;,
1116 you would use `name ne .*instance`.
1117
1118 You cannot combine constraints on multiple fields using regular
1119 expressions.
1120 maxResults: integer, The maximum number of results per page that should be returned.
1121 If the number of available results is larger than `maxResults`,
1122 Compute Engine returns a `nextPageToken` that can be used to get
1123 the next page of results in subsequent list requests. Acceptable values are
1124 `0` to `500`, inclusive. (Default: `500`)
1125 orderBy: string, Sorts list results by a certain order. By default, results
1126 are returned in alphanumerical order based on the resource name.
1127
1128 You can also sort results in descending order based on the creation
1129 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1130 results based on the `creationTimestamp` field in
1131 reverse chronological order (newest result first). Use this to sort
1132 resources like operations so that the newest operation is returned first.
1133
1134 Currently, only sorting by `name` or
1135 `creationTimestamp desc` is supported.
1136 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1137 `nextPageToken` returned by a previous list request to get
1138 the next page of results.
1139 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1140 of failure. The default value is false.
1141
1142 For example, when partial success behavior is enabled, aggregatedList for a
1143 single zone scope either returns all resources in the zone or no resources,
1144 with an error code.
1145 x__xgafv: string, V1 error format.
1146 Allowed values
1147 1 - v1 error format
1148 2 - v2 error format
1149
1150 Returns:
1151 An object of the form:
1152
1153 { # Contains a list of firewalls.
1154 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1155 &quot;items&quot;: [ # A list of Firewall resources.
1156 { # Represents a Firewall Rule resource.
1157 #
1158 # Firewall rules allow or deny ingress traffic to, and egress traffic from your
1159 # instances. For more information, readFirewall rules.
1160 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a
1161 # protocol and port-range tuple that describes a permitted connection.
1162 {
1163 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1164 # required when creating a firewall rule. This value can either be one of the
1165 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
1166 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
1167 # This field is only applicable for the UDP or TCP protocol.
1168 # Each entry must be either an integer or a range.
1169 # If not specified, this rule applies to connections through any port.
1170 #
1171 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
1172 # and [&quot;12345-12349&quot;].
1173 &quot;A String&quot;,
1174 ],
1175 },
1176 ],
1177 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1178 # text format.
1179 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a
1180 # protocol and port-range tuple that describes a denied connection.
1181 {
1182 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1183 # required when creating a firewall rule. This value can either be one of the
1184 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
1185 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
1186 # This field is only applicable for the UDP or TCP protocol.
1187 # Each entry must be either an integer or a range.
1188 # If not specified, this rule applies to connections through any port.
1189 #
1190 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
1191 # and [&quot;12345-12349&quot;].
1192 &quot;A String&quot;,
1193 ],
1194 },
1195 ],
1196 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
1197 # create the resource.
1198 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to
1199 # traffic that has destination IP address in these ranges. These ranges must
1200 # be expressed inCIDR format. Both IPv4 and IPv6 are supported.
1201 &quot;A String&quot;,
1202 ],
1203 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or
1204 # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot
1205 # specify the sourceTags fields.
1206 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the
1207 # firewall rule is not enforced and the network behaves as if it did not
1208 # exist. If this is unspecified, the firewall rule will be enabled.
1209 &quot;enableLogging&quot;: True or False, # Deprecated in favor of enable in LogConfig.
1210 # This field denotes whether to enable logging for a particular
1211 # firewall rule. If logging is enabled, logs will be exported t
1212 # Cloud Logging.
1213 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1214 # defined by the server.
1215 &quot;kind&quot;: &quot;compute#firewall&quot;, # Output only. [Output Only] Type of the resource. Always compute#firewall
1216 # for firewall rules.
1217 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If
1218 # logging is enabled, logs will be exported to Cloud Logging.
1219 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall
1220 # rule.
1221 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if
1222 # logging is enabled for that rule. This field denotes whether to include
1223 # or exclude metadata for firewall logs.
1224 },
1225 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1226 # The name must be 1-63 characters long, and comply withRFC1035.
1227 # Specifically, the name must be 1-63 characters long and match the regular
1228 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character
1229 # must be a lowercase letter, and all following characters (except for the
1230 # last character) must be a dash, lowercase letter, or digit. The last
1231 # character must be a lowercase letter or digit.
1232 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not
1233 # specified when creating a firewall rule, the default network
1234 # is used:
1235 #
1236 # global/networks/default
1237 #
1238 # If you choose to specify this field, you can specify the network as a full
1239 # or partial URL. For example, the following are all valid URLs:
1240 #
1241 # -
1242 # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
1243 # - projects/myproject/global/networks/my-network
1244 # - global/networks/default
1245 &quot;params&quot;: { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1246 # as part of resource payload.
1247 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1248 # Tag keys and values have the same definition as resource
1249 # manager tags. The field is allowed for INSERT
1250 # only. The keys/values to set on the resource should be specified in
1251 # either ID { : } or Namespaced format
1252 # { : }.
1253 # For example the following are valid inputs:
1254 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1255 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1256 # Note:
1257 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1258 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1259 &quot;a_key&quot;: &quot;A String&quot;,
1260 },
1261 },
1262 &quot;priority&quot;: 42, # Priority for this rule.
1263 # This is an integer between `0` and `65535`, both inclusive.
1264 # The default value is `1000`.
1265 # Relative priorities determine which rule takes effect if multiple rules
1266 # apply. Lower values indicate higher priority. For example, a rule with
1267 # priority `0` has higher precedence than a rule with priority `1`.
1268 # DENY rules take precedence over ALLOW rules if they have equal priority.
1269 # Note that VPC networks have implied
1270 # rules with a priority of `65535`. To avoid conflicts with the implied
1271 # rules, use a priority number less than `65535`.
1272 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1273 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1274 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic
1275 # that has a source IP address in these ranges. These ranges must be
1276 # expressed inCIDR format. One or both of sourceRanges
1277 # and sourceTags may be set.
1278 # If both fields are set, the rule applies to traffic that has a
1279 # source IP address within sourceRanges OR a source IP
1280 # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match
1281 # both fields for the rule to
1282 # apply. Both IPv4 and IPv6 are supported.
1283 &quot;A String&quot;,
1284 ],
1285 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to
1286 # traffic originating from an instance with a service account in this list.
1287 # Source service accounts cannot be used to control traffic to an instance&#x27;s
1288 # external IP address because service accounts are associated with an
1289 # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.
1290 # If both are set, the firewall applies to traffic that
1291 # has a source IP address within the sourceRanges OR a source
1292 # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match
1293 # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.
1294 &quot;A String&quot;,
1295 ],
1296 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic
1297 # with source IPs that match the primary network interfaces of VM instances
1298 # that have the tag and are in the same VPC network.
1299 # Source tags cannot be used to control traffic to an instance&#x27;s external IP
1300 # address, it only applies to traffic between instances in the same virtual
1301 # network. Because tags are associated with instances, not IP addresses.
1302 # One or both of sourceRanges and sourceTags may be
1303 # set. If both fields are set, the firewall applies to traffic that has a
1304 # source IP address within sourceRanges OR a source IP from a
1305 # resource with a matching tag listed in the sourceTags
1306 # field. The connection does not need to match both fields for the
1307 # firewall to apply.
1308 &quot;A String&quot;,
1309 ],
1310 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the
1311 # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.
1312 # If neither targetServiceAccounts nor targetTags
1313 # are specified, the firewall rule applies to all instances on the specified
1314 # network.
1315 &quot;A String&quot;,
1316 ],
1317 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule
1318 # applies to. If targetTags are specified, then the firewall
1319 # rule applies only to instances in the VPC network that have one of those
1320 # tags. If no targetTags are specified, the firewall rule
1321 # applies to all instances on the specified network.
1322 &quot;A String&quot;,
1323 ],
1324 },
1325 ],
1326 &quot;kind&quot;: &quot;compute#firewallList&quot;, # Output only. [Output Only] Type of resource. Always compute#firewallList
1327 # for lists of firewalls.
1328 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1329 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1330 # the query parameter pageToken in the next list request.
1331 # Subsequent list requests will have their own nextPageToken to
1332 # continue paging through the results.
1333 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1334 &quot;warning&quot;: { # [Output Only] Informational warning message.
1335 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1336 # Engine returns NO_RESULTS_ON_PAGE if there
1337 # are no results in the response.
1338 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1339 # value format. For example:
1340 #
1341 # &quot;data&quot;: [
1342 # {
1343 # &quot;key&quot;: &quot;scope&quot;,
1344 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1345 # }
1346 {
1347 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1348 # returned. For example, for warnings where there are no results in a list
1349 # request for a particular zone, this key might be scope and
1350 # the key value might be the zone name. Other examples might be a key
1351 # indicating a deprecated resource and a suggested replacement, or a
1352 # warning about invalid network settings (for example, if an instance
1353 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1354 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1355 },
1356 ],
1357 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1358 },
1359 }</pre>
1360 </div>
1361
1362 <div class="method">
1363 <code class="details" id="list_next">list_next()</code>
1364 <pre>Retrieves the next page of results.
1365
1366 Args:
1367 previous_request: The request for the previous page. (required)
1368 previous_response: The response from the request for the previous page. (required)
1369
1370 Returns:
1371 A request object that you can call &#x27;execute()&#x27; on to request the next
1372 page. Returns None if there are no more items in the collection.
1373 </pre>
1374 </div>
1375
1376 <div class="method">
1377 <code class="details" id="patch">patch(project, firewall, body=None, requestId=None, x__xgafv=None)</code>
1378 <pre>Updates the specified firewall rule with the data included in the
1379 request. This method supportsPATCH
1380 semantics and uses theJSON merge
1381 patch format and processing rules.
1382
1383 Args:
1384 project: string, Project ID for this request. (required)
1385 firewall: string, Name of the firewall rule to patch. (required)
1386 body: object, The request body.
1387 The object takes the form of:
1388
1389 { # Represents a Firewall Rule resource.
1390 #
1391 # Firewall rules allow or deny ingress traffic to, and egress traffic from your
1392 # instances. For more information, readFirewall rules.
1393 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a
1394 # protocol and port-range tuple that describes a permitted connection.
1395 {
1396 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1397 # required when creating a firewall rule. This value can either be one of the
1398 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
1399 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
1400 # This field is only applicable for the UDP or TCP protocol.
1401 # Each entry must be either an integer or a range.
1402 # If not specified, this rule applies to connections through any port.
1403 #
1404 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
1405 # and [&quot;12345-12349&quot;].
1406 &quot;A String&quot;,
1407 ],
1408 },
1409 ],
1410 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1411 # text format.
1412 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a
1413 # protocol and port-range tuple that describes a denied connection.
1414 {
1415 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1416 # required when creating a firewall rule. This value can either be one of the
1417 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
1418 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
1419 # This field is only applicable for the UDP or TCP protocol.
1420 # Each entry must be either an integer or a range.
1421 # If not specified, this rule applies to connections through any port.
1422 #
1423 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
1424 # and [&quot;12345-12349&quot;].
1425 &quot;A String&quot;,
1426 ],
1427 },
1428 ],
1429 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
1430 # create the resource.
1431 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to
1432 # traffic that has destination IP address in these ranges. These ranges must
1433 # be expressed inCIDR format. Both IPv4 and IPv6 are supported.
1434 &quot;A String&quot;,
1435 ],
1436 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or
1437 # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot
1438 # specify the sourceTags fields.
1439 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the
1440 # firewall rule is not enforced and the network behaves as if it did not
1441 # exist. If this is unspecified, the firewall rule will be enabled.
1442 &quot;enableLogging&quot;: True or False, # Deprecated in favor of enable in LogConfig.
1443 # This field denotes whether to enable logging for a particular
1444 # firewall rule. If logging is enabled, logs will be exported t
1445 # Cloud Logging.
1446 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1447 # defined by the server.
1448 &quot;kind&quot;: &quot;compute#firewall&quot;, # Output only. [Output Only] Type of the resource. Always compute#firewall
1449 # for firewall rules.
1450 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If
1451 # logging is enabled, logs will be exported to Cloud Logging.
1452 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall
1453 # rule.
1454 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if
1455 # logging is enabled for that rule. This field denotes whether to include
1456 # or exclude metadata for firewall logs.
1457 },
1458 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1459 # The name must be 1-63 characters long, and comply withRFC1035.
1460 # Specifically, the name must be 1-63 characters long and match the regular
1461 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character
1462 # must be a lowercase letter, and all following characters (except for the
1463 # last character) must be a dash, lowercase letter, or digit. The last
1464 # character must be a lowercase letter or digit.
1465 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not
1466 # specified when creating a firewall rule, the default network
1467 # is used:
1468 #
1469 # global/networks/default
1470 #
1471 # If you choose to specify this field, you can specify the network as a full
1472 # or partial URL. For example, the following are all valid URLs:
1473 #
1474 # -
1475 # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
1476 # - projects/myproject/global/networks/my-network
1477 # - global/networks/default
1478 &quot;params&quot;: { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1479 # as part of resource payload.
1480 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1481 # Tag keys and values have the same definition as resource
1482 # manager tags. The field is allowed for INSERT
1483 # only. The keys/values to set on the resource should be specified in
1484 # either ID { : } or Namespaced format
1485 # { : }.
1486 # For example the following are valid inputs:
1487 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1488 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1489 # Note:
1490 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1491 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1492 &quot;a_key&quot;: &quot;A String&quot;,
1493 },
1494 },
1495 &quot;priority&quot;: 42, # Priority for this rule.
1496 # This is an integer between `0` and `65535`, both inclusive.
1497 # The default value is `1000`.
1498 # Relative priorities determine which rule takes effect if multiple rules
1499 # apply. Lower values indicate higher priority. For example, a rule with
1500 # priority `0` has higher precedence than a rule with priority `1`.
1501 # DENY rules take precedence over ALLOW rules if they have equal priority.
1502 # Note that VPC networks have implied
1503 # rules with a priority of `65535`. To avoid conflicts with the implied
1504 # rules, use a priority number less than `65535`.
1505 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1506 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1507 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic
1508 # that has a source IP address in these ranges. These ranges must be
1509 # expressed inCIDR format. One or both of sourceRanges
1510 # and sourceTags may be set.
1511 # If both fields are set, the rule applies to traffic that has a
1512 # source IP address within sourceRanges OR a source IP
1513 # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match
1514 # both fields for the rule to
1515 # apply. Both IPv4 and IPv6 are supported.
1516 &quot;A String&quot;,
1517 ],
1518 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to
1519 # traffic originating from an instance with a service account in this list.
1520 # Source service accounts cannot be used to control traffic to an instance&#x27;s
1521 # external IP address because service accounts are associated with an
1522 # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.
1523 # If both are set, the firewall applies to traffic that
1524 # has a source IP address within the sourceRanges OR a source
1525 # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match
1526 # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.
1527 &quot;A String&quot;,
1528 ],
1529 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic
1530 # with source IPs that match the primary network interfaces of VM instances
1531 # that have the tag and are in the same VPC network.
1532 # Source tags cannot be used to control traffic to an instance&#x27;s external IP
1533 # address, it only applies to traffic between instances in the same virtual
1534 # network. Because tags are associated with instances, not IP addresses.
1535 # One or both of sourceRanges and sourceTags may be
1536 # set. If both fields are set, the firewall applies to traffic that has a
1537 # source IP address within sourceRanges OR a source IP from a
1538 # resource with a matching tag listed in the sourceTags
1539 # field. The connection does not need to match both fields for the
1540 # firewall to apply.
1541 &quot;A String&quot;,
1542 ],
1543 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the
1544 # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.
1545 # If neither targetServiceAccounts nor targetTags
1546 # are specified, the firewall rule applies to all instances on the specified
1547 # network.
1548 &quot;A String&quot;,
1549 ],
1550 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule
1551 # applies to. If targetTags are specified, then the firewall
1552 # rule applies only to instances in the VPC network that have one of those
1553 # tags. If no targetTags are specified, the firewall rule
1554 # applies to all instances on the specified network.
1555 &quot;A String&quot;,
1556 ],
1557 }
1558
1559 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1560 that if you must retry your request, the server will know to ignore the
1561 request if it has already been completed.
1562
1563 For example, consider a situation where you make an initial request and
1564 the request times out. If you make the request again with the same
1565 request ID, the server can check if original operation with the same
1566 request ID was received, and if so, will ignore the second request. This
1567 prevents clients from accidentally creating duplicate commitments.
1568
1569 The request ID must be
1570 a valid UUID with the exception that zero UUID is not supported
1571 (00000000-0000-0000-0000-000000000000).
1572 x__xgafv: string, V1 error format.
1573 Allowed values
1574 1 - v1 error format
1575 2 - v2 error format
1576
1577 Returns:
1578 An object of the form:
1579
1580 { # Represents an Operation resource.
1581 #
1582 # Google Compute Engine has three Operation resources:
1583 #
1584 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1585 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1586 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1587 #
1588 # You can use an operation resource to manage asynchronous API requests.
1589 # For more information, readHandling
1590 # API responses.
1591 #
1592 # Operations can be global, regional or zonal.
1593 #
1594 # - For global operations, use the `globalOperations`
1595 # resource.
1596 # - For regional operations, use the
1597 # `regionOperations` resource.
1598 # - For zonal operations, use
1599 # the `zoneOperations` resource.
1600 #
1601 #
1602 #
1603 # For more information, read
1604 # Global, Regional, and Zonal Resources.
1605 #
1606 # Note that completed Operation resources have a limited
1607 # retention period.
1608 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1609 # Not present otherwise.
1610 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1611 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1612 # set when the operation is created.
1613 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1614 # text format.
1615 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1616 # this field will be populated.
1617 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1618 # operation.
1619 {
1620 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1621 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1622 # details. There is a set of defined message types to use for providing
1623 # details.The syntax depends on the error code. For example,
1624 # QuotaExceededInfo will have details when the error code is
1625 # QUOTA_EXCEEDED.
1626 {
1627 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1628 #
1629 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1630 # is not enabled:
1631 #
1632 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1633 # &quot;domain&quot;: &quot;googleapis.com&quot;
1634 # &quot;metadata&quot;: {
1635 # &quot;resource&quot;: &quot;projects/123&quot;,
1636 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1637 # }
1638 # }
1639 #
1640 # This response indicates that the pubsub.googleapis.com API is not enabled.
1641 #
1642 # Example of an error that is returned when attempting to create a Spanner
1643 # instance in a region that is out of stock:
1644 #
1645 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1646 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1647 # &quot;metadata&quot;: {
1648 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1649 # }
1650 # }
1651 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1652 # is typically the registered service name of the tool or product that
1653 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1654 # generated by some common infrastructure, the error domain must be a
1655 # globally unique value that identifies the infrastructure. For Google API
1656 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1657 &quot;metadatas&quot;: { # Additional structured details about this error.
1658 #
1659 # Keys must match a regular expression of `a-z+` but should
1660 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1661 # length. When identifying the current value of an exceeded limit, the units
1662 # should be contained in the key, not the value. For example, rather than
1663 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1664 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1665 # instances that can be created in a single (batch) request.
1666 &quot;a_key&quot;: &quot;A String&quot;,
1667 },
1668 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1669 # proximate cause of the error. Error reasons are unique within a particular
1670 # domain of errors. This should be at most 63 characters and match a
1671 # regular expression of `A-Z+[A-Z0-9]`, which represents
1672 # UPPER_SNAKE_CASE.
1673 },
1674 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1675 #
1676 # For example, if a quota check failed with an error indicating the calling
1677 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1678 # directly to the right place in the developer console to flip the bit.
1679 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1680 { # Describes a URL link.
1681 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1682 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1683 },
1684 ],
1685 },
1686 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1687 # which can be attached to an RPC error.
1688 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1689 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1690 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1691 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1692 },
1693 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1694 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1695 &quot;a_key&quot;: &quot;A String&quot;,
1696 },
1697 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1698 # type or metric.
1699 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1700 # or metric.
1701 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1702 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1703 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1704 },
1705 },
1706 ],
1707 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1708 # This property is optional.
1709 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1710 },
1711 ],
1712 },
1713 &quot;getVersionOperationMetadata&quot;: {
1714 &quot;inlineSbomInfo&quot;: {
1715 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1716 # appropriate identifiers.
1717 &quot;a_key&quot;: &quot;A String&quot;,
1718 },
1719 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1720 # identifiers.
1721 &quot;a_key&quot;: &quot;A String&quot;,
1722 },
1723 },
1724 },
1725 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1726 # message that was returned, such as `NOT FOUND`.
1727 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1728 # status code that was returned. For example, a `404` means the
1729 # resource was not found.
1730 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1731 # defined by the server.
1732 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1733 # This value is inRFC3339
1734 # text format.
1735 &quot;instancesBulkInsertOperationMetadata&quot;: {
1736 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1737 # Example key: zones/us-central1-a
1738 &quot;a_key&quot;: {
1739 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1740 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1741 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1742 # error.
1743 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1744 # if the flow is rolling forward or rolling back.
1745 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1746 },
1747 },
1748 },
1749 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1750 # Operation resources.
1751 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1752 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1753 # group of operations results from a `bulkInsert` API request.
1754 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1755 # `update`, or `delete`, and so on.
1756 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1757 # There is no requirement that this be linear or support any granularity of
1758 # operations. This should not be used to guess when the operation will be
1759 # complete. This number should monotonically increase as the operation
1760 # progresses.
1761 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1762 # applicable when performing regional operations.
1763 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1764 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1765 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1766 # this field will contain information on all underlying zonal actions and
1767 # their state.
1768 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1769 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1770 # Example key: zones/us-central1-a
1771 &quot;a_key&quot;: {
1772 &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
1773 # populated.
1774 # different programming environments, including REST APIs and RPC APIs. It is
1775 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1776 # three pieces of data: error code, error message, and error details.
1777 #
1778 # You can find out more about this error model and how to work with it in the
1779 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1780 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1781 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1782 # message types for APIs to use.
1783 {
1784 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1785 },
1786 ],
1787 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1788 # user-facing error message should be localized and sent in the
1789 # google.rpc.Status.details field, or localized by the client.
1790 },
1791 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1792 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1793 },
1794 },
1795 },
1796 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1797 # This value is inRFC3339
1798 # text format.
1799 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1800 # following:
1801 # `PENDING`, `RUNNING`, or `DONE`.
1802 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1803 # operation.
1804 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1805 # of the target resource.
1806 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1807 # operations related to creating a snapshot, this points to the disk
1808 # that the snapshot was created from.
1809 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1810 # `[email protected]` or
1811 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1812 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1813 # operation, this field will be populated.
1814 {
1815 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1816 # Engine returns NO_RESULTS_ON_PAGE if there
1817 # are no results in the response.
1818 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1819 # value format. For example:
1820 #
1821 # &quot;data&quot;: [
1822 # {
1823 # &quot;key&quot;: &quot;scope&quot;,
1824 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1825 # }
1826 {
1827 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1828 # returned. For example, for warnings where there are no results in a list
1829 # request for a particular zone, this key might be scope and
1830 # the key value might be the zone name. Other examples might be a key
1831 # indicating a deprecated resource and a suggested replacement, or a
1832 # warning about invalid network settings (for example, if an instance
1833 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1834 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1835 },
1836 ],
1837 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1838 },
1839 ],
1840 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1841 # applicable when performing per-zone operations.
1842 }</pre>
1843 </div>
1844
1845 <div class="method">
1846 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
1847 <pre>Returns permissions that a caller has on the specified resource.
1848
1849 Args:
1850 project: string, Project ID for this request. (required)
1851 resource: string, Name or id of the resource for this request. (required)
1852 body: object, The request body.
1853 The object takes the form of:
1854
1855 {
1856 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
1857 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1858 &quot;A String&quot;,
1859 ],
1860 }
1861
1862 x__xgafv: string, V1 error format.
1863 Allowed values
1864 1 - v1 error format
1865 2 - v2 error format
1866
1867 Returns:
1868 An object of the form:
1869
1870 {
1871 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1872 # allowed.
1873 &quot;A String&quot;,
1874 ],
1875 }</pre>
1876 </div>
1877
1878 <div class="method">
1879 <code class="details" id="update">update(project, firewall, body=None, requestId=None, x__xgafv=None)</code>
1880 <pre>Updates the specified firewall rule with the data included in the
1881 request.
1882 Note that all fields will be updated if using PUT, even fields that are not
1883 specified. To update individual fields, please use PATCH instead.
1884
1885 Args:
1886 project: string, Project ID for this request. (required)
1887 firewall: string, Name of the firewall rule to update. (required)
1888 body: object, The request body.
1889 The object takes the form of:
1890
1891 { # Represents a Firewall Rule resource.
1892 #
1893 # Firewall rules allow or deny ingress traffic to, and egress traffic from your
1894 # instances. For more information, readFirewall rules.
1895 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a
1896 # protocol and port-range tuple that describes a permitted connection.
1897 {
1898 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1899 # required when creating a firewall rule. This value can either be one of the
1900 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
1901 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
1902 # This field is only applicable for the UDP or TCP protocol.
1903 # Each entry must be either an integer or a range.
1904 # If not specified, this rule applies to connections through any port.
1905 #
1906 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
1907 # and [&quot;12345-12349&quot;].
1908 &quot;A String&quot;,
1909 ],
1910 },
1911 ],
1912 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1913 # text format.
1914 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a
1915 # protocol and port-range tuple that describes a denied connection.
1916 {
1917 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1918 # required when creating a firewall rule. This value can either be one of the
1919 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
1920 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
1921 # This field is only applicable for the UDP or TCP protocol.
1922 # Each entry must be either an integer or a range.
1923 # If not specified, this rule applies to connections through any port.
1924 #
1925 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
1926 # and [&quot;12345-12349&quot;].
1927 &quot;A String&quot;,
1928 ],
1929 },
1930 ],
1931 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
1932 # create the resource.
1933 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to
1934 # traffic that has destination IP address in these ranges. These ranges must
1935 # be expressed inCIDR format. Both IPv4 and IPv6 are supported.
1936 &quot;A String&quot;,
1937 ],
1938 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or
1939 # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot
1940 # specify the sourceTags fields.
1941 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the
1942 # firewall rule is not enforced and the network behaves as if it did not
1943 # exist. If this is unspecified, the firewall rule will be enabled.
1944 &quot;enableLogging&quot;: True or False, # Deprecated in favor of enable in LogConfig.
1945 # This field denotes whether to enable logging for a particular
1946 # firewall rule. If logging is enabled, logs will be exported t
1947 # Cloud Logging.
1948 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1949 # defined by the server.
1950 &quot;kind&quot;: &quot;compute#firewall&quot;, # Output only. [Output Only] Type of the resource. Always compute#firewall
1951 # for firewall rules.
1952 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If
1953 # logging is enabled, logs will be exported to Cloud Logging.
1954 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall
1955 # rule.
1956 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if
1957 # logging is enabled for that rule. This field denotes whether to include
1958 # or exclude metadata for firewall logs.
1959 },
1960 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1961 # The name must be 1-63 characters long, and comply withRFC1035.
1962 # Specifically, the name must be 1-63 characters long and match the regular
1963 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character
1964 # must be a lowercase letter, and all following characters (except for the
1965 # last character) must be a dash, lowercase letter, or digit. The last
1966 # character must be a lowercase letter or digit.
1967 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not
1968 # specified when creating a firewall rule, the default network
1969 # is used:
1970 #
1971 # global/networks/default
1972 #
1973 # If you choose to specify this field, you can specify the network as a full
1974 # or partial URL. For example, the following are all valid URLs:
1975 #
1976 # -
1977 # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
1978 # - projects/myproject/global/networks/my-network
1979 # - global/networks/default
1980 &quot;params&quot;: { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1981 # as part of resource payload.
1982 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1983 # Tag keys and values have the same definition as resource
1984 # manager tags. The field is allowed for INSERT
1985 # only. The keys/values to set on the resource should be specified in
1986 # either ID { : } or Namespaced format
1987 # { : }.
1988 # For example the following are valid inputs:
1989 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1990 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1991 # Note:
1992 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1993 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1994 &quot;a_key&quot;: &quot;A String&quot;,
1995 },
1996 },
1997 &quot;priority&quot;: 42, # Priority for this rule.
1998 # This is an integer between `0` and `65535`, both inclusive.
1999 # The default value is `1000`.
2000 # Relative priorities determine which rule takes effect if multiple rules
2001 # apply. Lower values indicate higher priority. For example, a rule with
2002 # priority `0` has higher precedence than a rule with priority `1`.
2003 # DENY rules take precedence over ALLOW rules if they have equal priority.
2004 # Note that VPC networks have implied
2005 # rules with a priority of `65535`. To avoid conflicts with the implied
2006 # rules, use a priority number less than `65535`.
2007 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2008 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2009 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic
2010 # that has a source IP address in these ranges. These ranges must be
2011 # expressed inCIDR format. One or both of sourceRanges
2012 # and sourceTags may be set.
2013 # If both fields are set, the rule applies to traffic that has a
2014 # source IP address within sourceRanges OR a source IP
2015 # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match
2016 # both fields for the rule to
2017 # apply. Both IPv4 and IPv6 are supported.
2018 &quot;A String&quot;,
2019 ],
2020 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to
2021 # traffic originating from an instance with a service account in this list.
2022 # Source service accounts cannot be used to control traffic to an instance&#x27;s
2023 # external IP address because service accounts are associated with an
2024 # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.
2025 # If both are set, the firewall applies to traffic that
2026 # has a source IP address within the sourceRanges OR a source
2027 # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match
2028 # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.
2029 &quot;A String&quot;,
2030 ],
2031 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic
2032 # with source IPs that match the primary network interfaces of VM instances
2033 # that have the tag and are in the same VPC network.
2034 # Source tags cannot be used to control traffic to an instance&#x27;s external IP
2035 # address, it only applies to traffic between instances in the same virtual
2036 # network. Because tags are associated with instances, not IP addresses.
2037 # One or both of sourceRanges and sourceTags may be
2038 # set. If both fields are set, the firewall applies to traffic that has a
2039 # source IP address within sourceRanges OR a source IP from a
2040 # resource with a matching tag listed in the sourceTags
2041 # field. The connection does not need to match both fields for the
2042 # firewall to apply.
2043 &quot;A String&quot;,
2044 ],
2045 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the
2046 # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.
2047 # If neither targetServiceAccounts nor targetTags
2048 # are specified, the firewall rule applies to all instances on the specified
2049 # network.
2050 &quot;A String&quot;,
2051 ],
2052 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule
2053 # applies to. If targetTags are specified, then the firewall
2054 # rule applies only to instances in the VPC network that have one of those
2055 # tags. If no targetTags are specified, the firewall rule
2056 # applies to all instances on the specified network.
2057 &quot;A String&quot;,
2058 ],
2059 }
2060
2061 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2062 that if you must retry your request, the server will know to ignore the
2063 request if it has already been completed.
2064
2065 For example, consider a situation where you make an initial request and
2066 the request times out. If you make the request again with the same
2067 request ID, the server can check if original operation with the same
2068 request ID was received, and if so, will ignore the second request. This
2069 prevents clients from accidentally creating duplicate commitments.
2070
2071 The request ID must be
2072 a valid UUID with the exception that zero UUID is not supported
2073 (00000000-0000-0000-0000-000000000000).
2074 x__xgafv: string, V1 error format.
2075 Allowed values
2076 1 - v1 error format
2077 2 - v2 error format
2078
2079 Returns:
2080 An object of the form:
2081
2082 { # Represents an Operation resource.
2083 #
2084 # Google Compute Engine has three Operation resources:
2085 #
2086 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2087 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2088 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2089 #
2090 # You can use an operation resource to manage asynchronous API requests.
2091 # For more information, readHandling
2092 # API responses.
2093 #
2094 # Operations can be global, regional or zonal.
2095 #
2096 # - For global operations, use the `globalOperations`
2097 # resource.
2098 # - For regional operations, use the
2099 # `regionOperations` resource.
2100 # - For zonal operations, use
2101 # the `zoneOperations` resource.
2102 #
2103 #
2104 #
2105 # For more information, read
2106 # Global, Regional, and Zonal Resources.
2107 #
2108 # Note that completed Operation resources have a limited
2109 # retention period.
2110 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2111 # Not present otherwise.
2112 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2113 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2114 # set when the operation is created.
2115 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2116 # text format.
2117 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2118 # this field will be populated.
2119 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2120 # operation.
2121 {
2122 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2123 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2124 # details. There is a set of defined message types to use for providing
2125 # details.The syntax depends on the error code. For example,
2126 # QuotaExceededInfo will have details when the error code is
2127 # QUOTA_EXCEEDED.
2128 {
2129 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2130 #
2131 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2132 # is not enabled:
2133 #
2134 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2135 # &quot;domain&quot;: &quot;googleapis.com&quot;
2136 # &quot;metadata&quot;: {
2137 # &quot;resource&quot;: &quot;projects/123&quot;,
2138 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2139 # }
2140 # }
2141 #
2142 # This response indicates that the pubsub.googleapis.com API is not enabled.
2143 #
2144 # Example of an error that is returned when attempting to create a Spanner
2145 # instance in a region that is out of stock:
2146 #
2147 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2148 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2149 # &quot;metadata&quot;: {
2150 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2151 # }
2152 # }
2153 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2154 # is typically the registered service name of the tool or product that
2155 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2156 # generated by some common infrastructure, the error domain must be a
2157 # globally unique value that identifies the infrastructure. For Google API
2158 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2159 &quot;metadatas&quot;: { # Additional structured details about this error.
2160 #
2161 # Keys must match a regular expression of `a-z+` but should
2162 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2163 # length. When identifying the current value of an exceeded limit, the units
2164 # should be contained in the key, not the value. For example, rather than
2165 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2166 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2167 # instances that can be created in a single (batch) request.
2168 &quot;a_key&quot;: &quot;A String&quot;,
2169 },
2170 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2171 # proximate cause of the error. Error reasons are unique within a particular
2172 # domain of errors. This should be at most 63 characters and match a
2173 # regular expression of `A-Z+[A-Z0-9]`, which represents
2174 # UPPER_SNAKE_CASE.
2175 },
2176 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2177 #
2178 # For example, if a quota check failed with an error indicating the calling
2179 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2180 # directly to the right place in the developer console to flip the bit.
2181 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2182 { # Describes a URL link.
2183 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2184 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2185 },
2186 ],
2187 },
2188 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2189 # which can be attached to an RPC error.
2190 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2191 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2192 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2193 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2194 },
2195 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2196 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2197 &quot;a_key&quot;: &quot;A String&quot;,
2198 },
2199 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2200 # type or metric.
2201 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2202 # or metric.
2203 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2204 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2205 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2206 },
2207 },
2208 ],
2209 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2210 # This property is optional.
2211 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2212 },
2213 ],
2214 },
2215 &quot;getVersionOperationMetadata&quot;: {
2216 &quot;inlineSbomInfo&quot;: {
2217 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2218 # appropriate identifiers.
2219 &quot;a_key&quot;: &quot;A String&quot;,
2220 },
2221 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2222 # identifiers.
2223 &quot;a_key&quot;: &quot;A String&quot;,
2224 },
2225 },
2226 },
2227 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2228 # message that was returned, such as `NOT FOUND`.
2229 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2230 # status code that was returned. For example, a `404` means the
2231 # resource was not found.
2232 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2233 # defined by the server.
2234 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2235 # This value is inRFC3339
2236 # text format.
2237 &quot;instancesBulkInsertOperationMetadata&quot;: {
2238 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2239 # Example key: zones/us-central1-a
2240 &quot;a_key&quot;: {
2241 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2242 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2243 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2244 # error.
2245 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2246 # if the flow is rolling forward or rolling back.
2247 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2248 },
2249 },
2250 },
2251 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2252 # Operation resources.
2253 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2254 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2255 # group of operations results from a `bulkInsert` API request.
2256 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2257 # `update`, or `delete`, and so on.
2258 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2259 # There is no requirement that this be linear or support any granularity of
2260 # operations. This should not be used to guess when the operation will be
2261 # complete. This number should monotonically increase as the operation
2262 # progresses.
2263 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2264 # applicable when performing regional operations.
2265 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2266 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2267 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2268 # this field will contain information on all underlying zonal actions and
2269 # their state.
2270 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2271 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2272 # Example key: zones/us-central1-a
2273 &quot;a_key&quot;: {
2274 &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
2275 # populated.
2276 # different programming environments, including REST APIs and RPC APIs. It is
2277 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2278 # three pieces of data: error code, error message, and error details.
2279 #
2280 # You can find out more about this error model and how to work with it in the
2281 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2282 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2283 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2284 # message types for APIs to use.
2285 {
2286 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2287 },
2288 ],
2289 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2290 # user-facing error message should be localized and sent in the
2291 # google.rpc.Status.details field, or localized by the client.
2292 },
2293 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2294 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2295 },
2296 },
2297 },
2298 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2299 # This value is inRFC3339
2300 # text format.
2301 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2302 # following:
2303 # `PENDING`, `RUNNING`, or `DONE`.
2304 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2305 # operation.
2306 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2307 # of the target resource.
2308 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2309 # operations related to creating a snapshot, this points to the disk
2310 # that the snapshot was created from.
2311 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2312 # `[email protected]` or
2313 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2314 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2315 # operation, this field will be populated.
2316 {
2317 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2318 # Engine returns NO_RESULTS_ON_PAGE if there
2319 # are no results in the response.
2320 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2321 # value format. For example:
2322 #
2323 # &quot;data&quot;: [
2324 # {
2325 # &quot;key&quot;: &quot;scope&quot;,
2326 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2327 # }
2328 {
2329 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2330 # returned. For example, for warnings where there are no results in a list
2331 # request for a particular zone, this key might be scope and
2332 # the key value might be the zone name. Other examples might be a key
2333 # indicating a deprecated resource and a suggested replacement, or a
2334 # warning about invalid network settings (for example, if an instance
2335 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2336 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2337 },
2338 ],
2339 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2340 },
2341 ],
2342 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2343 # applicable when performing per-zone operations.
2344 }</pre>
2345 </div>
2346
2347 </body></html>