Debian Codegraph @

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