Debian Codegraph @

docs/dyn/compute_alpha.networks.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.networks.html">networks</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addPeering">addPeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Adds a peering to the specified network.</p>
80 <p class="toc_element">
81 <code><a href="#cancelRequestRemovePeering">cancelRequestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Cancel requests to remove a peering from the specified network. Applicable</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, network, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified network.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, network, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified network.</p>
92 <p class="toc_element">
93 <code><a href="#getEffectiveFirewalls">getEffectiveFirewalls(project, network, x__xgafv=None)</a></code></p>
94 <p class="firstline">Returns the effective firewalls on a given network.</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates a network in the specified project using the data included</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Retrieves the list of networks available to the specified project.</p>
101 <p class="toc_element">
102 <code><a href="#listIpAddresses">listIpAddresses(project, network, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, types=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Lists the internal IP addresses in the specified network.</p>
104 <p class="toc_element">
105 <code><a href="#listIpAddresses_next">listIpAddresses_next()</a></code></p>
106 <p class="firstline">Retrieves the next page of results.</p>
107 <p class="toc_element">
108 <code><a href="#listIpOwners">listIpOwners(project, network, filter=None, ipCidrRange=None, maxResults=None, orderBy=None, ownerProjects=None, ownerTypes=None, pageToken=None, returnPartialSuccess=None, subnetName=None, subnetRegion=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Lists the internal IP owners in the specified network.</p>
110 <p class="toc_element">
111 <code><a href="#listIpOwners_next">listIpOwners_next()</a></code></p>
112 <p class="firstline">Retrieves the next page of results.</p>
113 <p class="toc_element">
114 <code><a href="#listPeeringRoutes">listPeeringRoutes(project, network, direction=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peeringName=None, region=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Lists the peering routes exchanged over peering connection.</p>
116 <p class="toc_element">
117 <code><a href="#listPeeringRoutes_next">listPeeringRoutes_next()</a></code></p>
118 <p class="firstline">Retrieves the next page of results.</p>
119 <p class="toc_element">
120 <code><a href="#list_next">list_next()</a></code></p>
121 <p class="firstline">Retrieves the next page of results.</p>
122 <p class="toc_element">
123 <code><a href="#patch">patch(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Patches the specified network with the data included in the request.</p>
125 <p class="toc_element">
126 <code><a href="#removePeering">removePeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Removes a peering from the specified network.</p>
128 <p class="toc_element">
129 <code><a href="#requestRemovePeering">requestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Requests to remove a peering from the specified network. Applicable only</p>
131 <p class="toc_element">
132 <code><a href="#switchToCustomMode">switchToCustomMode(project, network, requestId=None, x__xgafv=None)</a></code></p>
133 <p class="firstline">Switches the network mode from auto subnet mode to custom subnet mode.</p>
134 <p class="toc_element">
135 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
137 <p class="toc_element">
138 <code><a href="#updatePeering">updatePeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p>
139 <p class="firstline">Updates the specified network peering with the data included in the</p>
140 <h3>Method Details</h3>
141 <div class="method">
142 <code class="details" id="addPeering">addPeering(project, network, body=None, requestId=None, x__xgafv=None)</code>
143 <pre>Adds a peering to the specified network.
144
145 Args:
146 project: string, Project ID for this request. (required)
147 network: string, Name of the network resource to add peering to. (required)
148 body: object, The request body.
149 The object takes the form of:
150
151 {
152 &quot;autoCreateRoutes&quot;: True or False, # This field will be deprecated soon. Useexchange_subnet_routes in network_peering
153 # instead.
154 # Indicates whether full mesh connectivity is created and managed
155 # automatically between peered networks. Currently this field should always
156 # be true since Google Compute Engine will automatically create and manage
157 # subnetwork routes between two networks when peering state isACTIVE.
158 &quot;exportCustomRoutes&quot;: True or False, # This field will be deprecated soon. Useexport_custom_routes in network_peering instead.
159 # Whether to export the custom routes to peer network.
160 &quot;importCustomRoutes&quot;: True or False, # This field will be deprecated soon. Useimport_custom_routes in network_peering instead.
161 # Whether to import the custom routes from peer network.
162 &quot;name&quot;: &quot;A String&quot;, # Name of the peering, which should conform to RFC1035.
163 &quot;networkPeering&quot;: { # A network peering attached to a network resource. The message includes the # Network peering parameters.
164 # In order to specify route policies for peering using import and export
165 # custom routes, you must specify all peering related parameters
166 # (name, peer network,exchange_subnet_routes) in the network_peering
167 # field.
168 # The corresponding fields in NetworksAddPeeringRequest will be
169 # deprecated soon.
170 # peering name, peer network, peering state, and a flag indicating whether
171 # Google Compute Engine should automatically create routes for the peering.
172 &quot;advertisePeerSubnetsViaRouters&quot;: True or False, # Whether Cloud Routers in this network can automatically advertise subnets
173 # from the peer network.
174 &quot;autoCreateRoutes&quot;: True or False, # This field will be deprecated soon. Use theexchange_subnet_routes field instead.
175 # Indicates whether full mesh connectivity is created and managed
176 # automatically between peered networks. Currently this field should always
177 # be true since Google Compute Engine will automatically create and manage
178 # subnetwork routes between two networks when peering state isACTIVE.
179 &quot;connectionStatus&quot;: { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection
180 # as a whole.
181 # local peering. This field provides information about the effective settings
182 # for the connection as a whole, including pending delete/update requests for
183 # CONSENSUS peerings.
184 &quot;consensusState&quot;: { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update
185 # and delete for a consensus peering connection.
186 # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the
187 # strategy to CONSENSUS.
188 &quot;deleteStatus&quot;: &quot;A String&quot;, # The status of the delete request.
189 &quot;updateStatus&quot;: &quot;A String&quot;, # The status of the update request.
190 },
191 &quot;trafficConfiguration&quot;: { # The active connectivity settings for the peering connection based on the
192 # settings of the network peerings.
193 &quot;exportCustomRoutesToPeer&quot;: True or False, # Whether custom routes are being exported to the peer network.
194 &quot;exportSubnetRoutesWithPublicIpToPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being exported to the
195 # peer network.
196 &quot;importCustomRoutesFromPeer&quot;: True or False, # Whether custom routes are being imported from the peer network.
197 &quot;importSubnetRoutesWithPublicIpFromPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being imported
198 # from the peer network.
199 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are being imported or
200 # exported between peer networks.
201 },
202 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the update/delete semantics for this
203 # peering connection.
204 },
205 &quot;exchangeSubnetRoutes&quot;: True or False, # Indicates whether full mesh connectivity is created and managed
206 # automatically between peered networks. Currently this field should always
207 # be true since Google Compute Engine will automatically create and manage
208 # subnetwork routes between two networks when peering state isACTIVE.
209 &quot;exportCustomRoutes&quot;: True or False, # Whether to export the custom routes to peer network. The default value is
210 # false.
211 &quot;exportSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are exported. The default value
212 # is true, all subnet routes are exported.IPv4
213 # special-use ranges are always
214 # exported to peers and are not controlled by this field.
215 &quot;importCustomRoutes&quot;: True or False, # Whether to import the custom routes from peer network. The default value is
216 # false.
217 &quot;importSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are imported. The default value
218 # is false.IPv4
219 # special-use ranges are always
220 # imported from peers and are not controlled by this field.
221 &quot;name&quot;: &quot;A String&quot;, # Name of this peering. Provided by the client when the peering is created.
222 # The name must comply withRFC1035.
223 # Specifically, the name must be 1-63 characters long and match regular
224 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
225 # lowercase letter, and all the following characters must be a dash,
226 # lowercase letter, or digit, except the last character, which cannot be a
227 # dash.
228 &quot;network&quot;: &quot;A String&quot;, # The URL of the peer network. It can be either full URL or partial URL. The
229 # peer network may belong to a different project. If the partial URL does not
230 # contain project, it is assumed that the peer network is in the same project
231 # as the current network.
232 &quot;peerMtu&quot;: 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network.
233 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are allowed to be imported or
234 # exported between peer networks. The default value is IPV4_ONLY.
235 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State for the peering.
236 &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. [Output Only] Details about the current state of the peering.
237 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the semantics for updates and deletes to the
238 # peering connection configuration.
239 },
240 &quot;peerNetwork&quot;: &quot;A String&quot;, # URL of the peer network. It can be either full URL or partial URL. The
241 # peer network may belong to a different project. If the partial URL does not
242 # contain project, it is assumed that the peer network is in the same project
243 # as the current network.
244 }
245
246 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
247 that if you must retry your request, the server will know to ignore the
248 request if it has already been completed.
249
250 For example, consider a situation where you make an initial request and
251 the request times out. If you make the request again with the same
252 request ID, the server can check if original operation with the same
253 request ID was received, and if so, will ignore the second request. This
254 prevents clients from accidentally creating duplicate commitments.
255
256 The request ID must be
257 a valid UUID with the exception that zero UUID is not supported
258 (00000000-0000-0000-0000-000000000000).
259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
263
264 Returns:
265 An object of the form:
266
267 { # Represents an Operation resource.
268 #
269 # Google Compute Engine has three Operation resources:
270 #
271 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
272 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
273 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
274 #
275 # You can use an operation resource to manage asynchronous API requests.
276 # For more information, readHandling
277 # API responses.
278 #
279 # Operations can be global, regional or zonal.
280 #
281 # - For global operations, use the `globalOperations`
282 # resource.
283 # - For regional operations, use the
284 # `regionOperations` resource.
285 # - For zonal operations, use
286 # the `zoneOperations` resource.
287 #
288 #
289 #
290 # For more information, read
291 # Global, Regional, and Zonal Resources.
292 #
293 # Note that completed Operation resources have a limited
294 # retention period.
295 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
296 # Not present otherwise.
297 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
298 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
299 # set when the operation is created.
300 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
301 # text format.
302 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
303 # this field will be populated.
304 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
305 # operation.
306 {
307 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
308 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
309 # details. There is a set of defined message types to use for providing
310 # details.The syntax depends on the error code. For example,
311 # QuotaExceededInfo will have details when the error code is
312 # QUOTA_EXCEEDED.
313 {
314 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
315 #
316 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
317 # is not enabled:
318 #
319 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
320 # &quot;domain&quot;: &quot;googleapis.com&quot;
321 # &quot;metadata&quot;: {
322 # &quot;resource&quot;: &quot;projects/123&quot;,
323 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
324 # }
325 # }
326 #
327 # This response indicates that the pubsub.googleapis.com API is not enabled.
328 #
329 # Example of an error that is returned when attempting to create a Spanner
330 # instance in a region that is out of stock:
331 #
332 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
333 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
334 # &quot;metadata&quot;: {
335 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
336 # }
337 # }
338 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
339 # is typically the registered service name of the tool or product that
340 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
341 # generated by some common infrastructure, the error domain must be a
342 # globally unique value that identifies the infrastructure. For Google API
343 # infrastructure, the error domain is &quot;googleapis.com&quot;.
344 &quot;metadatas&quot;: { # Additional structured details about this error.
345 #
346 # Keys must match a regular expression of `a-z+` but should
347 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
348 # length. When identifying the current value of an exceeded limit, the units
349 # should be contained in the key, not the value. For example, rather than
350 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
351 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
352 # instances that can be created in a single (batch) request.
353 &quot;a_key&quot;: &quot;A String&quot;,
354 },
355 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
356 # proximate cause of the error. Error reasons are unique within a particular
357 # domain of errors. This should be at most 63 characters and match a
358 # regular expression of `A-Z+[A-Z0-9]`, which represents
359 # UPPER_SNAKE_CASE.
360 },
361 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
362 #
363 # For example, if a quota check failed with an error indicating the calling
364 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
365 # directly to the right place in the developer console to flip the bit.
366 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
367 { # Describes a URL link.
368 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
369 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
370 },
371 ],
372 },
373 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
374 # which can be attached to an RPC error.
375 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
376 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
377 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
378 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
379 },
380 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
381 &quot;dimensions&quot;: { # The map holding related quota dimensions.
382 &quot;a_key&quot;: &quot;A String&quot;,
383 },
384 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
385 # type or metric.
386 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
387 # or metric.
388 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
389 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
390 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
391 },
392 },
393 ],
394 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
395 # This property is optional.
396 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
397 },
398 ],
399 },
400 &quot;getVersionOperationMetadata&quot;: {
401 &quot;inlineSbomInfo&quot;: {
402 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
403 # appropriate identifiers.
404 &quot;a_key&quot;: &quot;A String&quot;,
405 },
406 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
407 # identifiers.
408 &quot;a_key&quot;: &quot;A String&quot;,
409 },
410 },
411 },
412 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
413 # message that was returned, such as `NOT FOUND`.
414 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
415 # status code that was returned. For example, a `404` means the
416 # resource was not found.
417 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
418 # defined by the server.
419 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
420 # This value is inRFC3339
421 # text format.
422 &quot;instancesBulkInsertOperationMetadata&quot;: {
423 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
424 # Example key: zones/us-central1-a
425 &quot;a_key&quot;: {
426 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
427 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
428 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
429 # error.
430 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
431 # if the flow is rolling forward or rolling back.
432 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
433 },
434 },
435 },
436 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
437 # Operation resources.
438 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
439 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
440 # group of operations results from a `bulkInsert` API request.
441 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
442 # `update`, or `delete`, and so on.
443 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
444 # There is no requirement that this be linear or support any granularity of
445 # operations. This should not be used to guess when the operation will be
446 # complete. This number should monotonically increase as the operation
447 # progresses.
448 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
449 # applicable when performing regional operations.
450 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
451 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
452 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
453 # this field will contain information on all underlying zonal actions and
454 # their state.
455 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
456 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
457 # Example key: zones/us-central1-a
458 &quot;a_key&quot;: {
459 &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
460 # populated.
461 # different programming environments, including REST APIs and RPC APIs. It is
462 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
463 # three pieces of data: error code, error message, and error details.
464 #
465 # You can find out more about this error model and how to work with it in the
466 # [API Design Guide](https://cloud.google.com/apis/design/errors).
467 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
468 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
469 # message types for APIs to use.
470 {
471 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
472 },
473 ],
474 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
475 # user-facing error message should be localized and sent in the
476 # google.rpc.Status.details field, or localized by the client.
477 },
478 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
479 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
480 },
481 },
482 },
483 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
484 # This value is inRFC3339
485 # text format.
486 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
487 # following:
488 # `PENDING`, `RUNNING`, or `DONE`.
489 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
490 # operation.
491 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
492 # of the target resource.
493 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
494 # operations related to creating a snapshot, this points to the disk
495 # that the snapshot was created from.
496 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
497 # `[email protected]` or
498 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
499 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
500 # operation, this field will be populated.
501 {
502 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
503 # Engine returns NO_RESULTS_ON_PAGE if there
504 # are no results in the response.
505 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
506 # value format. For example:
507 #
508 # &quot;data&quot;: [
509 # {
510 # &quot;key&quot;: &quot;scope&quot;,
511 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
512 # }
513 {
514 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
515 # returned. For example, for warnings where there are no results in a list
516 # request for a particular zone, this key might be scope and
517 # the key value might be the zone name. Other examples might be a key
518 # indicating a deprecated resource and a suggested replacement, or a
519 # warning about invalid network settings (for example, if an instance
520 # attempts to perform IP forwarding but is not enabled for IP forwarding).
521 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
522 },
523 ],
524 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
525 },
526 ],
527 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
528 # applicable when performing per-zone operations.
529 }</pre>
530 </div>
531
532 <div class="method">
533 <code class="details" id="cancelRequestRemovePeering">cancelRequestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)</code>
534 <pre>Cancel requests to remove a peering from the specified network. Applicable
535 only for PeeringConnection with update_strategy=CONSENSUS. Cancels a
536 request to remove a peering from the specified network.
537
538 Args:
539 project: string, Project ID for this request. (required)
540 network: string, Name of the network resource to remove peering from. (required)
541 body: object, The request body.
542 The object takes the form of:
543
544 {
545 &quot;name&quot;: &quot;A String&quot;, # Name of the peering, which should conform to RFC1035.
546 }
547
548 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
549 that if you must retry your request, the server will know to ignore the
550 request if it has already been completed.
551
552 For example, consider a situation where you make an initial request and
553 the request times out. If you make the request again with the same
554 request ID, the server can check if original operation with the same
555 request ID was received, and if so, will ignore the second request. This
556 prevents clients from accidentally creating duplicate commitments.
557
558 The request ID must be
559 a valid UUID with the exception that zero UUID is not supported
560 (00000000-0000-0000-0000-000000000000).
561 x__xgafv: string, V1 error format.
562 Allowed values
563 1 - v1 error format
564 2 - v2 error format
565
566 Returns:
567 An object of the form:
568
569 { # Represents an Operation resource.
570 #
571 # Google Compute Engine has three Operation resources:
572 #
573 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
574 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
575 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
576 #
577 # You can use an operation resource to manage asynchronous API requests.
578 # For more information, readHandling
579 # API responses.
580 #
581 # Operations can be global, regional or zonal.
582 #
583 # - For global operations, use the `globalOperations`
584 # resource.
585 # - For regional operations, use the
586 # `regionOperations` resource.
587 # - For zonal operations, use
588 # the `zoneOperations` resource.
589 #
590 #
591 #
592 # For more information, read
593 # Global, Regional, and Zonal Resources.
594 #
595 # Note that completed Operation resources have a limited
596 # retention period.
597 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
598 # Not present otherwise.
599 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
600 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
601 # set when the operation is created.
602 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
603 # text format.
604 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
605 # this field will be populated.
606 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
607 # operation.
608 {
609 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
610 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
611 # details. There is a set of defined message types to use for providing
612 # details.The syntax depends on the error code. For example,
613 # QuotaExceededInfo will have details when the error code is
614 # QUOTA_EXCEEDED.
615 {
616 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
617 #
618 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
619 # is not enabled:
620 #
621 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
622 # &quot;domain&quot;: &quot;googleapis.com&quot;
623 # &quot;metadata&quot;: {
624 # &quot;resource&quot;: &quot;projects/123&quot;,
625 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
626 # }
627 # }
628 #
629 # This response indicates that the pubsub.googleapis.com API is not enabled.
630 #
631 # Example of an error that is returned when attempting to create a Spanner
632 # instance in a region that is out of stock:
633 #
634 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
635 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
636 # &quot;metadata&quot;: {
637 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
638 # }
639 # }
640 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
641 # is typically the registered service name of the tool or product that
642 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
643 # generated by some common infrastructure, the error domain must be a
644 # globally unique value that identifies the infrastructure. For Google API
645 # infrastructure, the error domain is &quot;googleapis.com&quot;.
646 &quot;metadatas&quot;: { # Additional structured details about this error.
647 #
648 # Keys must match a regular expression of `a-z+` but should
649 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
650 # length. When identifying the current value of an exceeded limit, the units
651 # should be contained in the key, not the value. For example, rather than
652 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
653 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
654 # instances that can be created in a single (batch) request.
655 &quot;a_key&quot;: &quot;A String&quot;,
656 },
657 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
658 # proximate cause of the error. Error reasons are unique within a particular
659 # domain of errors. This should be at most 63 characters and match a
660 # regular expression of `A-Z+[A-Z0-9]`, which represents
661 # UPPER_SNAKE_CASE.
662 },
663 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
664 #
665 # For example, if a quota check failed with an error indicating the calling
666 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
667 # directly to the right place in the developer console to flip the bit.
668 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
669 { # Describes a URL link.
670 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
671 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
672 },
673 ],
674 },
675 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
676 # which can be attached to an RPC error.
677 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
678 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
679 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
680 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
681 },
682 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
683 &quot;dimensions&quot;: { # The map holding related quota dimensions.
684 &quot;a_key&quot;: &quot;A String&quot;,
685 },
686 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
687 # type or metric.
688 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
689 # or metric.
690 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
691 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
692 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
693 },
694 },
695 ],
696 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
697 # This property is optional.
698 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
699 },
700 ],
701 },
702 &quot;getVersionOperationMetadata&quot;: {
703 &quot;inlineSbomInfo&quot;: {
704 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
705 # appropriate identifiers.
706 &quot;a_key&quot;: &quot;A String&quot;,
707 },
708 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
709 # identifiers.
710 &quot;a_key&quot;: &quot;A String&quot;,
711 },
712 },
713 },
714 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
715 # message that was returned, such as `NOT FOUND`.
716 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
717 # status code that was returned. For example, a `404` means the
718 # resource was not found.
719 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
720 # defined by the server.
721 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
722 # This value is inRFC3339
723 # text format.
724 &quot;instancesBulkInsertOperationMetadata&quot;: {
725 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
726 # Example key: zones/us-central1-a
727 &quot;a_key&quot;: {
728 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
729 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
730 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
731 # error.
732 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
733 # if the flow is rolling forward or rolling back.
734 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
735 },
736 },
737 },
738 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
739 # Operation resources.
740 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
741 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
742 # group of operations results from a `bulkInsert` API request.
743 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
744 # `update`, or `delete`, and so on.
745 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
746 # There is no requirement that this be linear or support any granularity of
747 # operations. This should not be used to guess when the operation will be
748 # complete. This number should monotonically increase as the operation
749 # progresses.
750 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
751 # applicable when performing regional operations.
752 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
753 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
754 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
755 # this field will contain information on all underlying zonal actions and
756 # their state.
757 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
758 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
759 # Example key: zones/us-central1-a
760 &quot;a_key&quot;: {
761 &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
762 # populated.
763 # different programming environments, including REST APIs and RPC APIs. It is
764 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
765 # three pieces of data: error code, error message, and error details.
766 #
767 # You can find out more about this error model and how to work with it in the
768 # [API Design Guide](https://cloud.google.com/apis/design/errors).
769 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
770 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
771 # message types for APIs to use.
772 {
773 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
774 },
775 ],
776 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
777 # user-facing error message should be localized and sent in the
778 # google.rpc.Status.details field, or localized by the client.
779 },
780 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
781 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
782 },
783 },
784 },
785 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
786 # This value is inRFC3339
787 # text format.
788 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
789 # following:
790 # `PENDING`, `RUNNING`, or `DONE`.
791 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
792 # operation.
793 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
794 # of the target resource.
795 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
796 # operations related to creating a snapshot, this points to the disk
797 # that the snapshot was created from.
798 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
799 # `[email protected]` or
800 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
801 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
802 # operation, this field will be populated.
803 {
804 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
805 # Engine returns NO_RESULTS_ON_PAGE if there
806 # are no results in the response.
807 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
808 # value format. For example:
809 #
810 # &quot;data&quot;: [
811 # {
812 # &quot;key&quot;: &quot;scope&quot;,
813 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
814 # }
815 {
816 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
817 # returned. For example, for warnings where there are no results in a list
818 # request for a particular zone, this key might be scope and
819 # the key value might be the zone name. Other examples might be a key
820 # indicating a deprecated resource and a suggested replacement, or a
821 # warning about invalid network settings (for example, if an instance
822 # attempts to perform IP forwarding but is not enabled for IP forwarding).
823 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
824 },
825 ],
826 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
827 },
828 ],
829 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
830 # applicable when performing per-zone operations.
831 }</pre>
832 </div>
833
834 <div class="method">
835 <code class="details" id="close">close()</code>
836 <pre>Close httplib2 connections.</pre>
837 </div>
838
839 <div class="method">
840 <code class="details" id="delete">delete(project, network, requestId=None, x__xgafv=None)</code>
841 <pre>Deletes the specified network.
842
843 Args:
844 project: string, Project ID for this request. (required)
845 network: string, Name of the network to delete. (required)
846 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
847 that if you must retry your request, the server will know to ignore the
848 request if it has already been completed.
849
850 For example, consider a situation where you make an initial request and
851 the request times out. If you make the request again with the same
852 request ID, the server can check if original operation with the same
853 request ID was received, and if so, will ignore the second request. This
854 prevents clients from accidentally creating duplicate commitments.
855
856 The request ID must be
857 a valid UUID with the exception that zero UUID is not supported
858 (00000000-0000-0000-0000-000000000000).
859 x__xgafv: string, V1 error format.
860 Allowed values
861 1 - v1 error format
862 2 - v2 error format
863
864 Returns:
865 An object of the form:
866
867 { # Represents an Operation resource.
868 #
869 # Google Compute Engine has three Operation resources:
870 #
871 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
872 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
873 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
874 #
875 # You can use an operation resource to manage asynchronous API requests.
876 # For more information, readHandling
877 # API responses.
878 #
879 # Operations can be global, regional or zonal.
880 #
881 # - For global operations, use the `globalOperations`
882 # resource.
883 # - For regional operations, use the
884 # `regionOperations` resource.
885 # - For zonal operations, use
886 # the `zoneOperations` resource.
887 #
888 #
889 #
890 # For more information, read
891 # Global, Regional, and Zonal Resources.
892 #
893 # Note that completed Operation resources have a limited
894 # retention period.
895 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
896 # Not present otherwise.
897 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
898 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
899 # set when the operation is created.
900 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
901 # text format.
902 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
903 # this field will be populated.
904 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
905 # operation.
906 {
907 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
908 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
909 # details. There is a set of defined message types to use for providing
910 # details.The syntax depends on the error code. For example,
911 # QuotaExceededInfo will have details when the error code is
912 # QUOTA_EXCEEDED.
913 {
914 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
915 #
916 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
917 # is not enabled:
918 #
919 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
920 # &quot;domain&quot;: &quot;googleapis.com&quot;
921 # &quot;metadata&quot;: {
922 # &quot;resource&quot;: &quot;projects/123&quot;,
923 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
924 # }
925 # }
926 #
927 # This response indicates that the pubsub.googleapis.com API is not enabled.
928 #
929 # Example of an error that is returned when attempting to create a Spanner
930 # instance in a region that is out of stock:
931 #
932 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
933 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
934 # &quot;metadata&quot;: {
935 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
936 # }
937 # }
938 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
939 # is typically the registered service name of the tool or product that
940 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
941 # generated by some common infrastructure, the error domain must be a
942 # globally unique value that identifies the infrastructure. For Google API
943 # infrastructure, the error domain is &quot;googleapis.com&quot;.
944 &quot;metadatas&quot;: { # Additional structured details about this error.
945 #
946 # Keys must match a regular expression of `a-z+` but should
947 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
948 # length. When identifying the current value of an exceeded limit, the units
949 # should be contained in the key, not the value. For example, rather than
950 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
951 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
952 # instances that can be created in a single (batch) request.
953 &quot;a_key&quot;: &quot;A String&quot;,
954 },
955 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
956 # proximate cause of the error. Error reasons are unique within a particular
957 # domain of errors. This should be at most 63 characters and match a
958 # regular expression of `A-Z+[A-Z0-9]`, which represents
959 # UPPER_SNAKE_CASE.
960 },
961 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
962 #
963 # For example, if a quota check failed with an error indicating the calling
964 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
965 # directly to the right place in the developer console to flip the bit.
966 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
967 { # Describes a URL link.
968 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
969 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
970 },
971 ],
972 },
973 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
974 # which can be attached to an RPC error.
975 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
976 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
977 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
978 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
979 },
980 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
981 &quot;dimensions&quot;: { # The map holding related quota dimensions.
982 &quot;a_key&quot;: &quot;A String&quot;,
983 },
984 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
985 # type or metric.
986 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
987 # or metric.
988 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
989 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
990 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
991 },
992 },
993 ],
994 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
995 # This property is optional.
996 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
997 },
998 ],
999 },
1000 &quot;getVersionOperationMetadata&quot;: {
1001 &quot;inlineSbomInfo&quot;: {
1002 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1003 # appropriate identifiers.
1004 &quot;a_key&quot;: &quot;A String&quot;,
1005 },
1006 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1007 # identifiers.
1008 &quot;a_key&quot;: &quot;A String&quot;,
1009 },
1010 },
1011 },
1012 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1013 # message that was returned, such as `NOT FOUND`.
1014 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1015 # status code that was returned. For example, a `404` means the
1016 # resource was not found.
1017 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1018 # defined by the server.
1019 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1020 # This value is inRFC3339
1021 # text format.
1022 &quot;instancesBulkInsertOperationMetadata&quot;: {
1023 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1024 # Example key: zones/us-central1-a
1025 &quot;a_key&quot;: {
1026 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1027 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1028 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1029 # error.
1030 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1031 # if the flow is rolling forward or rolling back.
1032 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1033 },
1034 },
1035 },
1036 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1037 # Operation resources.
1038 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1039 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1040 # group of operations results from a `bulkInsert` API request.
1041 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1042 # `update`, or `delete`, and so on.
1043 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1044 # There is no requirement that this be linear or support any granularity of
1045 # operations. This should not be used to guess when the operation will be
1046 # complete. This number should monotonically increase as the operation
1047 # progresses.
1048 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1049 # applicable when performing regional operations.
1050 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1051 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1052 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1053 # this field will contain information on all underlying zonal actions and
1054 # their state.
1055 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1056 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1057 # Example key: zones/us-central1-a
1058 &quot;a_key&quot;: {
1059 &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
1060 # populated.
1061 # different programming environments, including REST APIs and RPC APIs. It is
1062 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1063 # three pieces of data: error code, error message, and error details.
1064 #
1065 # You can find out more about this error model and how to work with it in the
1066 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1067 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1068 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1069 # message types for APIs to use.
1070 {
1071 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1072 },
1073 ],
1074 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1075 # user-facing error message should be localized and sent in the
1076 # google.rpc.Status.details field, or localized by the client.
1077 },
1078 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1079 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1080 },
1081 },
1082 },
1083 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1084 # This value is inRFC3339
1085 # text format.
1086 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1087 # following:
1088 # `PENDING`, `RUNNING`, or `DONE`.
1089 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1090 # operation.
1091 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1092 # of the target resource.
1093 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1094 # operations related to creating a snapshot, this points to the disk
1095 # that the snapshot was created from.
1096 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1097 # `[email protected]` or
1098 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1099 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1100 # operation, this field will be populated.
1101 {
1102 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1103 # Engine returns NO_RESULTS_ON_PAGE if there
1104 # are no results in the response.
1105 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1106 # value format. For example:
1107 #
1108 # &quot;data&quot;: [
1109 # {
1110 # &quot;key&quot;: &quot;scope&quot;,
1111 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1112 # }
1113 {
1114 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1115 # returned. For example, for warnings where there are no results in a list
1116 # request for a particular zone, this key might be scope and
1117 # the key value might be the zone name. Other examples might be a key
1118 # indicating a deprecated resource and a suggested replacement, or a
1119 # warning about invalid network settings (for example, if an instance
1120 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1121 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1122 },
1123 ],
1124 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1125 },
1126 ],
1127 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1128 # applicable when performing per-zone operations.
1129 }</pre>
1130 </div>
1131
1132 <div class="method">
1133 <code class="details" id="get">get(project, network, x__xgafv=None)</code>
1134 <pre>Returns the specified network.
1135
1136 Args:
1137 project: string, Project ID for this request. (required)
1138 network: string, Name of the network to return. (required)
1139 x__xgafv: string, V1 error format.
1140 Allowed values
1141 1 - v1 error format
1142 2 - v2 error format
1143
1144 Returns:
1145 An object of the form:
1146
1147 { # Represents a VPC Network resource.
1148 #
1149 # Networks connect resources to each other and to the internet. For more
1150 # information, readVirtual Private Cloud (VPC) Network.
1151 &quot;IPv4Range&quot;: &quot;A String&quot;, # Deprecated in favor of subnet mode networks.
1152 # The range of internal addresses that are legal on this network. This
1153 # range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is
1154 # created.
1155 &quot;autoCreateSubnetworks&quot;: True or False, # Must be set to create a VPC network. If not set, a legacy network is
1156 # created.
1157 #
1158 # When set to true, the VPC network is created in auto mode.
1159 # When set to false, the VPC network is created in custom mode.
1160 #
1161 # An auto mode VPC network starts with one subnet per region. Each subnet
1162 # has a predetermined range as described inAuto mode VPC network IP ranges.
1163 #
1164 # For custom mode VPC networks, you can add subnets using the subnetworksinsert
1165 # method.
1166 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1167 # text format.
1168 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
1169 # create the resource.
1170 &quot;enableUlaInternalIpv6&quot;: True or False, # Enable ULA internal ipv6 on this network. Enabling this feature will assign
1171 # a /48 from google defined ULA prefix fd20::/20.
1172 # .
1173 &quot;firewallPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the firewall policy the network is associated with.
1174 &quot;gatewayIPv4&quot;: &quot;A String&quot;, # [Output Only] The gateway address for default routing out of the network,
1175 # selected by Google Cloud.
1176 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1177 # defined by the server.
1178 &quot;internalIpv6Range&quot;: &quot;A String&quot;, # When enabling ula internal ipv6, caller optionally can specify the /48
1179 # range they want from the google defined ULA prefix fd20::/20. The input
1180 # must be a valid /48 ULA IPv6 address and must be within the fd20::/20.
1181 # Operation will fail if the speficied /48 is already in used by another
1182 # resource. If the field is not speficied, then a /48 range will be randomly
1183 # allocated from fd20::/20 and returned via this field.
1184 # .
1185 &quot;kind&quot;: &quot;compute#network&quot;, # Output only. [Output Only] Type of the resource. Always compute#network for
1186 # networks.
1187 &quot;mtu&quot;: 42, # Maximum Transmission Unit in bytes.
1188 # The minimum value for this field is 1300 and the maximum value is 8896.
1189 # The suggested value is 1500, which is the default MTU used on the
1190 # Internet, or 8896 if you want to use Jumbo frames. If unspecified, the
1191 # value defaults to 1460.
1192 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1193 # The name must be 1-63 characters long, and comply withRFC1035.
1194 # Specifically, the name must be 1-63 characters long and match the regular
1195 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
1196 # lowercase letter, and all following characters (except for the last
1197 # character) must be a dash, lowercase letter, or digit. The last character
1198 # must be a lowercase letter or digit.
1199 &quot;networkFirewallPolicyEnforcementOrder&quot;: &quot;A String&quot;, # The network firewall policy enforcement order. Can be either
1200 # AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to
1201 # AFTER_CLASSIC_FIREWALL if the field is not specified.
1202 &quot;networkProfile&quot;: &quot;A String&quot;, # A full or partial URL of the network profile to apply to this network.
1203 # This field can be set only at resource creation time. For example, the
1204 # following are valid URLs:
1205 #
1206 # - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name}
1207 # - projects/{project_id}/global/networkProfiles/{network_profile_name}
1208 &quot;params&quot;: { # Additional network parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1209 # as part of resource payload.
1210 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1211 # Tag keys and values have the same definition as resource
1212 # manager tags. The field is allowed for INSERT
1213 # only. The keys/values to set on the resource should be specified in
1214 # either ID { : } or Namespaced format
1215 # { : }.
1216 # For example the following are valid inputs:
1217 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1218 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1219 # Note:
1220 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1221 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1222 &quot;a_key&quot;: &quot;A String&quot;,
1223 },
1224 },
1225 &quot;peerings&quot;: [ # Output only. [Output Only] A list of network peerings for the resource.
1226 { # A network peering attached to a network resource. The message includes the
1227 # peering name, peer network, peering state, and a flag indicating whether
1228 # Google Compute Engine should automatically create routes for the peering.
1229 &quot;advertisePeerSubnetsViaRouters&quot;: True or False, # Whether Cloud Routers in this network can automatically advertise subnets
1230 # from the peer network.
1231 &quot;autoCreateRoutes&quot;: True or False, # This field will be deprecated soon. Use theexchange_subnet_routes field instead.
1232 # Indicates whether full mesh connectivity is created and managed
1233 # automatically between peered networks. Currently this field should always
1234 # be true since Google Compute Engine will automatically create and manage
1235 # subnetwork routes between two networks when peering state isACTIVE.
1236 &quot;connectionStatus&quot;: { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection
1237 # as a whole.
1238 # local peering. This field provides information about the effective settings
1239 # for the connection as a whole, including pending delete/update requests for
1240 # CONSENSUS peerings.
1241 &quot;consensusState&quot;: { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update
1242 # and delete for a consensus peering connection.
1243 # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the
1244 # strategy to CONSENSUS.
1245 &quot;deleteStatus&quot;: &quot;A String&quot;, # The status of the delete request.
1246 &quot;updateStatus&quot;: &quot;A String&quot;, # The status of the update request.
1247 },
1248 &quot;trafficConfiguration&quot;: { # The active connectivity settings for the peering connection based on the
1249 # settings of the network peerings.
1250 &quot;exportCustomRoutesToPeer&quot;: True or False, # Whether custom routes are being exported to the peer network.
1251 &quot;exportSubnetRoutesWithPublicIpToPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being exported to the
1252 # peer network.
1253 &quot;importCustomRoutesFromPeer&quot;: True or False, # Whether custom routes are being imported from the peer network.
1254 &quot;importSubnetRoutesWithPublicIpFromPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being imported
1255 # from the peer network.
1256 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are being imported or
1257 # exported between peer networks.
1258 },
1259 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the update/delete semantics for this
1260 # peering connection.
1261 },
1262 &quot;exchangeSubnetRoutes&quot;: True or False, # Indicates whether full mesh connectivity is created and managed
1263 # automatically between peered networks. Currently this field should always
1264 # be true since Google Compute Engine will automatically create and manage
1265 # subnetwork routes between two networks when peering state isACTIVE.
1266 &quot;exportCustomRoutes&quot;: True or False, # Whether to export the custom routes to peer network. The default value is
1267 # false.
1268 &quot;exportSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are exported. The default value
1269 # is true, all subnet routes are exported.IPv4
1270 # special-use ranges are always
1271 # exported to peers and are not controlled by this field.
1272 &quot;importCustomRoutes&quot;: True or False, # Whether to import the custom routes from peer network. The default value is
1273 # false.
1274 &quot;importSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are imported. The default value
1275 # is false.IPv4
1276 # special-use ranges are always
1277 # imported from peers and are not controlled by this field.
1278 &quot;name&quot;: &quot;A String&quot;, # Name of this peering. Provided by the client when the peering is created.
1279 # The name must comply withRFC1035.
1280 # Specifically, the name must be 1-63 characters long and match regular
1281 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
1282 # lowercase letter, and all the following characters must be a dash,
1283 # lowercase letter, or digit, except the last character, which cannot be a
1284 # dash.
1285 &quot;network&quot;: &quot;A String&quot;, # The URL of the peer network. It can be either full URL or partial URL. The
1286 # peer network may belong to a different project. If the partial URL does not
1287 # contain project, it is assumed that the peer network is in the same project
1288 # as the current network.
1289 &quot;peerMtu&quot;: 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network.
1290 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are allowed to be imported or
1291 # exported between peer networks. The default value is IPV4_ONLY.
1292 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State for the peering.
1293 &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. [Output Only] Details about the current state of the peering.
1294 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the semantics for updates and deletes to the
1295 # peering connection configuration.
1296 },
1297 ],
1298 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional network resides.
1299 # This field is not applicable to global network.
1300 # You must specify this field as part of the HTTP request URL. It is
1301 # not settable as a field in the request body.
1302 &quot;routingConfig&quot;: { # A routing configuration attached to a network resource. The message # The network-level routing configuration for this network. Used by Cloud
1303 # Router to determine what type of network-wide routing behavior to enforce.
1304 # includes the list of routers associated with the network, and a flag
1305 # indicating the type of routing behavior to enforce network-wide.
1306 &quot;bgpAlwaysCompareMed&quot;: True or False, # Enable comparison of Multi-Exit Discriminators (MED) across routes with
1307 # different neighbor ASNs when using the STANDARD BGP best path selection
1308 # algorithm.
1309 &quot;bgpBestPathSelectionMode&quot;: &quot;A String&quot;, # The BGP best path selection algorithm to be employed within this network
1310 # for dynamic routes learned by Cloud Routers. Can be LEGACY
1311 # (default) or STANDARD.
1312 &quot;bgpInterRegionCost&quot;: &quot;A String&quot;, # Allows to define a preferred approach for handling inter-region cost in
1313 # the selection process when using the STANDARD BGP best path
1314 # selection algorithm. Can be DEFAULT orADD_COST_TO_MED.
1315 &quot;effectiveBgpAlwaysCompareMed&quot;: True or False, # Output only. [Output Only] Effective value of the bgp_always_compare_med
1316 # field.
1317 &quot;effectiveBgpInterRegionCost&quot;: &quot;A String&quot;, # Output only. [Output Only] Effective value of the bgp_inter_region_cost
1318 # field.
1319 &quot;routingMode&quot;: &quot;A String&quot;, # The network-wide routing mode to use. If set to REGIONAL,
1320 # this network&#x27;s Cloud Routers will only advertise routes with subnets
1321 # of this network in the same region as the router. If set toGLOBAL, this network&#x27;s Cloud Routers will advertise
1322 # routes with all subnets of this network, across regions.
1323 },
1324 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1325 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1326 &quot;subnetworks&quot;: [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks
1327 # in this VPC network.
1328 &quot;A String&quot;,
1329 ],
1330 }</pre>
1331 </div>
1332
1333 <div class="method">
1334 <code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, network, x__xgafv=None)</code>
1335 <pre>Returns the effective firewalls on a given network.
1336
1337 Args:
1338 project: string, Project ID for this request. (required)
1339 network: string, Name of the network for this request. (required)
1340 x__xgafv: string, V1 error format.
1341 Allowed values
1342 1 - v1 error format
1343 2 - v2 error format
1344
1345 Returns:
1346 An object of the form:
1347
1348 {
1349 &quot;firewallPolicys&quot;: [ # [Output Only] Effective firewalls from firewall policy. It returns Global
1350 # Network Firewall Policies and Hierarchical Firewall Policies. UseregionNetworkFirewallPolicies.getEffectiveFirewalls to get
1351 # Regional Network Firewall Policies as well.
1352 {
1353 &quot;displayName&quot;: &quot;A String&quot;, # Output only. [Output Only] Deprecated, please use short name instead. The display name
1354 # of the firewall policy.
1355 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the firewall policy.
1356 &quot;packetMirroringRules&quot;: [ # Output only. [Output Only] The packet mirroring rules that apply to the network.
1357 { # Represents a rule that describes one or more match conditions along with
1358 # the action to be taken when traffic matches this condition (allow or deny).
1359 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
1360 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
1361 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
1362 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
1363 # and &quot;goto_next&quot;.
1364 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
1365 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
1366 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
1367 # the firewall policy rule is not enforced and traffic behaves as if it did
1368 # not exist. If this is unspecified, the firewall policy rule will be
1369 # enabled.
1370 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
1371 # enabled, logs will be exported to the configured export destination in
1372 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
1373 # cannot enable logging on &quot;goto_next&quot; rules.
1374 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
1375 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
1376 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
1377 # Exactly one field must be specified.
1378 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
1379 # Maximum number of destination address groups is 10.
1380 &quot;A String&quot;,
1381 ],
1382 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1383 # traffic destination.
1384 # Maximum number of destination fqdn allowed is 100.
1385 &quot;A String&quot;,
1386 ],
1387 &quot;destIpRanges&quot;: [ # CIDR IP address range.
1388 # Maximum number of destination CIDR IP ranges allowed is 5000.
1389 &quot;A String&quot;,
1390 ],
1391 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
1392 #
1393 #
1394 # - UNSPECIFIED
1395 # - INTERNET
1396 # - NON_INTERNET
1397 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
1398 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
1399 #
1400 #
1401 # - UNSPECIFIED
1402 # - INTERNET
1403 # - NON_INTERNET
1404 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
1405 # of traffic. Should be specified as 2 letter country code defined as per
1406 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1407 # Maximum number of dest region codes allowed is 5000.
1408 &quot;A String&quot;,
1409 ],
1410 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1411 # The IPs in these lists will be matched against traffic destination.
1412 &quot;A String&quot;,
1413 ],
1414 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1415 {
1416 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1417 # required when creating a firewall rule. This value can either be
1418 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1419 # protocol number.
1420 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1421 # only applicable for UDP or TCP protocol. Each entry must be either
1422 # an integer or a range. If not specified, this rule applies to
1423 # connections through any port.
1424 #
1425 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1426 &quot;A String&quot;,
1427 ],
1428 },
1429 ],
1430 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1431 # Maximum number of source address groups is 10.
1432 &quot;A String&quot;,
1433 ],
1434 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1435 # traffic source.
1436 # Maximum number of source fqdn allowed is 100.
1437 &quot;A String&quot;,
1438 ],
1439 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1440 # Maximum number of source CIDR IP ranges allowed is 5000.
1441 &quot;A String&quot;,
1442 ],
1443 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1444 #
1445 #
1446 # - UNSPECIFIED
1447 # - INTERNET
1448 # - INTRA_VPC
1449 # - NON_INTERNET
1450 # - VPC_NETWORKS
1451 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1452 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1453 #
1454 #
1455 # - UNSPECIFIED
1456 # - INTERNET
1457 # - INTRA_VPC
1458 # - NON_INTERNET
1459 # - VPC_NETWORKS
1460 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1461 &quot;A String&quot;,
1462 ],
1463 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1464 # of traffic. Should be specified as 2 letter country code defined as per
1465 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1466 # Maximum number of source region codes allowed is 5000.
1467 &quot;A String&quot;,
1468 ],
1469 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1470 # of the traffic.
1471 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1472 # and there is no srcIpRange, this rule will be ignored.
1473 # Maximum number of source tag values allowed is 256.
1474 {
1475 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1476 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1477 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1478 # or its network is deleted.
1479 },
1480 ],
1481 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1482 # The IPs in these lists will be matched against traffic source.
1483 &quot;A String&quot;,
1484 ],
1485 },
1486 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1487 # must be a positive value between 0 and 2147483647.
1488 # Rules are evaluated from highest to lowest priority where 0 is the
1489 # highest priority and 2147483647 is the lowest priority.
1490 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1491 # and can be updated.
1492 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1493 # rule.
1494 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1495 # Example:
1496 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1497 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1498 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1499 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
1500 # This field allows you to control which load balancers get this rule.
1501 # For example, the following are valid values:
1502 #
1503 #
1504 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
1505 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1506 # - projects/project/global/
1507 # forwardingRules/forwardingRule
1508 # - projects/project/regions/region/forwardingRules/
1509 # forwardingRule
1510 &quot;A String&quot;,
1511 ],
1512 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
1513 # allows you to control which network&#x27;s VMs get this rule. If this field
1514 # is left blank, all VMs within the organization will receive the rule.
1515 &quot;A String&quot;,
1516 ],
1517 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
1518 # applies to. If targetSecureTag are specified, then the
1519 # firewall rule applies only to instances in the VPC network that have one
1520 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
1521 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
1522 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
1523 # to all instances on the specified network.
1524 # Maximum number of target label tags allowed is 256.
1525 {
1526 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1527 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1528 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1529 # or its network is deleted.
1530 },
1531 ],
1532 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
1533 # applied with this rule.
1534 &quot;A String&quot;,
1535 ],
1536 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
1537 # Default value is INSTANCES.
1538 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
1539 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
1540 # be set for other actions.
1541 },
1542 ],
1543 &quot;priority&quot;: 42, # Output only. [Output only] Priority of firewall policy association. Not applicable for
1544 # type=HIERARCHY.
1545 &quot;rules&quot;: [ # [Output Only] The rules that apply to the network.
1546 { # Represents a rule that describes one or more match conditions along with
1547 # the action to be taken when traffic matches this condition (allow or deny).
1548 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
1549 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
1550 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
1551 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
1552 # and &quot;goto_next&quot;.
1553 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
1554 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
1555 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
1556 # the firewall policy rule is not enforced and traffic behaves as if it did
1557 # not exist. If this is unspecified, the firewall policy rule will be
1558 # enabled.
1559 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
1560 # enabled, logs will be exported to the configured export destination in
1561 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
1562 # cannot enable logging on &quot;goto_next&quot; rules.
1563 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
1564 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
1565 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
1566 # Exactly one field must be specified.
1567 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
1568 # Maximum number of destination address groups is 10.
1569 &quot;A String&quot;,
1570 ],
1571 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1572 # traffic destination.
1573 # Maximum number of destination fqdn allowed is 100.
1574 &quot;A String&quot;,
1575 ],
1576 &quot;destIpRanges&quot;: [ # CIDR IP address range.
1577 # Maximum number of destination CIDR IP ranges allowed is 5000.
1578 &quot;A String&quot;,
1579 ],
1580 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
1581 #
1582 #
1583 # - UNSPECIFIED
1584 # - INTERNET
1585 # - NON_INTERNET
1586 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
1587 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
1588 #
1589 #
1590 # - UNSPECIFIED
1591 # - INTERNET
1592 # - NON_INTERNET
1593 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
1594 # of traffic. Should be specified as 2 letter country code defined as per
1595 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1596 # Maximum number of dest region codes allowed is 5000.
1597 &quot;A String&quot;,
1598 ],
1599 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1600 # The IPs in these lists will be matched against traffic destination.
1601 &quot;A String&quot;,
1602 ],
1603 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1604 {
1605 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1606 # required when creating a firewall rule. This value can either be
1607 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1608 # protocol number.
1609 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1610 # only applicable for UDP or TCP protocol. Each entry must be either
1611 # an integer or a range. If not specified, this rule applies to
1612 # connections through any port.
1613 #
1614 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1615 &quot;A String&quot;,
1616 ],
1617 },
1618 ],
1619 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
1620 # Maximum number of source address groups is 10.
1621 &quot;A String&quot;,
1622 ],
1623 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
1624 # traffic source.
1625 # Maximum number of source fqdn allowed is 100.
1626 &quot;A String&quot;,
1627 ],
1628 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
1629 # Maximum number of source CIDR IP ranges allowed is 5000.
1630 &quot;A String&quot;,
1631 ],
1632 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
1633 #
1634 #
1635 # - UNSPECIFIED
1636 # - INTERNET
1637 # - INTRA_VPC
1638 # - NON_INTERNET
1639 # - VPC_NETWORKS
1640 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
1641 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
1642 #
1643 #
1644 # - UNSPECIFIED
1645 # - INTERNET
1646 # - INTRA_VPC
1647 # - NON_INTERNET
1648 # - VPC_NETWORKS
1649 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
1650 &quot;A String&quot;,
1651 ],
1652 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
1653 # of traffic. Should be specified as 2 letter country code defined as per
1654 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
1655 # Maximum number of source region codes allowed is 5000.
1656 &quot;A String&quot;,
1657 ],
1658 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
1659 # of the traffic.
1660 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
1661 # and there is no srcIpRange, this rule will be ignored.
1662 # Maximum number of source tag values allowed is 256.
1663 {
1664 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1665 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1666 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1667 # or its network is deleted.
1668 },
1669 ],
1670 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
1671 # The IPs in these lists will be matched against traffic source.
1672 &quot;A String&quot;,
1673 ],
1674 },
1675 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
1676 # must be a positive value between 0 and 2147483647.
1677 # Rules are evaluated from highest to lowest priority where 0 is the
1678 # highest priority and 2147483647 is the lowest priority.
1679 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
1680 # and can be updated.
1681 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
1682 # rule.
1683 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
1684 # Example:
1685 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
1686 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
1687 # &#x27;mirror&#x27;. Cannot be specified for other actions.
1688 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
1689 # This field allows you to control which load balancers get this rule.
1690 # For example, the following are valid values:
1691 #
1692 #
1693 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
1694 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1695 # - projects/project/global/
1696 # forwardingRules/forwardingRule
1697 # - projects/project/regions/region/forwardingRules/
1698 # forwardingRule
1699 &quot;A String&quot;,
1700 ],
1701 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
1702 # allows you to control which network&#x27;s VMs get this rule. If this field
1703 # is left blank, all VMs within the organization will receive the rule.
1704 &quot;A String&quot;,
1705 ],
1706 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
1707 # applies to. If targetSecureTag are specified, then the
1708 # firewall rule applies only to instances in the VPC network that have one
1709 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
1710 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
1711 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
1712 # to all instances on the specified network.
1713 # Maximum number of target label tags allowed is 256.
1714 {
1715 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
1716 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
1717 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
1718 # or its network is deleted.
1719 },
1720 ],
1721 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
1722 # applied with this rule.
1723 &quot;A String&quot;,
1724 ],
1725 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
1726 # Default value is INSTANCES.
1727 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
1728 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
1729 # be set for other actions.
1730 },
1731 ],
1732 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy.
1733 &quot;type&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of the firewall policy.
1734 },
1735 ],
1736 &quot;firewalls&quot;: [ # Effective firewalls on the network.
1737 { # Represents a Firewall Rule resource.
1738 #
1739 # Firewall rules allow or deny ingress traffic to, and egress traffic from your
1740 # instances. For more information, readFirewall rules.
1741 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a
1742 # protocol and port-range tuple that describes a permitted connection.
1743 {
1744 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1745 # required when creating a firewall rule. This value can either be one of the
1746 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
1747 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
1748 # This field is only applicable for the UDP or TCP protocol.
1749 # Each entry must be either an integer or a range.
1750 # If not specified, this rule applies to connections through any port.
1751 #
1752 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
1753 # and [&quot;12345-12349&quot;].
1754 &quot;A String&quot;,
1755 ],
1756 },
1757 ],
1758 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1759 # text format.
1760 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a
1761 # protocol and port-range tuple that describes a denied connection.
1762 {
1763 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1764 # required when creating a firewall rule. This value can either be one of the
1765 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
1766 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
1767 # This field is only applicable for the UDP or TCP protocol.
1768 # Each entry must be either an integer or a range.
1769 # If not specified, this rule applies to connections through any port.
1770 #
1771 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
1772 # and [&quot;12345-12349&quot;].
1773 &quot;A String&quot;,
1774 ],
1775 },
1776 ],
1777 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
1778 # create the resource.
1779 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to
1780 # traffic that has destination IP address in these ranges. These ranges must
1781 # be expressed inCIDR format. Both IPv4 and IPv6 are supported.
1782 &quot;A String&quot;,
1783 ],
1784 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or
1785 # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot
1786 # specify the sourceTags fields.
1787 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the
1788 # firewall rule is not enforced and the network behaves as if it did not
1789 # exist. If this is unspecified, the firewall rule will be enabled.
1790 &quot;enableLogging&quot;: True or False, # Deprecated in favor of enable in LogConfig.
1791 # This field denotes whether to enable logging for a particular
1792 # firewall rule. If logging is enabled, logs will be exported t
1793 # Cloud Logging.
1794 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1795 # defined by the server.
1796 &quot;kind&quot;: &quot;compute#firewall&quot;, # Output only. [Output Only] Type of the resource. Always compute#firewall
1797 # for firewall rules.
1798 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If
1799 # logging is enabled, logs will be exported to Cloud Logging.
1800 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall
1801 # rule.
1802 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if
1803 # logging is enabled for that rule. This field denotes whether to include
1804 # or exclude metadata for firewall logs.
1805 },
1806 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1807 # The name must be 1-63 characters long, and comply withRFC1035.
1808 # Specifically, the name must be 1-63 characters long and match the regular
1809 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character
1810 # must be a lowercase letter, and all following characters (except for the
1811 # last character) must be a dash, lowercase letter, or digit. The last
1812 # character must be a lowercase letter or digit.
1813 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not
1814 # specified when creating a firewall rule, the default network
1815 # is used:
1816 #
1817 # global/networks/default
1818 #
1819 # If you choose to specify this field, you can specify the network as a full
1820 # or partial URL. For example, the following are all valid URLs:
1821 #
1822 # -
1823 # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
1824 # - projects/myproject/global/networks/my-network
1825 # - global/networks/default
1826 &quot;params&quot;: { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1827 # as part of resource payload.
1828 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1829 # Tag keys and values have the same definition as resource
1830 # manager tags. The field is allowed for INSERT
1831 # only. The keys/values to set on the resource should be specified in
1832 # either ID { : } or Namespaced format
1833 # { : }.
1834 # For example the following are valid inputs:
1835 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1836 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1837 # Note:
1838 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1839 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1840 &quot;a_key&quot;: &quot;A String&quot;,
1841 },
1842 },
1843 &quot;priority&quot;: 42, # Priority for this rule.
1844 # This is an integer between `0` and `65535`, both inclusive.
1845 # The default value is `1000`.
1846 # Relative priorities determine which rule takes effect if multiple rules
1847 # apply. Lower values indicate higher priority. For example, a rule with
1848 # priority `0` has higher precedence than a rule with priority `1`.
1849 # DENY rules take precedence over ALLOW rules if they have equal priority.
1850 # Note that VPC networks have implied
1851 # rules with a priority of `65535`. To avoid conflicts with the implied
1852 # rules, use a priority number less than `65535`.
1853 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1854 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1855 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic
1856 # that has a source IP address in these ranges. These ranges must be
1857 # expressed inCIDR format. One or both of sourceRanges
1858 # and sourceTags may be set.
1859 # If both fields are set, the rule applies to traffic that has a
1860 # source IP address within sourceRanges OR a source IP
1861 # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match
1862 # both fields for the rule to
1863 # apply. Both IPv4 and IPv6 are supported.
1864 &quot;A String&quot;,
1865 ],
1866 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to
1867 # traffic originating from an instance with a service account in this list.
1868 # Source service accounts cannot be used to control traffic to an instance&#x27;s
1869 # external IP address because service accounts are associated with an
1870 # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.
1871 # If both are set, the firewall applies to traffic that
1872 # has a source IP address within the sourceRanges OR a source
1873 # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match
1874 # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.
1875 &quot;A String&quot;,
1876 ],
1877 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic
1878 # with source IPs that match the primary network interfaces of VM instances
1879 # that have the tag and are in the same VPC network.
1880 # Source tags cannot be used to control traffic to an instance&#x27;s external IP
1881 # address, it only applies to traffic between instances in the same virtual
1882 # network. Because tags are associated with instances, not IP addresses.
1883 # One or both of sourceRanges and sourceTags may be
1884 # set. If both fields are set, the firewall applies to traffic that has a
1885 # source IP address within sourceRanges OR a source IP from a
1886 # resource with a matching tag listed in the sourceTags
1887 # field. The connection does not need to match both fields for the
1888 # firewall to apply.
1889 &quot;A String&quot;,
1890 ],
1891 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the
1892 # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.
1893 # If neither targetServiceAccounts nor targetTags
1894 # are specified, the firewall rule applies to all instances on the specified
1895 # network.
1896 &quot;A String&quot;,
1897 ],
1898 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule
1899 # applies to. If targetTags are specified, then the firewall
1900 # rule applies only to instances in the VPC network that have one of those
1901 # tags. If no targetTags are specified, the firewall rule
1902 # applies to all instances on the specified network.
1903 &quot;A String&quot;,
1904 ],
1905 },
1906 ],
1907 &quot;organizationFirewalls&quot;: [ # Effective firewalls from organization policies.
1908 { # A pruned SecurityPolicy containing ID and any applicable firewall rules.
1909 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the security policy. This
1910 # identifier is defined by the server.
1911 &quot;rules&quot;: [ # The rules that apply to the network.
1912 { # Represents a rule that describes one or more match conditions along with
1913 # the action to be taken when traffic matches this condition (allow or deny).
1914 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the rule is matched.
1915 # The following are the valid actions:
1916 #
1917 # - allow: allow access to target.
1918 # - deny(STATUS): deny access to target, returns the
1919 # HTTP response code specified. Valid values for `STATUS`
1920 # are 403, 404, and 502.
1921 # - rate_based_ban: limit client traffic to the configured
1922 # threshold and ban the client if the traffic exceeds the threshold.
1923 # Configure parameters for this action in RateLimitOptions. Requires
1924 # rate_limit_options to be set.
1925 # - redirect: redirect to a different target. This can
1926 # either be an internal reCAPTCHA redirect, or an external URL-based
1927 # redirect via a 302 response. Parameters for this action can be configured
1928 # via redirectOptions. This action is only supported in Global Security
1929 # Policies of type CLOUD_ARMOR.
1930 # - throttle: limit
1931 # client traffic to the configured threshold. Configure parameters for this
1932 # action in rateLimitOptions. Requires rate_limit_options to be set for
1933 # this.
1934 # - fairshare (preview only): when traffic reaches the
1935 # threshold limit, requests from the clients matching this rule begin to be
1936 # rate-limited using the Fair Share algorithm. This action is only allowed
1937 # in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
1938 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1939 # create the resource.
1940 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies. This field may only be
1941 # specified when versioned_expr is set to FIREWALL.
1942 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
1943 # enabled, logs will be exported to the configured export destination in
1944 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
1945 # cannot enable logging on &quot;goto_next&quot; rules.
1946 #
1947 # This field may only be specified when the versioned_expr is set to
1948 # FIREWALL.
1949 &quot;headerAction&quot;: { # Optional, additional actions that are performed on headers.
1950 # This field is only supported in Global Security Policies of type
1951 # CLOUD_ARMOR.
1952 &quot;requestHeadersToAdds&quot;: [ # The list of request headers to add or overwrite if they&#x27;re already
1953 # present.
1954 {
1955 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to set.
1956 &quot;headerValue&quot;: &quot;A String&quot;, # The value to set the named header to.
1957 },
1958 ],
1959 },
1960 &quot;kind&quot;: &quot;compute#securityPolicyRule&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules
1961 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
1962 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
1963 # Exactly one field must be specified.
1964 &quot;config&quot;: { # The configuration options available when specifying versioned_expr.
1965 # This field must be specified if versioned_expr is specified and cannot
1966 # be specified if versioned_expr is not specified.
1967 &quot;destIpRanges&quot;: [ # CIDR IP address range.
1968 #
1969 # This field may only be specified when versioned_expr is set to
1970 # FIREWALL.
1971 &quot;A String&quot;,
1972 ],
1973 &quot;destPorts&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1974 #
1975 # This field may only be specified when versioned_expr is set to
1976 # FIREWALL.
1977 {
1978 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
1979 # required when creating a firewall rule. This value can either be
1980 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
1981 # protocol number.
1982 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
1983 # only applicable for UDP or TCP protocol. Each entry must be either
1984 # an integer or a range. If not specified, this rule applies to
1985 # connections through any port.
1986 #
1987 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
1988 #
1989 # This field may only be specified when versioned_expr is set to
1990 # FIREWALL.
1991 &quot;A String&quot;,
1992 ],
1993 },
1994 ],
1995 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
1996 #
1997 # This field may only be specified when versioned_expr is set to
1998 # FIREWALL.
1999 {
2000 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
2001 # required when creating a firewall rule. This value can either be
2002 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
2003 # protocol number.
2004 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
2005 # only applicable for UDP or TCP protocol. Each entry must be either
2006 # an integer or a range. If not specified, this rule applies to
2007 # connections through any port.
2008 #
2009 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
2010 #
2011 # This field may only be specified when versioned_expr is set to
2012 # FIREWALL.
2013 &quot;A String&quot;,
2014 ],
2015 },
2016 ],
2017 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
2018 # Maximum number of src_ip_ranges allowed is 10.
2019 &quot;A String&quot;,
2020 ],
2021 },
2022 &quot;expr&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # User defined CEVAL expression.
2023 # A CEVAL expression is used to specify match criteria such as origin.ip,
2024 # source.region_code and contents in the request header.
2025 # Expressions containing `evaluateThreatIntelligence` require a Cloud
2026 # Armor Enterprise subscription and are not supported in Edge Policies
2027 # nor in Regional Policies. Expressions containing
2028 # `evaluatePreconfiguredExpr(&#x27;sourceiplist-*&#x27;)` require a Cloud Armor
2029 # Enterprise subscription and are only supported in Global Security
2030 # Policies.
2031 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2032 # are documented at https://github.com/google/cel-spec.
2033 #
2034 # Example (Comparison):
2035 #
2036 # title: &quot;Summary size limit&quot;
2037 # description: &quot;Determines if a summary is less than 100 chars&quot;
2038 # expression: &quot;document.summary.size() &lt; 100&quot;
2039 #
2040 # Example (Equality):
2041 #
2042 # title: &quot;Requestor is owner&quot;
2043 # description: &quot;Determines if requestor is the document owner&quot;
2044 # expression: &quot;document.owner == request.auth.claims.email&quot;
2045 #
2046 # Example (Logic):
2047 #
2048 # title: &quot;Public documents&quot;
2049 # description: &quot;Determine whether the document should be publicly visible&quot;
2050 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2051 #
2052 # Example (Data Manipulation):
2053 #
2054 # title: &quot;Notification string&quot;
2055 # description: &quot;Create a notification string with a timestamp.&quot;
2056 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2057 #
2058 # The exact variables and functions that may be referenced within an expression
2059 # are determined by the service that evaluates it. See the service
2060 # documentation for additional information.
2061 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2062 # describes the expression, e.g. when hovered over it in a UI.
2063 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2064 # syntax.
2065 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2066 # reporting, e.g. a file name and a position in the file.
2067 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2068 # its purpose. This can be used e.g. in UIs which allow to enter the
2069 # expression.
2070 },
2071 &quot;exprOptions&quot;: { # The configuration options available when specifying a user defined
2072 # CEVAL expression (i.e., &#x27;expr&#x27;).
2073 &quot;recaptchaOptions&quot;: { # reCAPTCHA configuration options to be applied for the rule. If the
2074 # rule does not evaluate reCAPTCHA tokens, this field has no effect.
2075 &quot;actionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
2076 # action-tokens. The provided site keys need to be created from
2077 # reCAPTCHA API under the same project where the security policy is
2078 # created.
2079 &quot;A String&quot;,
2080 ],
2081 &quot;sessionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
2082 # session-tokens. The provided site keys need to be created from
2083 # reCAPTCHA API under the same project where the security policy is
2084 # created.
2085 &quot;A String&quot;,
2086 ],
2087 },
2088 },
2089 &quot;versionedExpr&quot;: &quot;A String&quot;, # Preconfigured versioned expression.
2090 # If this field is specified, config must also be specified.
2091 # Available preconfigured expressions along with their requirements are:
2092 # SRC_IPS_V1 - must specify the corresponding src_ip_range field in
2093 # config.
2094 },
2095 &quot;networkMatch&quot;: { # Represents a match condition that incoming network traffic is evaluated # A match condition that incoming packets are evaluated against for
2096 # CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding
2097 # &#x27;action&#x27; is enforced.
2098 #
2099 # The match criteria for a rule consists of built-in match fields (like
2100 # &#x27;srcIpRanges&#x27;) and potentially multiple user-defined match fields
2101 # (&#x27;userDefinedFields&#x27;).
2102 #
2103 # Field values may be extracted directly from the packet or derived from it
2104 # (e.g. &#x27;srcRegionCodes&#x27;). Some fields may not be present in every packet
2105 # (e.g. &#x27;srcPorts&#x27;). A user-defined field is only present if the base
2106 # header is found in the packet and the entire field is in bounds.
2107 #
2108 # Each match field may specify which values can match it, listing one or
2109 # more ranges, prefixes, or exact values that are considered a match for
2110 # the field. A field value must be present in order to match a specified
2111 # match field. If no match values are specified for a match field, then any
2112 # field value is considered to match it, and it&#x27;s not required to be
2113 # present. For strings specifying &#x27;*&#x27; is also equivalent to match all.
2114 #
2115 # For a packet to match a rule, all specified match fields must match the
2116 # corresponding field values derived from the packet.
2117 #
2118 # Example:
2119 #
2120 # networkMatch:
2121 # srcIpRanges:
2122 # - &quot;192.0.2.0/24&quot;
2123 # - &quot;198.51.100.0/24&quot;
2124 # userDefinedFields:
2125 # - name: &quot;ipv4_fragment_offset&quot;
2126 # values:
2127 # - &quot;1-0x1fff&quot;
2128 #
2129 # The above match condition matches packets with a source IP in
2130 # 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named
2131 # &quot;ipv4_fragment_offset&quot; with a value between 1 and 0x1fff inclusive.
2132 # against.
2133 &quot;destIpRanges&quot;: [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text
2134 # format.
2135 &quot;A String&quot;,
2136 ],
2137 &quot;destPorts&quot;: [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
2138 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
2139 &quot;A String&quot;,
2140 ],
2141 &quot;ipProtocols&quot;: [ # IPv4 protocol / IPv6 next header (after extension headers). Each
2142 # element can be an 8-bit unsigned decimal number (e.g. &quot;6&quot;), range (e.g.
2143 # &quot;253-254&quot;), or one of the following protocol names: &quot;tcp&quot;, &quot;udp&quot;,
2144 # &quot;icmp&quot;, &quot;esp&quot;, &quot;ah&quot;, &quot;ipip&quot;, or &quot;sctp&quot;.
2145 &quot;A String&quot;,
2146 ],
2147 &quot;srcAsns&quot;: [ # BGP Autonomous System Number associated with the source IP address.
2148 42,
2149 ],
2150 &quot;srcIpRanges&quot;: [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
2151 &quot;A String&quot;,
2152 ],
2153 &quot;srcPorts&quot;: [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
2154 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
2155 &quot;A String&quot;,
2156 ],
2157 &quot;srcRegionCodes&quot;: [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source
2158 # IP address.
2159 &quot;A String&quot;,
2160 ],
2161 &quot;userDefinedFields&quot;: [ # User-defined fields. Each element names a defined field and lists the
2162 # matching values for that field.
2163 {
2164 &quot;name&quot;: &quot;A String&quot;, # Name of the user-defined field, as given in the definition.
2165 &quot;values&quot;: [ # Matching values of the field. Each element can be a 32-bit unsigned
2166 # decimal or hexadecimal (starting with &quot;0x&quot;) number (e.g. &quot;64&quot;) or
2167 # range (e.g. &quot;0x400-0x7ff&quot;).
2168 &quot;A String&quot;,
2169 ],
2170 },
2171 ],
2172 },
2173 &quot;preconfiguredWafConfig&quot;: { # Preconfigured WAF configuration to be applied for the rule. If the rule
2174 # does not evaluate preconfigured WAF rules, i.e., if
2175 # evaluatePreconfiguredWaf() is not used, this field will have no effect.
2176 &quot;exclusions&quot;: [ # A list of exclusions to apply during preconfigured WAF evaluation.
2177 {
2178 &quot;requestBodiesToExclude&quot;: [ # A list of request body fields to be excluded from inspection during
2179 # preconfigured WAF evaluation.
2180 {
2181 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
2182 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
2183 },
2184 ],
2185 &quot;requestCookiesToExclude&quot;: [ # A list of request cookie names whose value will be excluded from
2186 # inspection during preconfigured WAF evaluation.
2187 {
2188 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
2189 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
2190 },
2191 ],
2192 &quot;requestHeadersToExclude&quot;: [ # A list of request header names whose value will be excluded from
2193 # inspection during preconfigured WAF evaluation.
2194 {
2195 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
2196 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
2197 },
2198 ],
2199 &quot;requestQueryParamsToExclude&quot;: [ # A list of request query parameter names whose value will be excluded
2200 # from inspection during preconfigured WAF evaluation. Note that the
2201 # parameter can be in the query string or in the POST body.
2202 {
2203 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
2204 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
2205 },
2206 ],
2207 &quot;requestUrisToExclude&quot;: [ # A list of request URIs from the request line to be excluded from
2208 # inspection during preconfigured WAF evaluation. When specifying this
2209 # field, the query or fragment part should be excluded.
2210 {
2211 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
2212 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
2213 },
2214 ],
2215 &quot;targetRuleIds&quot;: [ # A list of target rule IDs under the WAF rule set to apply the
2216 # preconfigured WAF exclusion. If omitted, it refers to all the rule
2217 # IDs under the WAF rule set.
2218 &quot;A String&quot;,
2219 ],
2220 &quot;targetRuleSet&quot;: &quot;A String&quot;, # Target WAF rule set to apply the preconfigured WAF exclusion.
2221 },
2222 ],
2223 },
2224 &quot;preview&quot;: True or False, # If set to true, the specified action is not enforced.
2225 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
2226 # must be a positive value between 0 and 2147483647.
2227 # Rules are evaluated from highest to lowest priority where 0 is the
2228 # highest priority and 2147483647 is the lowest priority.
2229 &quot;rateLimitOptions&quot;: { # Must be specified if the action is &quot;rate_based_ban&quot; or &quot;throttle&quot; or
2230 # &quot;fairshare&quot;. Cannot be specified for any other actions.
2231 &quot;banDurationSec&quot;: 42, # Can only be specified if the action for the rule is
2232 # &quot;rate_based_ban&quot;. If specified, determines the time (in seconds)
2233 # the traffic will continue to be banned by the rate limit after the
2234 # rate falls below the threshold.
2235 &quot;banThreshold&quot;: { # Can only be specified if the action for the rule is
2236 # &quot;rate_based_ban&quot;. If specified, the key will be banned for the
2237 # configured &#x27;ban_duration_sec&#x27; when the number of requests that exceed
2238 # the &#x27;rate_limit_threshold&#x27; also exceed this &#x27;ban_threshold&#x27;.
2239 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
2240 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
2241 },
2242 &quot;conformAction&quot;: &quot;A String&quot;, # Action to take for requests that are under the configured rate limit
2243 # threshold. Valid option is &quot;allow&quot; only.
2244 &quot;enforceOnKey&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
2245 # values are:
2246 #
2247 # - ALL: A single rate limit threshold is applied to all
2248 # the requests matching this rule. This is the default value if
2249 # &quot;enforceOnKey&quot; is not configured.
2250 # - IP: The source IP address of
2251 # the request is the key. Each IP has this limit enforced
2252 # separately.
2253 # - HTTP_HEADER: The value of the HTTP
2254 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
2255 # value is truncated to the first 128 bytes of the header value. If no
2256 # such header is present in the request, the key type defaults toALL.
2257 # - XFF_IP: The first IP address (i.e. the
2258 # originating client IP address) specified in the list of IPs under
2259 # X-Forwarded-For HTTP header. If no such header is present or the value
2260 # is not a valid IP, the key defaults to the source IP address of
2261 # the request i.e. key type IP.
2262 # - HTTP_COOKIE: The value of the HTTP
2263 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
2264 # value is truncated to the first 128 bytes of the cookie value. If no
2265 # such cookie is present in the request, the key type defaults toALL.
2266 # - HTTP_PATH: The URL path of the HTTP request. The key
2267 # value is truncated to the first 128 bytes.
2268 # - SNI: Server name indication in the TLS session of the
2269 # HTTPS request. The key value is truncated to the first 128 bytes. The
2270 # key type defaults to ALL on a HTTP session.
2271 # - REGION_CODE: The country/region from which the request
2272 # originates.
2273 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
2274 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
2275 # key type defaults to ALL.
2276 # - USER_IP: The IP address of the originating client,
2277 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
2278 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration or
2279 # an IP address cannot be resolved from it, the key type defaults toIP.
2280 #
2281 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
2282 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
2283 # key type defaults to ALL.
2284 # For &quot;fairshare&quot; action, this value is limited to ALL i.e. a single rate
2285 # limit threshold is enforced for all the requests matching the rule.
2286 &quot;enforceOnKeyConfigs&quot;: [ # If specified, any combination of values of
2287 # enforce_on_key_type/enforce_on_key_name is treated as the key on which
2288 # ratelimit threshold/action is enforced. You can specify up to 3
2289 # enforce_on_key_configs. If enforce_on_key_configs is specified,
2290 # enforce_on_key must not be specified.
2291 {
2292 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
2293 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the
2294 # key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is
2295 # taken as the key value.
2296 &quot;enforceOnKeyType&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
2297 # values are:
2298 #
2299 # - ALL: A single rate limit threshold is applied to all
2300 # the requests matching this rule. This is the default value if
2301 # &quot;enforceOnKeyConfigs&quot; is not configured.
2302 # - IP: The source IP address of
2303 # the request is the key. Each IP has this limit enforced
2304 # separately.
2305 # - HTTP_HEADER: The value of the HTTP
2306 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
2307 # value is truncated to the first 128 bytes of the header value. If no
2308 # such header is present in the request, the key type defaults toALL.
2309 # - XFF_IP: The first IP address (i.e. the
2310 # originating client IP address) specified in the list of IPs under
2311 # X-Forwarded-For HTTP header. If no such header is present or the
2312 # value is not a valid IP, the key defaults to the source IP address of
2313 # the request i.e. key type IP.
2314 # - HTTP_COOKIE: The value of the HTTP
2315 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
2316 # value is truncated to the first 128 bytes of the cookie value. If no
2317 # such cookie is present in the request, the key type defaults toALL.
2318 # - HTTP_PATH: The URL path of the HTTP request. The key
2319 # value is truncated to the first 128 bytes.
2320 # - SNI: Server name indication in the TLS session of
2321 # the HTTPS request. The key value is truncated to the first 128 bytes.
2322 # The key type defaults to ALL on a HTTP session.
2323 # - REGION_CODE: The country/region from which the
2324 # request originates.
2325 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
2326 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
2327 # key type defaults to ALL.
2328 # - USER_IP: The IP address of the originating client,
2329 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
2330 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration
2331 # or an IP address cannot be resolved from it, the key type defaults toIP.
2332 #
2333 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
2334 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
2335 # key type defaults to ALL.
2336 },
2337 ],
2338 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
2339 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the key
2340 # value.
2341 # HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key
2342 # value.
2343 &quot;exceedAction&quot;: &quot;A String&quot;, # Action to take for requests that are above the configured rate limit
2344 # threshold, to either deny with a specified HTTP response code, or
2345 # redirect to a different endpoint.
2346 # Valid options are `deny(STATUS)`, where valid values for
2347 # `STATUS` are 403, 404, 429, and 502, and
2348 # `redirect`, where the redirect parameters come from
2349 # `exceedRedirectOptions` below.
2350 # The `redirect` action is only supported in Global Security Policies of
2351 # type CLOUD_ARMOR.
2352 &quot;exceedActionRpcStatus&quot;: { # Simplified google.rpc.Status type (omitting details). # Specified gRPC response status for proxyless gRPC requests that are
2353 # above the configured rate limit threshold
2354 &quot;code&quot;: 42, # The status code, which should be an enum value of
2355 # google.rpc.Code.
2356 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English.
2357 },
2358 &quot;exceedRedirectOptions&quot;: { # Parameters defining the redirect action that is used as the exceed
2359 # action. Cannot be specified if the exceed action is not redirect.
2360 # This field is only supported in Global Security Policies of type
2361 # CLOUD_ARMOR.
2362 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
2363 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
2364 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
2365 #
2366 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
2367 # challenge assessment.
2368 # - EXTERNAL_302: redirect to a different URL via a 302
2369 # response.
2370 },
2371 &quot;rateLimitThreshold&quot;: { # Threshold at which to begin ratelimiting.
2372 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
2373 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
2374 },
2375 },
2376 &quot;redirectOptions&quot;: { # Parameters defining the redirect action. Cannot be specified for any
2377 # other actions.
2378 # This field is only supported in Global Security Policies of type
2379 # CLOUD_ARMOR.
2380 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
2381 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
2382 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
2383 #
2384 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
2385 # challenge assessment.
2386 # - EXTERNAL_302: redirect to a different URL via a 302
2387 # response.
2388 },
2389 &quot;redirectTarget&quot;: &quot;A String&quot;, # This must be specified for redirect actions. Cannot be specified for any
2390 # other actions.
2391 &quot;ruleManagedProtectionTier&quot;: &quot;A String&quot;, # Output only. [Output Only] The minimum Cloud Armor subscription required for this
2392 # rule.
2393 # [Deprecated] Use requiredManagedProtectionTiers instead.
2394 &quot;ruleNumber&quot;: &quot;A String&quot;, # Identifier for the rule. This is only unique within the given security
2395 # policy. This can only be set during rule creation, if rule number is not
2396 # specified it will be generated by the server.
2397 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall security
2398 # policy rule.
2399 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
2400 # allows you to control which network&#x27;s VMs get this rule. If this field
2401 # is left blank, all VMs within the organization will receive the rule.
2402 #
2403 # This field may only be specified when versioned_expr is set to FIREWALL.
2404 &quot;A String&quot;,
2405 ],
2406 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
2407 # applied with this rule.
2408 &quot;A String&quot;,
2409 ],
2410 },
2411 ],
2412 },
2413 ],
2414 }</pre>
2415 </div>
2416
2417 <div class="method">
2418 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
2419 <pre>Creates a network in the specified project using the data included
2420 in the request.
2421
2422 Args:
2423 project: string, Project ID for this request. (required)
2424 body: object, The request body.
2425 The object takes the form of:
2426
2427 { # Represents a VPC Network resource.
2428 #
2429 # Networks connect resources to each other and to the internet. For more
2430 # information, readVirtual Private Cloud (VPC) Network.
2431 &quot;IPv4Range&quot;: &quot;A String&quot;, # Deprecated in favor of subnet mode networks.
2432 # The range of internal addresses that are legal on this network. This
2433 # range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is
2434 # created.
2435 &quot;autoCreateSubnetworks&quot;: True or False, # Must be set to create a VPC network. If not set, a legacy network is
2436 # created.
2437 #
2438 # When set to true, the VPC network is created in auto mode.
2439 # When set to false, the VPC network is created in custom mode.
2440 #
2441 # An auto mode VPC network starts with one subnet per region. Each subnet
2442 # has a predetermined range as described inAuto mode VPC network IP ranges.
2443 #
2444 # For custom mode VPC networks, you can add subnets using the subnetworksinsert
2445 # method.
2446 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2447 # text format.
2448 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
2449 # create the resource.
2450 &quot;enableUlaInternalIpv6&quot;: True or False, # Enable ULA internal ipv6 on this network. Enabling this feature will assign
2451 # a /48 from google defined ULA prefix fd20::/20.
2452 # .
2453 &quot;firewallPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the firewall policy the network is associated with.
2454 &quot;gatewayIPv4&quot;: &quot;A String&quot;, # [Output Only] The gateway address for default routing out of the network,
2455 # selected by Google Cloud.
2456 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2457 # defined by the server.
2458 &quot;internalIpv6Range&quot;: &quot;A String&quot;, # When enabling ula internal ipv6, caller optionally can specify the /48
2459 # range they want from the google defined ULA prefix fd20::/20. The input
2460 # must be a valid /48 ULA IPv6 address and must be within the fd20::/20.
2461 # Operation will fail if the speficied /48 is already in used by another
2462 # resource. If the field is not speficied, then a /48 range will be randomly
2463 # allocated from fd20::/20 and returned via this field.
2464 # .
2465 &quot;kind&quot;: &quot;compute#network&quot;, # Output only. [Output Only] Type of the resource. Always compute#network for
2466 # networks.
2467 &quot;mtu&quot;: 42, # Maximum Transmission Unit in bytes.
2468 # The minimum value for this field is 1300 and the maximum value is 8896.
2469 # The suggested value is 1500, which is the default MTU used on the
2470 # Internet, or 8896 if you want to use Jumbo frames. If unspecified, the
2471 # value defaults to 1460.
2472 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2473 # The name must be 1-63 characters long, and comply withRFC1035.
2474 # Specifically, the name must be 1-63 characters long and match the regular
2475 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
2476 # lowercase letter, and all following characters (except for the last
2477 # character) must be a dash, lowercase letter, or digit. The last character
2478 # must be a lowercase letter or digit.
2479 &quot;networkFirewallPolicyEnforcementOrder&quot;: &quot;A String&quot;, # The network firewall policy enforcement order. Can be either
2480 # AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to
2481 # AFTER_CLASSIC_FIREWALL if the field is not specified.
2482 &quot;networkProfile&quot;: &quot;A String&quot;, # A full or partial URL of the network profile to apply to this network.
2483 # This field can be set only at resource creation time. For example, the
2484 # following are valid URLs:
2485 #
2486 # - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name}
2487 # - projects/{project_id}/global/networkProfiles/{network_profile_name}
2488 &quot;params&quot;: { # Additional network parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2489 # as part of resource payload.
2490 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2491 # Tag keys and values have the same definition as resource
2492 # manager tags. The field is allowed for INSERT
2493 # only. The keys/values to set on the resource should be specified in
2494 # either ID { : } or Namespaced format
2495 # { : }.
2496 # For example the following are valid inputs:
2497 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2498 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2499 # Note:
2500 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2501 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2502 &quot;a_key&quot;: &quot;A String&quot;,
2503 },
2504 },
2505 &quot;peerings&quot;: [ # Output only. [Output Only] A list of network peerings for the resource.
2506 { # A network peering attached to a network resource. The message includes the
2507 # peering name, peer network, peering state, and a flag indicating whether
2508 # Google Compute Engine should automatically create routes for the peering.
2509 &quot;advertisePeerSubnetsViaRouters&quot;: True or False, # Whether Cloud Routers in this network can automatically advertise subnets
2510 # from the peer network.
2511 &quot;autoCreateRoutes&quot;: True or False, # This field will be deprecated soon. Use theexchange_subnet_routes field instead.
2512 # Indicates whether full mesh connectivity is created and managed
2513 # automatically between peered networks. Currently this field should always
2514 # be true since Google Compute Engine will automatically create and manage
2515 # subnetwork routes between two networks when peering state isACTIVE.
2516 &quot;connectionStatus&quot;: { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection
2517 # as a whole.
2518 # local peering. This field provides information about the effective settings
2519 # for the connection as a whole, including pending delete/update requests for
2520 # CONSENSUS peerings.
2521 &quot;consensusState&quot;: { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update
2522 # and delete for a consensus peering connection.
2523 # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the
2524 # strategy to CONSENSUS.
2525 &quot;deleteStatus&quot;: &quot;A String&quot;, # The status of the delete request.
2526 &quot;updateStatus&quot;: &quot;A String&quot;, # The status of the update request.
2527 },
2528 &quot;trafficConfiguration&quot;: { # The active connectivity settings for the peering connection based on the
2529 # settings of the network peerings.
2530 &quot;exportCustomRoutesToPeer&quot;: True or False, # Whether custom routes are being exported to the peer network.
2531 &quot;exportSubnetRoutesWithPublicIpToPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being exported to the
2532 # peer network.
2533 &quot;importCustomRoutesFromPeer&quot;: True or False, # Whether custom routes are being imported from the peer network.
2534 &quot;importSubnetRoutesWithPublicIpFromPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being imported
2535 # from the peer network.
2536 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are being imported or
2537 # exported between peer networks.
2538 },
2539 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the update/delete semantics for this
2540 # peering connection.
2541 },
2542 &quot;exchangeSubnetRoutes&quot;: True or False, # Indicates whether full mesh connectivity is created and managed
2543 # automatically between peered networks. Currently this field should always
2544 # be true since Google Compute Engine will automatically create and manage
2545 # subnetwork routes between two networks when peering state isACTIVE.
2546 &quot;exportCustomRoutes&quot;: True or False, # Whether to export the custom routes to peer network. The default value is
2547 # false.
2548 &quot;exportSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are exported. The default value
2549 # is true, all subnet routes are exported.IPv4
2550 # special-use ranges are always
2551 # exported to peers and are not controlled by this field.
2552 &quot;importCustomRoutes&quot;: True or False, # Whether to import the custom routes from peer network. The default value is
2553 # false.
2554 &quot;importSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are imported. The default value
2555 # is false.IPv4
2556 # special-use ranges are always
2557 # imported from peers and are not controlled by this field.
2558 &quot;name&quot;: &quot;A String&quot;, # Name of this peering. Provided by the client when the peering is created.
2559 # The name must comply withRFC1035.
2560 # Specifically, the name must be 1-63 characters long and match regular
2561 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
2562 # lowercase letter, and all the following characters must be a dash,
2563 # lowercase letter, or digit, except the last character, which cannot be a
2564 # dash.
2565 &quot;network&quot;: &quot;A String&quot;, # The URL of the peer network. It can be either full URL or partial URL. The
2566 # peer network may belong to a different project. If the partial URL does not
2567 # contain project, it is assumed that the peer network is in the same project
2568 # as the current network.
2569 &quot;peerMtu&quot;: 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network.
2570 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are allowed to be imported or
2571 # exported between peer networks. The default value is IPV4_ONLY.
2572 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State for the peering.
2573 &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. [Output Only] Details about the current state of the peering.
2574 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the semantics for updates and deletes to the
2575 # peering connection configuration.
2576 },
2577 ],
2578 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional network resides.
2579 # This field is not applicable to global network.
2580 # You must specify this field as part of the HTTP request URL. It is
2581 # not settable as a field in the request body.
2582 &quot;routingConfig&quot;: { # A routing configuration attached to a network resource. The message # The network-level routing configuration for this network. Used by Cloud
2583 # Router to determine what type of network-wide routing behavior to enforce.
2584 # includes the list of routers associated with the network, and a flag
2585 # indicating the type of routing behavior to enforce network-wide.
2586 &quot;bgpAlwaysCompareMed&quot;: True or False, # Enable comparison of Multi-Exit Discriminators (MED) across routes with
2587 # different neighbor ASNs when using the STANDARD BGP best path selection
2588 # algorithm.
2589 &quot;bgpBestPathSelectionMode&quot;: &quot;A String&quot;, # The BGP best path selection algorithm to be employed within this network
2590 # for dynamic routes learned by Cloud Routers. Can be LEGACY
2591 # (default) or STANDARD.
2592 &quot;bgpInterRegionCost&quot;: &quot;A String&quot;, # Allows to define a preferred approach for handling inter-region cost in
2593 # the selection process when using the STANDARD BGP best path
2594 # selection algorithm. Can be DEFAULT orADD_COST_TO_MED.
2595 &quot;effectiveBgpAlwaysCompareMed&quot;: True or False, # Output only. [Output Only] Effective value of the bgp_always_compare_med
2596 # field.
2597 &quot;effectiveBgpInterRegionCost&quot;: &quot;A String&quot;, # Output only. [Output Only] Effective value of the bgp_inter_region_cost
2598 # field.
2599 &quot;routingMode&quot;: &quot;A String&quot;, # The network-wide routing mode to use. If set to REGIONAL,
2600 # this network&#x27;s Cloud Routers will only advertise routes with subnets
2601 # of this network in the same region as the router. If set toGLOBAL, this network&#x27;s Cloud Routers will advertise
2602 # routes with all subnets of this network, across regions.
2603 },
2604 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2605 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2606 &quot;subnetworks&quot;: [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks
2607 # in this VPC network.
2608 &quot;A String&quot;,
2609 ],
2610 }
2611
2612 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2613 that if you must retry your request, the server will know to ignore the
2614 request if it has already been completed.
2615
2616 For example, consider a situation where you make an initial request and
2617 the request times out. If you make the request again with the same
2618 request ID, the server can check if original operation with the same
2619 request ID was received, and if so, will ignore the second request. This
2620 prevents clients from accidentally creating duplicate commitments.
2621
2622 The request ID must be
2623 a valid UUID with the exception that zero UUID is not supported
2624 (00000000-0000-0000-0000-000000000000).
2625 x__xgafv: string, V1 error format.
2626 Allowed values
2627 1 - v1 error format
2628 2 - v2 error format
2629
2630 Returns:
2631 An object of the form:
2632
2633 { # Represents an Operation resource.
2634 #
2635 # Google Compute Engine has three Operation resources:
2636 #
2637 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2638 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2639 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2640 #
2641 # You can use an operation resource to manage asynchronous API requests.
2642 # For more information, readHandling
2643 # API responses.
2644 #
2645 # Operations can be global, regional or zonal.
2646 #
2647 # - For global operations, use the `globalOperations`
2648 # resource.
2649 # - For regional operations, use the
2650 # `regionOperations` resource.
2651 # - For zonal operations, use
2652 # the `zoneOperations` resource.
2653 #
2654 #
2655 #
2656 # For more information, read
2657 # Global, Regional, and Zonal Resources.
2658 #
2659 # Note that completed Operation resources have a limited
2660 # retention period.
2661 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2662 # Not present otherwise.
2663 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2664 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2665 # set when the operation is created.
2666 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2667 # text format.
2668 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2669 # this field will be populated.
2670 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2671 # operation.
2672 {
2673 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2674 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2675 # details. There is a set of defined message types to use for providing
2676 # details.The syntax depends on the error code. For example,
2677 # QuotaExceededInfo will have details when the error code is
2678 # QUOTA_EXCEEDED.
2679 {
2680 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2681 #
2682 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2683 # is not enabled:
2684 #
2685 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2686 # &quot;domain&quot;: &quot;googleapis.com&quot;
2687 # &quot;metadata&quot;: {
2688 # &quot;resource&quot;: &quot;projects/123&quot;,
2689 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2690 # }
2691 # }
2692 #
2693 # This response indicates that the pubsub.googleapis.com API is not enabled.
2694 #
2695 # Example of an error that is returned when attempting to create a Spanner
2696 # instance in a region that is out of stock:
2697 #
2698 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2699 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2700 # &quot;metadata&quot;: {
2701 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2702 # }
2703 # }
2704 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2705 # is typically the registered service name of the tool or product that
2706 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2707 # generated by some common infrastructure, the error domain must be a
2708 # globally unique value that identifies the infrastructure. For Google API
2709 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2710 &quot;metadatas&quot;: { # Additional structured details about this error.
2711 #
2712 # Keys must match a regular expression of `a-z+` but should
2713 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2714 # length. When identifying the current value of an exceeded limit, the units
2715 # should be contained in the key, not the value. For example, rather than
2716 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2717 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2718 # instances that can be created in a single (batch) request.
2719 &quot;a_key&quot;: &quot;A String&quot;,
2720 },
2721 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2722 # proximate cause of the error. Error reasons are unique within a particular
2723 # domain of errors. This should be at most 63 characters and match a
2724 # regular expression of `A-Z+[A-Z0-9]`, which represents
2725 # UPPER_SNAKE_CASE.
2726 },
2727 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2728 #
2729 # For example, if a quota check failed with an error indicating the calling
2730 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2731 # directly to the right place in the developer console to flip the bit.
2732 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2733 { # Describes a URL link.
2734 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2735 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2736 },
2737 ],
2738 },
2739 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2740 # which can be attached to an RPC error.
2741 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2742 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2743 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2744 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2745 },
2746 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2747 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2748 &quot;a_key&quot;: &quot;A String&quot;,
2749 },
2750 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2751 # type or metric.
2752 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2753 # or metric.
2754 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2755 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2756 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2757 },
2758 },
2759 ],
2760 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2761 # This property is optional.
2762 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2763 },
2764 ],
2765 },
2766 &quot;getVersionOperationMetadata&quot;: {
2767 &quot;inlineSbomInfo&quot;: {
2768 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2769 # appropriate identifiers.
2770 &quot;a_key&quot;: &quot;A String&quot;,
2771 },
2772 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2773 # identifiers.
2774 &quot;a_key&quot;: &quot;A String&quot;,
2775 },
2776 },
2777 },
2778 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2779 # message that was returned, such as `NOT FOUND`.
2780 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2781 # status code that was returned. For example, a `404` means the
2782 # resource was not found.
2783 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2784 # defined by the server.
2785 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2786 # This value is inRFC3339
2787 # text format.
2788 &quot;instancesBulkInsertOperationMetadata&quot;: {
2789 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2790 # Example key: zones/us-central1-a
2791 &quot;a_key&quot;: {
2792 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2793 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2794 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2795 # error.
2796 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2797 # if the flow is rolling forward or rolling back.
2798 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2799 },
2800 },
2801 },
2802 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2803 # Operation resources.
2804 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2805 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2806 # group of operations results from a `bulkInsert` API request.
2807 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2808 # `update`, or `delete`, and so on.
2809 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2810 # There is no requirement that this be linear or support any granularity of
2811 # operations. This should not be used to guess when the operation will be
2812 # complete. This number should monotonically increase as the operation
2813 # progresses.
2814 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2815 # applicable when performing regional operations.
2816 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2817 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2818 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2819 # this field will contain information on all underlying zonal actions and
2820 # their state.
2821 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2822 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2823 # Example key: zones/us-central1-a
2824 &quot;a_key&quot;: {
2825 &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
2826 # populated.
2827 # different programming environments, including REST APIs and RPC APIs. It is
2828 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2829 # three pieces of data: error code, error message, and error details.
2830 #
2831 # You can find out more about this error model and how to work with it in the
2832 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2833 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2834 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2835 # message types for APIs to use.
2836 {
2837 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2838 },
2839 ],
2840 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2841 # user-facing error message should be localized and sent in the
2842 # google.rpc.Status.details field, or localized by the client.
2843 },
2844 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2845 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2846 },
2847 },
2848 },
2849 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2850 # This value is inRFC3339
2851 # text format.
2852 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2853 # following:
2854 # `PENDING`, `RUNNING`, or `DONE`.
2855 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2856 # operation.
2857 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2858 # of the target resource.
2859 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2860 # operations related to creating a snapshot, this points to the disk
2861 # that the snapshot was created from.
2862 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2863 # `[email protected]` or
2864 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2865 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2866 # operation, this field will be populated.
2867 {
2868 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2869 # Engine returns NO_RESULTS_ON_PAGE if there
2870 # are no results in the response.
2871 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2872 # value format. For example:
2873 #
2874 # &quot;data&quot;: [
2875 # {
2876 # &quot;key&quot;: &quot;scope&quot;,
2877 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2878 # }
2879 {
2880 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2881 # returned. For example, for warnings where there are no results in a list
2882 # request for a particular zone, this key might be scope and
2883 # the key value might be the zone name. Other examples might be a key
2884 # indicating a deprecated resource and a suggested replacement, or a
2885 # warning about invalid network settings (for example, if an instance
2886 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2887 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2888 },
2889 ],
2890 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2891 },
2892 ],
2893 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2894 # applicable when performing per-zone operations.
2895 }</pre>
2896 </div>
2897
2898 <div class="method">
2899 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2900 <pre>Retrieves the list of networks available to the specified project.
2901
2902 Args:
2903 project: string, Project ID for this request. (required)
2904 filter: string, A filter expression that filters resources listed in the response. Most
2905 Compute resources support two types of filter expressions:
2906 expressions that support regular expressions and expressions that follow
2907 API improvement proposal AIP-160.
2908 These two types of filter expressions cannot be mixed in one request.
2909
2910 If you want to use AIP-160, your expression must specify the field name, an
2911 operator, and the value that you want to use for filtering. The value
2912 must be a string, a number, or a boolean. The operator
2913 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2914
2915 For example, if you are filtering Compute Engine instances, you can
2916 exclude instances named `example-instance` by specifying
2917 `name != example-instance`.
2918
2919 The `:*` comparison can be used to test whether a key has been defined.
2920 For example, to find all objects with `owner` label use:
2921 ```
2922 labels.owner:*
2923 ```
2924
2925 You can also filter nested fields. For example, you could specify
2926 `scheduling.automaticRestart = false` to include instances only
2927 if they are not scheduled for automatic restarts. You can use filtering
2928 on nested fields to filter based onresource labels.
2929
2930 To filter on multiple expressions, provide each separate expression within
2931 parentheses. For example:
2932 ```
2933 (scheduling.automaticRestart = true)
2934 (cpuPlatform = &quot;Intel Skylake&quot;)
2935 ```
2936 By default, each expression is an `AND` expression. However, you
2937 can include `AND` and `OR` expressions explicitly.
2938 For example:
2939 ```
2940 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2941 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2942 (scheduling.automaticRestart = true)
2943 ```
2944
2945 If you want to use a regular expression, use the `eq` (equal) or `ne`
2946 (not equal) operator against a single un-parenthesized expression with or
2947 without quotes or against multiple parenthesized expressions. Examples:
2948
2949 `fieldname eq unquoted literal`
2950 `fieldname eq &#x27;single quoted literal&#x27;`
2951 `fieldname eq &quot;double quoted literal&quot;`
2952 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2953
2954 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2955 The literal value must match the entire field.
2956
2957 For example, to filter for instances that do not end with name &quot;instance&quot;,
2958 you would use `name ne .*instance`.
2959
2960 You cannot combine constraints on multiple fields using regular
2961 expressions.
2962 maxResults: integer, The maximum number of results per page that should be returned.
2963 If the number of available results is larger than `maxResults`,
2964 Compute Engine returns a `nextPageToken` that can be used to get
2965 the next page of results in subsequent list requests. Acceptable values are
2966 `0` to `500`, inclusive. (Default: `500`)
2967 orderBy: string, Sorts list results by a certain order. By default, results
2968 are returned in alphanumerical order based on the resource name.
2969
2970 You can also sort results in descending order based on the creation
2971 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2972 results based on the `creationTimestamp` field in
2973 reverse chronological order (newest result first). Use this to sort
2974 resources like operations so that the newest operation is returned first.
2975
2976 Currently, only sorting by `name` or
2977 `creationTimestamp desc` is supported.
2978 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2979 `nextPageToken` returned by a previous list request to get
2980 the next page of results.
2981 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2982 of failure. The default value is false.
2983
2984 For example, when partial success behavior is enabled, aggregatedList for a
2985 single zone scope either returns all resources in the zone or no resources,
2986 with an error code.
2987 x__xgafv: string, V1 error format.
2988 Allowed values
2989 1 - v1 error format
2990 2 - v2 error format
2991
2992 Returns:
2993 An object of the form:
2994
2995 { # Contains a list of networks.
2996 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2997 &quot;items&quot;: [ # A list of Network resources.
2998 { # Represents a VPC Network resource.
2999 #
3000 # Networks connect resources to each other and to the internet. For more
3001 # information, readVirtual Private Cloud (VPC) Network.
3002 &quot;IPv4Range&quot;: &quot;A String&quot;, # Deprecated in favor of subnet mode networks.
3003 # The range of internal addresses that are legal on this network. This
3004 # range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is
3005 # created.
3006 &quot;autoCreateSubnetworks&quot;: True or False, # Must be set to create a VPC network. If not set, a legacy network is
3007 # created.
3008 #
3009 # When set to true, the VPC network is created in auto mode.
3010 # When set to false, the VPC network is created in custom mode.
3011 #
3012 # An auto mode VPC network starts with one subnet per region. Each subnet
3013 # has a predetermined range as described inAuto mode VPC network IP ranges.
3014 #
3015 # For custom mode VPC networks, you can add subnets using the subnetworksinsert
3016 # method.
3017 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3018 # text format.
3019 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
3020 # create the resource.
3021 &quot;enableUlaInternalIpv6&quot;: True or False, # Enable ULA internal ipv6 on this network. Enabling this feature will assign
3022 # a /48 from google defined ULA prefix fd20::/20.
3023 # .
3024 &quot;firewallPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the firewall policy the network is associated with.
3025 &quot;gatewayIPv4&quot;: &quot;A String&quot;, # [Output Only] The gateway address for default routing out of the network,
3026 # selected by Google Cloud.
3027 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3028 # defined by the server.
3029 &quot;internalIpv6Range&quot;: &quot;A String&quot;, # When enabling ula internal ipv6, caller optionally can specify the /48
3030 # range they want from the google defined ULA prefix fd20::/20. The input
3031 # must be a valid /48 ULA IPv6 address and must be within the fd20::/20.
3032 # Operation will fail if the speficied /48 is already in used by another
3033 # resource. If the field is not speficied, then a /48 range will be randomly
3034 # allocated from fd20::/20 and returned via this field.
3035 # .
3036 &quot;kind&quot;: &quot;compute#network&quot;, # Output only. [Output Only] Type of the resource. Always compute#network for
3037 # networks.
3038 &quot;mtu&quot;: 42, # Maximum Transmission Unit in bytes.
3039 # The minimum value for this field is 1300 and the maximum value is 8896.
3040 # The suggested value is 1500, which is the default MTU used on the
3041 # Internet, or 8896 if you want to use Jumbo frames. If unspecified, the
3042 # value defaults to 1460.
3043 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3044 # The name must be 1-63 characters long, and comply withRFC1035.
3045 # Specifically, the name must be 1-63 characters long and match the regular
3046 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
3047 # lowercase letter, and all following characters (except for the last
3048 # character) must be a dash, lowercase letter, or digit. The last character
3049 # must be a lowercase letter or digit.
3050 &quot;networkFirewallPolicyEnforcementOrder&quot;: &quot;A String&quot;, # The network firewall policy enforcement order. Can be either
3051 # AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to
3052 # AFTER_CLASSIC_FIREWALL if the field is not specified.
3053 &quot;networkProfile&quot;: &quot;A String&quot;, # A full or partial URL of the network profile to apply to this network.
3054 # This field can be set only at resource creation time. For example, the
3055 # following are valid URLs:
3056 #
3057 # - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name}
3058 # - projects/{project_id}/global/networkProfiles/{network_profile_name}
3059 &quot;params&quot;: { # Additional network parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3060 # as part of resource payload.
3061 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3062 # Tag keys and values have the same definition as resource
3063 # manager tags. The field is allowed for INSERT
3064 # only. The keys/values to set on the resource should be specified in
3065 # either ID { : } or Namespaced format
3066 # { : }.
3067 # For example the following are valid inputs:
3068 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3069 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3070 # Note:
3071 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3072 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3073 &quot;a_key&quot;: &quot;A String&quot;,
3074 },
3075 },
3076 &quot;peerings&quot;: [ # Output only. [Output Only] A list of network peerings for the resource.
3077 { # A network peering attached to a network resource. The message includes the
3078 # peering name, peer network, peering state, and a flag indicating whether
3079 # Google Compute Engine should automatically create routes for the peering.
3080 &quot;advertisePeerSubnetsViaRouters&quot;: True or False, # Whether Cloud Routers in this network can automatically advertise subnets
3081 # from the peer network.
3082 &quot;autoCreateRoutes&quot;: True or False, # This field will be deprecated soon. Use theexchange_subnet_routes field instead.
3083 # Indicates whether full mesh connectivity is created and managed
3084 # automatically between peered networks. Currently this field should always
3085 # be true since Google Compute Engine will automatically create and manage
3086 # subnetwork routes between two networks when peering state isACTIVE.
3087 &quot;connectionStatus&quot;: { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection
3088 # as a whole.
3089 # local peering. This field provides information about the effective settings
3090 # for the connection as a whole, including pending delete/update requests for
3091 # CONSENSUS peerings.
3092 &quot;consensusState&quot;: { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update
3093 # and delete for a consensus peering connection.
3094 # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the
3095 # strategy to CONSENSUS.
3096 &quot;deleteStatus&quot;: &quot;A String&quot;, # The status of the delete request.
3097 &quot;updateStatus&quot;: &quot;A String&quot;, # The status of the update request.
3098 },
3099 &quot;trafficConfiguration&quot;: { # The active connectivity settings for the peering connection based on the
3100 # settings of the network peerings.
3101 &quot;exportCustomRoutesToPeer&quot;: True or False, # Whether custom routes are being exported to the peer network.
3102 &quot;exportSubnetRoutesWithPublicIpToPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being exported to the
3103 # peer network.
3104 &quot;importCustomRoutesFromPeer&quot;: True or False, # Whether custom routes are being imported from the peer network.
3105 &quot;importSubnetRoutesWithPublicIpFromPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being imported
3106 # from the peer network.
3107 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are being imported or
3108 # exported between peer networks.
3109 },
3110 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the update/delete semantics for this
3111 # peering connection.
3112 },
3113 &quot;exchangeSubnetRoutes&quot;: True or False, # Indicates whether full mesh connectivity is created and managed
3114 # automatically between peered networks. Currently this field should always
3115 # be true since Google Compute Engine will automatically create and manage
3116 # subnetwork routes between two networks when peering state isACTIVE.
3117 &quot;exportCustomRoutes&quot;: True or False, # Whether to export the custom routes to peer network. The default value is
3118 # false.
3119 &quot;exportSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are exported. The default value
3120 # is true, all subnet routes are exported.IPv4
3121 # special-use ranges are always
3122 # exported to peers and are not controlled by this field.
3123 &quot;importCustomRoutes&quot;: True or False, # Whether to import the custom routes from peer network. The default value is
3124 # false.
3125 &quot;importSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are imported. The default value
3126 # is false.IPv4
3127 # special-use ranges are always
3128 # imported from peers and are not controlled by this field.
3129 &quot;name&quot;: &quot;A String&quot;, # Name of this peering. Provided by the client when the peering is created.
3130 # The name must comply withRFC1035.
3131 # Specifically, the name must be 1-63 characters long and match regular
3132 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
3133 # lowercase letter, and all the following characters must be a dash,
3134 # lowercase letter, or digit, except the last character, which cannot be a
3135 # dash.
3136 &quot;network&quot;: &quot;A String&quot;, # The URL of the peer network. It can be either full URL or partial URL. The
3137 # peer network may belong to a different project. If the partial URL does not
3138 # contain project, it is assumed that the peer network is in the same project
3139 # as the current network.
3140 &quot;peerMtu&quot;: 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network.
3141 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are allowed to be imported or
3142 # exported between peer networks. The default value is IPV4_ONLY.
3143 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State for the peering.
3144 &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. [Output Only] Details about the current state of the peering.
3145 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the semantics for updates and deletes to the
3146 # peering connection configuration.
3147 },
3148 ],
3149 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional network resides.
3150 # This field is not applicable to global network.
3151 # You must specify this field as part of the HTTP request URL. It is
3152 # not settable as a field in the request body.
3153 &quot;routingConfig&quot;: { # A routing configuration attached to a network resource. The message # The network-level routing configuration for this network. Used by Cloud
3154 # Router to determine what type of network-wide routing behavior to enforce.
3155 # includes the list of routers associated with the network, and a flag
3156 # indicating the type of routing behavior to enforce network-wide.
3157 &quot;bgpAlwaysCompareMed&quot;: True or False, # Enable comparison of Multi-Exit Discriminators (MED) across routes with
3158 # different neighbor ASNs when using the STANDARD BGP best path selection
3159 # algorithm.
3160 &quot;bgpBestPathSelectionMode&quot;: &quot;A String&quot;, # The BGP best path selection algorithm to be employed within this network
3161 # for dynamic routes learned by Cloud Routers. Can be LEGACY
3162 # (default) or STANDARD.
3163 &quot;bgpInterRegionCost&quot;: &quot;A String&quot;, # Allows to define a preferred approach for handling inter-region cost in
3164 # the selection process when using the STANDARD BGP best path
3165 # selection algorithm. Can be DEFAULT orADD_COST_TO_MED.
3166 &quot;effectiveBgpAlwaysCompareMed&quot;: True or False, # Output only. [Output Only] Effective value of the bgp_always_compare_med
3167 # field.
3168 &quot;effectiveBgpInterRegionCost&quot;: &quot;A String&quot;, # Output only. [Output Only] Effective value of the bgp_inter_region_cost
3169 # field.
3170 &quot;routingMode&quot;: &quot;A String&quot;, # The network-wide routing mode to use. If set to REGIONAL,
3171 # this network&#x27;s Cloud Routers will only advertise routes with subnets
3172 # of this network in the same region as the router. If set toGLOBAL, this network&#x27;s Cloud Routers will advertise
3173 # routes with all subnets of this network, across regions.
3174 },
3175 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3176 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3177 &quot;subnetworks&quot;: [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks
3178 # in this VPC network.
3179 &quot;A String&quot;,
3180 ],
3181 },
3182 ],
3183 &quot;kind&quot;: &quot;compute#networkList&quot;, # Output only. [Output Only] Type of resource. Always compute#networkList for
3184 # lists of networks.
3185 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
3186 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
3187 # the query parameter pageToken in the next list request.
3188 # Subsequent list requests will have their own nextPageToken to
3189 # continue paging through the results.
3190 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
3191 &quot;warning&quot;: { # [Output Only] Informational warning message.
3192 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3193 # Engine returns NO_RESULTS_ON_PAGE if there
3194 # are no results in the response.
3195 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3196 # value format. For example:
3197 #
3198 # &quot;data&quot;: [
3199 # {
3200 # &quot;key&quot;: &quot;scope&quot;,
3201 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3202 # }
3203 {
3204 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3205 # returned. For example, for warnings where there are no results in a list
3206 # request for a particular zone, this key might be scope and
3207 # the key value might be the zone name. Other examples might be a key
3208 # indicating a deprecated resource and a suggested replacement, or a
3209 # warning about invalid network settings (for example, if an instance
3210 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3211 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3212 },
3213 ],
3214 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3215 },
3216 }</pre>
3217 </div>
3218
3219 <div class="method">
3220 <code class="details" id="listIpAddresses">listIpAddresses(project, network, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, types=None, x__xgafv=None)</code>
3221 <pre>Lists the internal IP addresses in the specified network.
3222
3223 Args:
3224 project: string, Project ID for this request. (required)
3225 network: string, Name of the network for this request. (required)
3226 filter: string, A filter expression that filters resources listed in the response. Most
3227 Compute resources support two types of filter expressions:
3228 expressions that support regular expressions and expressions that follow
3229 API improvement proposal AIP-160.
3230 These two types of filter expressions cannot be mixed in one request.
3231
3232 If you want to use AIP-160, your expression must specify the field name, an
3233 operator, and the value that you want to use for filtering. The value
3234 must be a string, a number, or a boolean. The operator
3235 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
3236
3237 For example, if you are filtering Compute Engine instances, you can
3238 exclude instances named `example-instance` by specifying
3239 `name != example-instance`.
3240
3241 The `:*` comparison can be used to test whether a key has been defined.
3242 For example, to find all objects with `owner` label use:
3243 ```
3244 labels.owner:*
3245 ```
3246
3247 You can also filter nested fields. For example, you could specify
3248 `scheduling.automaticRestart = false` to include instances only
3249 if they are not scheduled for automatic restarts. You can use filtering
3250 on nested fields to filter based onresource labels.
3251
3252 To filter on multiple expressions, provide each separate expression within
3253 parentheses. For example:
3254 ```
3255 (scheduling.automaticRestart = true)
3256 (cpuPlatform = &quot;Intel Skylake&quot;)
3257 ```
3258 By default, each expression is an `AND` expression. However, you
3259 can include `AND` and `OR` expressions explicitly.
3260 For example:
3261 ```
3262 (cpuPlatform = &quot;Intel Skylake&quot;) OR
3263 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
3264 (scheduling.automaticRestart = true)
3265 ```
3266
3267 If you want to use a regular expression, use the `eq` (equal) or `ne`
3268 (not equal) operator against a single un-parenthesized expression with or
3269 without quotes or against multiple parenthesized expressions. Examples:
3270
3271 `fieldname eq unquoted literal`
3272 `fieldname eq &#x27;single quoted literal&#x27;`
3273 `fieldname eq &quot;double quoted literal&quot;`
3274 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
3275
3276 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
3277 The literal value must match the entire field.
3278
3279 For example, to filter for instances that do not end with name &quot;instance&quot;,
3280 you would use `name ne .*instance`.
3281
3282 You cannot combine constraints on multiple fields using regular
3283 expressions.
3284 maxResults: integer, The maximum number of results per page that should be returned.
3285 If the number of available results is larger than `maxResults`,
3286 Compute Engine returns a `nextPageToken` that can be used to get
3287 the next page of results in subsequent list requests. Acceptable values are
3288 `0` to `500`, inclusive. (Default: `500`)
3289 orderBy: string, Sorts list results by a certain order. By default, results
3290 are returned in alphanumerical order based on the resource name.
3291
3292 You can also sort results in descending order based on the creation
3293 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
3294 results based on the `creationTimestamp` field in
3295 reverse chronological order (newest result first). Use this to sort
3296 resources like operations so that the newest operation is returned first.
3297
3298 Currently, only sorting by `name` or
3299 `creationTimestamp desc` is supported.
3300 pageToken: string, Specifies a page token to use. Set `pageToken` to the
3301 `nextPageToken` returned by a previous list request to get
3302 the next page of results.
3303 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
3304 of failure. The default value is false.
3305
3306 For example, when partial success behavior is enabled, aggregatedList for a
3307 single zone scope either returns all resources in the zone or no resources,
3308 with an error code.
3309 types: string, (Optional) types filter separate by comma, valid values are: SUBNETWORK,
3310 RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED.
3311 x__xgafv: string, V1 error format.
3312 Allowed values
3313 1 - v1 error format
3314 2 - v2 error format
3315
3316 Returns:
3317 An object of the form:
3318
3319 {
3320 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3321 &quot;items&quot;: [ # A list of InternalIpAddress resources.
3322 {
3323 &quot;cidr&quot;: &quot;A String&quot;, # IP CIDR address or range.
3324 &quot;owner&quot;: &quot;A String&quot;, # The owner of the internal IP address.
3325 &quot;purpose&quot;: &quot;A String&quot;, # The purpose of the internal IP address if applicable.
3326 &quot;region&quot;: &quot;A String&quot;, # The region of the internal IP address if applicable.
3327 &quot;type&quot;: &quot;A String&quot;, # The type of the internal IP address.
3328 },
3329 ],
3330 &quot;kind&quot;: &quot;compute#ipAddressesList&quot;, # Output only. [Output Only] Type of resource. Always compute#ipAddressesList
3331 # for IP addresses lists.
3332 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
3333 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
3334 # the query parameter pageToken in the next list request.
3335 # Subsequent list requests will have their own nextPageToken to
3336 # continue paging through the results.
3337 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
3338 &quot;warning&quot;: { # [Output Only] Informational warning message.
3339 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3340 # Engine returns NO_RESULTS_ON_PAGE if there
3341 # are no results in the response.
3342 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3343 # value format. For example:
3344 #
3345 # &quot;data&quot;: [
3346 # {
3347 # &quot;key&quot;: &quot;scope&quot;,
3348 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3349 # }
3350 {
3351 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3352 # returned. For example, for warnings where there are no results in a list
3353 # request for a particular zone, this key might be scope and
3354 # the key value might be the zone name. Other examples might be a key
3355 # indicating a deprecated resource and a suggested replacement, or a
3356 # warning about invalid network settings (for example, if an instance
3357 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3358 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3359 },
3360 ],
3361 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3362 },
3363 }</pre>
3364 </div>
3365
3366 <div class="method">
3367 <code class="details" id="listIpAddresses_next">listIpAddresses_next()</code>
3368 <pre>Retrieves the next page of results.
3369
3370 Args:
3371 previous_request: The request for the previous page. (required)
3372 previous_response: The response from the request for the previous page. (required)
3373
3374 Returns:
3375 A request object that you can call &#x27;execute()&#x27; on to request the next
3376 page. Returns None if there are no more items in the collection.
3377 </pre>
3378 </div>
3379
3380 <div class="method">
3381 <code class="details" id="listIpOwners">listIpOwners(project, network, filter=None, ipCidrRange=None, maxResults=None, orderBy=None, ownerProjects=None, ownerTypes=None, pageToken=None, returnPartialSuccess=None, subnetName=None, subnetRegion=None, x__xgafv=None)</code>
3382 <pre>Lists the internal IP owners in the specified network.
3383
3384 Args:
3385 project: string, Project ID for this request. (required)
3386 network: string, Name of the network to return. (required)
3387 filter: string, A filter expression that filters resources listed in the response. Most
3388 Compute resources support two types of filter expressions:
3389 expressions that support regular expressions and expressions that follow
3390 API improvement proposal AIP-160.
3391 These two types of filter expressions cannot be mixed in one request.
3392
3393 If you want to use AIP-160, your expression must specify the field name, an
3394 operator, and the value that you want to use for filtering. The value
3395 must be a string, a number, or a boolean. The operator
3396 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
3397
3398 For example, if you are filtering Compute Engine instances, you can
3399 exclude instances named `example-instance` by specifying
3400 `name != example-instance`.
3401
3402 The `:*` comparison can be used to test whether a key has been defined.
3403 For example, to find all objects with `owner` label use:
3404 ```
3405 labels.owner:*
3406 ```
3407
3408 You can also filter nested fields. For example, you could specify
3409 `scheduling.automaticRestart = false` to include instances only
3410 if they are not scheduled for automatic restarts. You can use filtering
3411 on nested fields to filter based onresource labels.
3412
3413 To filter on multiple expressions, provide each separate expression within
3414 parentheses. For example:
3415 ```
3416 (scheduling.automaticRestart = true)
3417 (cpuPlatform = &quot;Intel Skylake&quot;)
3418 ```
3419 By default, each expression is an `AND` expression. However, you
3420 can include `AND` and `OR` expressions explicitly.
3421 For example:
3422 ```
3423 (cpuPlatform = &quot;Intel Skylake&quot;) OR
3424 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
3425 (scheduling.automaticRestart = true)
3426 ```
3427
3428 If you want to use a regular expression, use the `eq` (equal) or `ne`
3429 (not equal) operator against a single un-parenthesized expression with or
3430 without quotes or against multiple parenthesized expressions. Examples:
3431
3432 `fieldname eq unquoted literal`
3433 `fieldname eq &#x27;single quoted literal&#x27;`
3434 `fieldname eq &quot;double quoted literal&quot;`
3435 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
3436
3437 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
3438 The literal value must match the entire field.
3439
3440 For example, to filter for instances that do not end with name &quot;instance&quot;,
3441 you would use `name ne .*instance`.
3442
3443 You cannot combine constraints on multiple fields using regular
3444 expressions.
3445 ipCidrRange: string, (Optional) IP CIDR range filter, example: &quot;10.128.10.0/30&quot;.
3446 maxResults: integer, The maximum number of results per page that should be returned.
3447 If the number of available results is larger than `maxResults`,
3448 Compute Engine returns a `nextPageToken` that can be used to get
3449 the next page of results in subsequent list requests. Acceptable values are
3450 `0` to `500`, inclusive. (Default: `500`)
3451 orderBy: string, Sorts list results by a certain order. By default, results
3452 are returned in alphanumerical order based on the resource name.
3453
3454 You can also sort results in descending order based on the creation
3455 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
3456 results based on the `creationTimestamp` field in
3457 reverse chronological order (newest result first). Use this to sort
3458 resources like operations so that the newest operation is returned first.
3459
3460 Currently, only sorting by `name` or
3461 `creationTimestamp desc` is supported.
3462 ownerProjects: string, (Optional) Project IDs filter, example: &quot;project-1,project-2&quot;.
3463 ownerTypes: string, (Optional) Owner types filter, example: &quot;instance,forwardingRule&quot;.
3464 pageToken: string, Specifies a page token to use. Set `pageToken` to the
3465 `nextPageToken` returned by a previous list request to get
3466 the next page of results.
3467 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
3468 of failure. The default value is false.
3469
3470 For example, when partial success behavior is enabled, aggregatedList for a
3471 single zone scope either returns all resources in the zone or no resources,
3472 with an error code.
3473 subnetName: string, (Optional) Subnetwork name filter.
3474 subnetRegion: string, (Optional) Subnetwork region filter.
3475 x__xgafv: string, V1 error format.
3476 Allowed values
3477 1 - v1 error format
3478 2 - v2 error format
3479
3480 Returns:
3481 An object of the form:
3482
3483 { # Contains a list of IP owners.
3484 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3485 &quot;items&quot;: [ # A list of InternalIpOwner resources.
3486 {
3487 &quot;ipCidrRange&quot;: &quot;A String&quot;, # IP CIDR range being owned.
3488 &quot;owners&quot;: [ # URLs of the IP owners of the IP CIDR range.
3489 &quot;A String&quot;,
3490 ],
3491 &quot;systemOwned&quot;: True or False, # Whether this IP CIDR range is reserved for system use.
3492 },
3493 ],
3494 &quot;kind&quot;: &quot;compute#ipOwnerList&quot;, # Output only. [Output Only] Type of resource. Always compute#ipOwnerList for
3495 # lists of IP owners.
3496 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
3497 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
3498 # the query parameter pageToken in the next list request.
3499 # Subsequent list requests will have their own nextPageToken to
3500 # continue paging through the results.
3501 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
3502 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
3503 &quot;A String&quot;,
3504 ],
3505 &quot;warning&quot;: { # [Output Only] Informational warning message.
3506 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3507 # Engine returns NO_RESULTS_ON_PAGE if there
3508 # are no results in the response.
3509 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3510 # value format. For example:
3511 #
3512 # &quot;data&quot;: [
3513 # {
3514 # &quot;key&quot;: &quot;scope&quot;,
3515 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3516 # }
3517 {
3518 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3519 # returned. For example, for warnings where there are no results in a list
3520 # request for a particular zone, this key might be scope and
3521 # the key value might be the zone name. Other examples might be a key
3522 # indicating a deprecated resource and a suggested replacement, or a
3523 # warning about invalid network settings (for example, if an instance
3524 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3525 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3526 },
3527 ],
3528 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3529 },
3530 }</pre>
3531 </div>
3532
3533 <div class="method">
3534 <code class="details" id="listIpOwners_next">listIpOwners_next()</code>
3535 <pre>Retrieves the next page of results.
3536
3537 Args:
3538 previous_request: The request for the previous page. (required)
3539 previous_response: The response from the request for the previous page. (required)
3540
3541 Returns:
3542 A request object that you can call &#x27;execute()&#x27; on to request the next
3543 page. Returns None if there are no more items in the collection.
3544 </pre>
3545 </div>
3546
3547 <div class="method">
3548 <code class="details" id="listPeeringRoutes">listPeeringRoutes(project, network, direction=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peeringName=None, region=None, returnPartialSuccess=None, x__xgafv=None)</code>
3549 <pre>Lists the peering routes exchanged over peering connection.
3550
3551 Args:
3552 project: string, Project ID for this request. (required)
3553 network: string, Name of the network for this request. (required)
3554 direction: string, The direction of the exchanged routes.
3555 Allowed values
3556 INCOMING - For routes exported from peer network.
3557 OUTGOING - For routes exported from local network.
3558 filter: string, A filter expression that filters resources listed in the response. Most
3559 Compute resources support two types of filter expressions:
3560 expressions that support regular expressions and expressions that follow
3561 API improvement proposal AIP-160.
3562 These two types of filter expressions cannot be mixed in one request.
3563
3564 If you want to use AIP-160, your expression must specify the field name, an
3565 operator, and the value that you want to use for filtering. The value
3566 must be a string, a number, or a boolean. The operator
3567 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
3568
3569 For example, if you are filtering Compute Engine instances, you can
3570 exclude instances named `example-instance` by specifying
3571 `name != example-instance`.
3572
3573 The `:*` comparison can be used to test whether a key has been defined.
3574 For example, to find all objects with `owner` label use:
3575 ```
3576 labels.owner:*
3577 ```
3578
3579 You can also filter nested fields. For example, you could specify
3580 `scheduling.automaticRestart = false` to include instances only
3581 if they are not scheduled for automatic restarts. You can use filtering
3582 on nested fields to filter based onresource labels.
3583
3584 To filter on multiple expressions, provide each separate expression within
3585 parentheses. For example:
3586 ```
3587 (scheduling.automaticRestart = true)
3588 (cpuPlatform = &quot;Intel Skylake&quot;)
3589 ```
3590 By default, each expression is an `AND` expression. However, you
3591 can include `AND` and `OR` expressions explicitly.
3592 For example:
3593 ```
3594 (cpuPlatform = &quot;Intel Skylake&quot;) OR
3595 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
3596 (scheduling.automaticRestart = true)
3597 ```
3598
3599 If you want to use a regular expression, use the `eq` (equal) or `ne`
3600 (not equal) operator against a single un-parenthesized expression with or
3601 without quotes or against multiple parenthesized expressions. Examples:
3602
3603 `fieldname eq unquoted literal`
3604 `fieldname eq &#x27;single quoted literal&#x27;`
3605 `fieldname eq &quot;double quoted literal&quot;`
3606 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
3607
3608 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
3609 The literal value must match the entire field.
3610
3611 For example, to filter for instances that do not end with name &quot;instance&quot;,
3612 you would use `name ne .*instance`.
3613
3614 You cannot combine constraints on multiple fields using regular
3615 expressions.
3616 maxResults: integer, The maximum number of results per page that should be returned.
3617 If the number of available results is larger than `maxResults`,
3618 Compute Engine returns a `nextPageToken` that can be used to get
3619 the next page of results in subsequent list requests. Acceptable values are
3620 `0` to `500`, inclusive. (Default: `500`)
3621 orderBy: string, Sorts list results by a certain order. By default, results
3622 are returned in alphanumerical order based on the resource name.
3623
3624 You can also sort results in descending order based on the creation
3625 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
3626 results based on the `creationTimestamp` field in
3627 reverse chronological order (newest result first). Use this to sort
3628 resources like operations so that the newest operation is returned first.
3629
3630 Currently, only sorting by `name` or
3631 `creationTimestamp desc` is supported.
3632 pageToken: string, Specifies a page token to use. Set `pageToken` to the
3633 `nextPageToken` returned by a previous list request to get
3634 the next page of results.
3635 peeringName: string, The response will show routes exchanged over the given peering connection.
3636 region: string, The region of the request. The response will include all subnet routes,
3637 static routes and dynamic routes in the region.
3638 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
3639 of failure. The default value is false.
3640
3641 For example, when partial success behavior is enabled, aggregatedList for a
3642 single zone scope either returns all resources in the zone or no resources,
3643 with an error code.
3644 x__xgafv: string, V1 error format.
3645 Allowed values
3646 1 - v1 error format
3647 2 - v2 error format
3648
3649 Returns:
3650 An object of the form:
3651
3652 {
3653 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3654 &quot;items&quot;: [ # A list of ExchangedPeeringRoute resources.
3655 {
3656 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of the route.
3657 &quot;imported&quot;: True or False, # True if the peering route has been imported from a peer. The actual import
3658 # happens if the field networkPeering.importCustomRoutes is true
3659 # for this network, and networkPeering.exportCustomRoutes is
3660 # true for the peer network, and the import does not result in a route
3661 # conflict.
3662 &quot;nextHopRegion&quot;: &quot;A String&quot;, # The region of peering route next hop, only applies to dynamic routes.
3663 &quot;priority&quot;: 42, # The priority of the peering route.
3664 &quot;type&quot;: &quot;A String&quot;, # The type of the peering route.
3665 },
3666 ],
3667 &quot;kind&quot;: &quot;compute#exchangedPeeringRoutesList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#exchangedPeeringRoutesList for exchanged peering
3668 # routes lists.
3669 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
3670 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
3671 # the query parameter pageToken in the next list request.
3672 # Subsequent list requests will have their own nextPageToken to
3673 # continue paging through the results.
3674 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
3675 &quot;warning&quot;: { # [Output Only] Informational warning message.
3676 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3677 # Engine returns NO_RESULTS_ON_PAGE if there
3678 # are no results in the response.
3679 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3680 # value format. For example:
3681 #
3682 # &quot;data&quot;: [
3683 # {
3684 # &quot;key&quot;: &quot;scope&quot;,
3685 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3686 # }
3687 {
3688 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3689 # returned. For example, for warnings where there are no results in a list
3690 # request for a particular zone, this key might be scope and
3691 # the key value might be the zone name. Other examples might be a key
3692 # indicating a deprecated resource and a suggested replacement, or a
3693 # warning about invalid network settings (for example, if an instance
3694 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3695 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3696 },
3697 ],
3698 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3699 },
3700 }</pre>
3701 </div>
3702
3703 <div class="method">
3704 <code class="details" id="listPeeringRoutes_next">listPeeringRoutes_next()</code>
3705 <pre>Retrieves the next page of results.
3706
3707 Args:
3708 previous_request: The request for the previous page. (required)
3709 previous_response: The response from the request for the previous page. (required)
3710
3711 Returns:
3712 A request object that you can call &#x27;execute()&#x27; on to request the next
3713 page. Returns None if there are no more items in the collection.
3714 </pre>
3715 </div>
3716
3717 <div class="method">
3718 <code class="details" id="list_next">list_next()</code>
3719 <pre>Retrieves the next page of results.
3720
3721 Args:
3722 previous_request: The request for the previous page. (required)
3723 previous_response: The response from the request for the previous page. (required)
3724
3725 Returns:
3726 A request object that you can call &#x27;execute()&#x27; on to request the next
3727 page. Returns None if there are no more items in the collection.
3728 </pre>
3729 </div>
3730
3731 <div class="method">
3732 <code class="details" id="patch">patch(project, network, body=None, requestId=None, x__xgafv=None)</code>
3733 <pre>Patches the specified network with the data included in the request.
3734 Only routingConfig can be modified.
3735
3736 Args:
3737 project: string, Project ID for this request. (required)
3738 network: string, Name of the network to update. (required)
3739 body: object, The request body.
3740 The object takes the form of:
3741
3742 { # Represents a VPC Network resource.
3743 #
3744 # Networks connect resources to each other and to the internet. For more
3745 # information, readVirtual Private Cloud (VPC) Network.
3746 &quot;IPv4Range&quot;: &quot;A String&quot;, # Deprecated in favor of subnet mode networks.
3747 # The range of internal addresses that are legal on this network. This
3748 # range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is
3749 # created.
3750 &quot;autoCreateSubnetworks&quot;: True or False, # Must be set to create a VPC network. If not set, a legacy network is
3751 # created.
3752 #
3753 # When set to true, the VPC network is created in auto mode.
3754 # When set to false, the VPC network is created in custom mode.
3755 #
3756 # An auto mode VPC network starts with one subnet per region. Each subnet
3757 # has a predetermined range as described inAuto mode VPC network IP ranges.
3758 #
3759 # For custom mode VPC networks, you can add subnets using the subnetworksinsert
3760 # method.
3761 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3762 # text format.
3763 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
3764 # create the resource.
3765 &quot;enableUlaInternalIpv6&quot;: True or False, # Enable ULA internal ipv6 on this network. Enabling this feature will assign
3766 # a /48 from google defined ULA prefix fd20::/20.
3767 # .
3768 &quot;firewallPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the firewall policy the network is associated with.
3769 &quot;gatewayIPv4&quot;: &quot;A String&quot;, # [Output Only] The gateway address for default routing out of the network,
3770 # selected by Google Cloud.
3771 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3772 # defined by the server.
3773 &quot;internalIpv6Range&quot;: &quot;A String&quot;, # When enabling ula internal ipv6, caller optionally can specify the /48
3774 # range they want from the google defined ULA prefix fd20::/20. The input
3775 # must be a valid /48 ULA IPv6 address and must be within the fd20::/20.
3776 # Operation will fail if the speficied /48 is already in used by another
3777 # resource. If the field is not speficied, then a /48 range will be randomly
3778 # allocated from fd20::/20 and returned via this field.
3779 # .
3780 &quot;kind&quot;: &quot;compute#network&quot;, # Output only. [Output Only] Type of the resource. Always compute#network for
3781 # networks.
3782 &quot;mtu&quot;: 42, # Maximum Transmission Unit in bytes.
3783 # The minimum value for this field is 1300 and the maximum value is 8896.
3784 # The suggested value is 1500, which is the default MTU used on the
3785 # Internet, or 8896 if you want to use Jumbo frames. If unspecified, the
3786 # value defaults to 1460.
3787 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3788 # The name must be 1-63 characters long, and comply withRFC1035.
3789 # Specifically, the name must be 1-63 characters long and match the regular
3790 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
3791 # lowercase letter, and all following characters (except for the last
3792 # character) must be a dash, lowercase letter, or digit. The last character
3793 # must be a lowercase letter or digit.
3794 &quot;networkFirewallPolicyEnforcementOrder&quot;: &quot;A String&quot;, # The network firewall policy enforcement order. Can be either
3795 # AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to
3796 # AFTER_CLASSIC_FIREWALL if the field is not specified.
3797 &quot;networkProfile&quot;: &quot;A String&quot;, # A full or partial URL of the network profile to apply to this network.
3798 # This field can be set only at resource creation time. For example, the
3799 # following are valid URLs:
3800 #
3801 # - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name}
3802 # - projects/{project_id}/global/networkProfiles/{network_profile_name}
3803 &quot;params&quot;: { # Additional network parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3804 # as part of resource payload.
3805 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3806 # Tag keys and values have the same definition as resource
3807 # manager tags. The field is allowed for INSERT
3808 # only. The keys/values to set on the resource should be specified in
3809 # either ID { : } or Namespaced format
3810 # { : }.
3811 # For example the following are valid inputs:
3812 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3813 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3814 # Note:
3815 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3816 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3817 &quot;a_key&quot;: &quot;A String&quot;,
3818 },
3819 },
3820 &quot;peerings&quot;: [ # Output only. [Output Only] A list of network peerings for the resource.
3821 { # A network peering attached to a network resource. The message includes the
3822 # peering name, peer network, peering state, and a flag indicating whether
3823 # Google Compute Engine should automatically create routes for the peering.
3824 &quot;advertisePeerSubnetsViaRouters&quot;: True or False, # Whether Cloud Routers in this network can automatically advertise subnets
3825 # from the peer network.
3826 &quot;autoCreateRoutes&quot;: True or False, # This field will be deprecated soon. Use theexchange_subnet_routes field instead.
3827 # Indicates whether full mesh connectivity is created and managed
3828 # automatically between peered networks. Currently this field should always
3829 # be true since Google Compute Engine will automatically create and manage
3830 # subnetwork routes between two networks when peering state isACTIVE.
3831 &quot;connectionStatus&quot;: { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection
3832 # as a whole.
3833 # local peering. This field provides information about the effective settings
3834 # for the connection as a whole, including pending delete/update requests for
3835 # CONSENSUS peerings.
3836 &quot;consensusState&quot;: { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update
3837 # and delete for a consensus peering connection.
3838 # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the
3839 # strategy to CONSENSUS.
3840 &quot;deleteStatus&quot;: &quot;A String&quot;, # The status of the delete request.
3841 &quot;updateStatus&quot;: &quot;A String&quot;, # The status of the update request.
3842 },
3843 &quot;trafficConfiguration&quot;: { # The active connectivity settings for the peering connection based on the
3844 # settings of the network peerings.
3845 &quot;exportCustomRoutesToPeer&quot;: True or False, # Whether custom routes are being exported to the peer network.
3846 &quot;exportSubnetRoutesWithPublicIpToPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being exported to the
3847 # peer network.
3848 &quot;importCustomRoutesFromPeer&quot;: True or False, # Whether custom routes are being imported from the peer network.
3849 &quot;importSubnetRoutesWithPublicIpFromPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being imported
3850 # from the peer network.
3851 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are being imported or
3852 # exported between peer networks.
3853 },
3854 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the update/delete semantics for this
3855 # peering connection.
3856 },
3857 &quot;exchangeSubnetRoutes&quot;: True or False, # Indicates whether full mesh connectivity is created and managed
3858 # automatically between peered networks. Currently this field should always
3859 # be true since Google Compute Engine will automatically create and manage
3860 # subnetwork routes between two networks when peering state isACTIVE.
3861 &quot;exportCustomRoutes&quot;: True or False, # Whether to export the custom routes to peer network. The default value is
3862 # false.
3863 &quot;exportSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are exported. The default value
3864 # is true, all subnet routes are exported.IPv4
3865 # special-use ranges are always
3866 # exported to peers and are not controlled by this field.
3867 &quot;importCustomRoutes&quot;: True or False, # Whether to import the custom routes from peer network. The default value is
3868 # false.
3869 &quot;importSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are imported. The default value
3870 # is false.IPv4
3871 # special-use ranges are always
3872 # imported from peers and are not controlled by this field.
3873 &quot;name&quot;: &quot;A String&quot;, # Name of this peering. Provided by the client when the peering is created.
3874 # The name must comply withRFC1035.
3875 # Specifically, the name must be 1-63 characters long and match regular
3876 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
3877 # lowercase letter, and all the following characters must be a dash,
3878 # lowercase letter, or digit, except the last character, which cannot be a
3879 # dash.
3880 &quot;network&quot;: &quot;A String&quot;, # The URL of the peer network. It can be either full URL or partial URL. The
3881 # peer network may belong to a different project. If the partial URL does not
3882 # contain project, it is assumed that the peer network is in the same project
3883 # as the current network.
3884 &quot;peerMtu&quot;: 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network.
3885 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are allowed to be imported or
3886 # exported between peer networks. The default value is IPV4_ONLY.
3887 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State for the peering.
3888 &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. [Output Only] Details about the current state of the peering.
3889 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the semantics for updates and deletes to the
3890 # peering connection configuration.
3891 },
3892 ],
3893 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional network resides.
3894 # This field is not applicable to global network.
3895 # You must specify this field as part of the HTTP request URL. It is
3896 # not settable as a field in the request body.
3897 &quot;routingConfig&quot;: { # A routing configuration attached to a network resource. The message # The network-level routing configuration for this network. Used by Cloud
3898 # Router to determine what type of network-wide routing behavior to enforce.
3899 # includes the list of routers associated with the network, and a flag
3900 # indicating the type of routing behavior to enforce network-wide.
3901 &quot;bgpAlwaysCompareMed&quot;: True or False, # Enable comparison of Multi-Exit Discriminators (MED) across routes with
3902 # different neighbor ASNs when using the STANDARD BGP best path selection
3903 # algorithm.
3904 &quot;bgpBestPathSelectionMode&quot;: &quot;A String&quot;, # The BGP best path selection algorithm to be employed within this network
3905 # for dynamic routes learned by Cloud Routers. Can be LEGACY
3906 # (default) or STANDARD.
3907 &quot;bgpInterRegionCost&quot;: &quot;A String&quot;, # Allows to define a preferred approach for handling inter-region cost in
3908 # the selection process when using the STANDARD BGP best path
3909 # selection algorithm. Can be DEFAULT orADD_COST_TO_MED.
3910 &quot;effectiveBgpAlwaysCompareMed&quot;: True or False, # Output only. [Output Only] Effective value of the bgp_always_compare_med
3911 # field.
3912 &quot;effectiveBgpInterRegionCost&quot;: &quot;A String&quot;, # Output only. [Output Only] Effective value of the bgp_inter_region_cost
3913 # field.
3914 &quot;routingMode&quot;: &quot;A String&quot;, # The network-wide routing mode to use. If set to REGIONAL,
3915 # this network&#x27;s Cloud Routers will only advertise routes with subnets
3916 # of this network in the same region as the router. If set toGLOBAL, this network&#x27;s Cloud Routers will advertise
3917 # routes with all subnets of this network, across regions.
3918 },
3919 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3920 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3921 &quot;subnetworks&quot;: [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks
3922 # in this VPC network.
3923 &quot;A String&quot;,
3924 ],
3925 }
3926
3927 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3928 that if you must retry your request, the server will know to ignore the
3929 request if it has already been completed.
3930
3931 For example, consider a situation where you make an initial request and
3932 the request times out. If you make the request again with the same
3933 request ID, the server can check if original operation with the same
3934 request ID was received, and if so, will ignore the second request. This
3935 prevents clients from accidentally creating duplicate commitments.
3936
3937 The request ID must be
3938 a valid UUID with the exception that zero UUID is not supported
3939 (00000000-0000-0000-0000-000000000000).
3940 x__xgafv: string, V1 error format.
3941 Allowed values
3942 1 - v1 error format
3943 2 - v2 error format
3944
3945 Returns:
3946 An object of the form:
3947
3948 { # Represents an Operation resource.
3949 #
3950 # Google Compute Engine has three Operation resources:
3951 #
3952 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
3953 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
3954 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
3955 #
3956 # You can use an operation resource to manage asynchronous API requests.
3957 # For more information, readHandling
3958 # API responses.
3959 #
3960 # Operations can be global, regional or zonal.
3961 #
3962 # - For global operations, use the `globalOperations`
3963 # resource.
3964 # - For regional operations, use the
3965 # `regionOperations` resource.
3966 # - For zonal operations, use
3967 # the `zoneOperations` resource.
3968 #
3969 #
3970 #
3971 # For more information, read
3972 # Global, Regional, and Zonal Resources.
3973 #
3974 # Note that completed Operation resources have a limited
3975 # retention period.
3976 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3977 # Not present otherwise.
3978 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3979 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3980 # set when the operation is created.
3981 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3982 # text format.
3983 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3984 # this field will be populated.
3985 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3986 # operation.
3987 {
3988 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3989 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3990 # details. There is a set of defined message types to use for providing
3991 # details.The syntax depends on the error code. For example,
3992 # QuotaExceededInfo will have details when the error code is
3993 # QUOTA_EXCEEDED.
3994 {
3995 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3996 #
3997 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3998 # is not enabled:
3999 #
4000 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4001 # &quot;domain&quot;: &quot;googleapis.com&quot;
4002 # &quot;metadata&quot;: {
4003 # &quot;resource&quot;: &quot;projects/123&quot;,
4004 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4005 # }
4006 # }
4007 #
4008 # This response indicates that the pubsub.googleapis.com API is not enabled.
4009 #
4010 # Example of an error that is returned when attempting to create a Spanner
4011 # instance in a region that is out of stock:
4012 #
4013 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4014 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4015 # &quot;metadata&quot;: {
4016 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4017 # }
4018 # }
4019 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4020 # is typically the registered service name of the tool or product that
4021 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4022 # generated by some common infrastructure, the error domain must be a
4023 # globally unique value that identifies the infrastructure. For Google API
4024 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4025 &quot;metadatas&quot;: { # Additional structured details about this error.
4026 #
4027 # Keys must match a regular expression of `a-z+` but should
4028 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4029 # length. When identifying the current value of an exceeded limit, the units
4030 # should be contained in the key, not the value. For example, rather than
4031 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4032 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4033 # instances that can be created in a single (batch) request.
4034 &quot;a_key&quot;: &quot;A String&quot;,
4035 },
4036 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4037 # proximate cause of the error. Error reasons are unique within a particular
4038 # domain of errors. This should be at most 63 characters and match a
4039 # regular expression of `A-Z+[A-Z0-9]`, which represents
4040 # UPPER_SNAKE_CASE.
4041 },
4042 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4043 #
4044 # For example, if a quota check failed with an error indicating the calling
4045 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4046 # directly to the right place in the developer console to flip the bit.
4047 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4048 { # Describes a URL link.
4049 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4050 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4051 },
4052 ],
4053 },
4054 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4055 # which can be attached to an RPC error.
4056 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4057 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4058 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4059 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4060 },
4061 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4062 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4063 &quot;a_key&quot;: &quot;A String&quot;,
4064 },
4065 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4066 # type or metric.
4067 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4068 # or metric.
4069 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4070 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4071 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4072 },
4073 },
4074 ],
4075 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4076 # This property is optional.
4077 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4078 },
4079 ],
4080 },
4081 &quot;getVersionOperationMetadata&quot;: {
4082 &quot;inlineSbomInfo&quot;: {
4083 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4084 # appropriate identifiers.
4085 &quot;a_key&quot;: &quot;A String&quot;,
4086 },
4087 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4088 # identifiers.
4089 &quot;a_key&quot;: &quot;A String&quot;,
4090 },
4091 },
4092 },
4093 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4094 # message that was returned, such as `NOT FOUND`.
4095 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4096 # status code that was returned. For example, a `404` means the
4097 # resource was not found.
4098 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4099 # defined by the server.
4100 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4101 # This value is inRFC3339
4102 # text format.
4103 &quot;instancesBulkInsertOperationMetadata&quot;: {
4104 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4105 # Example key: zones/us-central1-a
4106 &quot;a_key&quot;: {
4107 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4108 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4109 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4110 # error.
4111 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4112 # if the flow is rolling forward or rolling back.
4113 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4114 },
4115 },
4116 },
4117 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4118 # Operation resources.
4119 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4120 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4121 # group of operations results from a `bulkInsert` API request.
4122 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4123 # `update`, or `delete`, and so on.
4124 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4125 # There is no requirement that this be linear or support any granularity of
4126 # operations. This should not be used to guess when the operation will be
4127 # complete. This number should monotonically increase as the operation
4128 # progresses.
4129 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4130 # applicable when performing regional operations.
4131 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4132 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4133 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4134 # this field will contain information on all underlying zonal actions and
4135 # their state.
4136 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4137 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4138 # Example key: zones/us-central1-a
4139 &quot;a_key&quot;: {
4140 &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
4141 # populated.
4142 # different programming environments, including REST APIs and RPC APIs. It is
4143 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4144 # three pieces of data: error code, error message, and error details.
4145 #
4146 # You can find out more about this error model and how to work with it in the
4147 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4148 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4149 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4150 # message types for APIs to use.
4151 {
4152 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4153 },
4154 ],
4155 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4156 # user-facing error message should be localized and sent in the
4157 # google.rpc.Status.details field, or localized by the client.
4158 },
4159 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4160 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4161 },
4162 },
4163 },
4164 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4165 # This value is inRFC3339
4166 # text format.
4167 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4168 # following:
4169 # `PENDING`, `RUNNING`, or `DONE`.
4170 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4171 # operation.
4172 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4173 # of the target resource.
4174 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4175 # operations related to creating a snapshot, this points to the disk
4176 # that the snapshot was created from.
4177 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4178 # `[email protected]` or
4179 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4180 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4181 # operation, this field will be populated.
4182 {
4183 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4184 # Engine returns NO_RESULTS_ON_PAGE if there
4185 # are no results in the response.
4186 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4187 # value format. For example:
4188 #
4189 # &quot;data&quot;: [
4190 # {
4191 # &quot;key&quot;: &quot;scope&quot;,
4192 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4193 # }
4194 {
4195 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4196 # returned. For example, for warnings where there are no results in a list
4197 # request for a particular zone, this key might be scope and
4198 # the key value might be the zone name. Other examples might be a key
4199 # indicating a deprecated resource and a suggested replacement, or a
4200 # warning about invalid network settings (for example, if an instance
4201 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4202 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4203 },
4204 ],
4205 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4206 },
4207 ],
4208 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4209 # applicable when performing per-zone operations.
4210 }</pre>
4211 </div>
4212
4213 <div class="method">
4214 <code class="details" id="removePeering">removePeering(project, network, body=None, requestId=None, x__xgafv=None)</code>
4215 <pre>Removes a peering from the specified network.
4216
4217 Args:
4218 project: string, Project ID for this request. (required)
4219 network: string, Name of the network resource to remove peering from. (required)
4220 body: object, The request body.
4221 The object takes the form of:
4222
4223 {
4224 &quot;name&quot;: &quot;A String&quot;, # Name of the peering, which should conform to RFC1035.
4225 }
4226
4227 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4228 that if you must retry your request, the server will know to ignore the
4229 request if it has already been completed.
4230
4231 For example, consider a situation where you make an initial request and
4232 the request times out. If you make the request again with the same
4233 request ID, the server can check if original operation with the same
4234 request ID was received, and if so, will ignore the second request. This
4235 prevents clients from accidentally creating duplicate commitments.
4236
4237 The request ID must be
4238 a valid UUID with the exception that zero UUID is not supported
4239 (00000000-0000-0000-0000-000000000000).
4240 x__xgafv: string, V1 error format.
4241 Allowed values
4242 1 - v1 error format
4243 2 - v2 error format
4244
4245 Returns:
4246 An object of the form:
4247
4248 { # Represents an Operation resource.
4249 #
4250 # Google Compute Engine has three Operation resources:
4251 #
4252 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4253 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4254 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4255 #
4256 # You can use an operation resource to manage asynchronous API requests.
4257 # For more information, readHandling
4258 # API responses.
4259 #
4260 # Operations can be global, regional or zonal.
4261 #
4262 # - For global operations, use the `globalOperations`
4263 # resource.
4264 # - For regional operations, use the
4265 # `regionOperations` resource.
4266 # - For zonal operations, use
4267 # the `zoneOperations` resource.
4268 #
4269 #
4270 #
4271 # For more information, read
4272 # Global, Regional, and Zonal Resources.
4273 #
4274 # Note that completed Operation resources have a limited
4275 # retention period.
4276 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4277 # Not present otherwise.
4278 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4279 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4280 # set when the operation is created.
4281 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4282 # text format.
4283 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4284 # this field will be populated.
4285 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4286 # operation.
4287 {
4288 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4289 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4290 # details. There is a set of defined message types to use for providing
4291 # details.The syntax depends on the error code. For example,
4292 # QuotaExceededInfo will have details when the error code is
4293 # QUOTA_EXCEEDED.
4294 {
4295 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4296 #
4297 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4298 # is not enabled:
4299 #
4300 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4301 # &quot;domain&quot;: &quot;googleapis.com&quot;
4302 # &quot;metadata&quot;: {
4303 # &quot;resource&quot;: &quot;projects/123&quot;,
4304 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4305 # }
4306 # }
4307 #
4308 # This response indicates that the pubsub.googleapis.com API is not enabled.
4309 #
4310 # Example of an error that is returned when attempting to create a Spanner
4311 # instance in a region that is out of stock:
4312 #
4313 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4314 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4315 # &quot;metadata&quot;: {
4316 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4317 # }
4318 # }
4319 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4320 # is typically the registered service name of the tool or product that
4321 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4322 # generated by some common infrastructure, the error domain must be a
4323 # globally unique value that identifies the infrastructure. For Google API
4324 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4325 &quot;metadatas&quot;: { # Additional structured details about this error.
4326 #
4327 # Keys must match a regular expression of `a-z+` but should
4328 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4329 # length. When identifying the current value of an exceeded limit, the units
4330 # should be contained in the key, not the value. For example, rather than
4331 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4332 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4333 # instances that can be created in a single (batch) request.
4334 &quot;a_key&quot;: &quot;A String&quot;,
4335 },
4336 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4337 # proximate cause of the error. Error reasons are unique within a particular
4338 # domain of errors. This should be at most 63 characters and match a
4339 # regular expression of `A-Z+[A-Z0-9]`, which represents
4340 # UPPER_SNAKE_CASE.
4341 },
4342 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4343 #
4344 # For example, if a quota check failed with an error indicating the calling
4345 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4346 # directly to the right place in the developer console to flip the bit.
4347 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4348 { # Describes a URL link.
4349 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4350 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4351 },
4352 ],
4353 },
4354 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4355 # which can be attached to an RPC error.
4356 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4357 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4358 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4359 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4360 },
4361 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4362 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4363 &quot;a_key&quot;: &quot;A String&quot;,
4364 },
4365 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4366 # type or metric.
4367 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4368 # or metric.
4369 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4370 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4371 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4372 },
4373 },
4374 ],
4375 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4376 # This property is optional.
4377 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4378 },
4379 ],
4380 },
4381 &quot;getVersionOperationMetadata&quot;: {
4382 &quot;inlineSbomInfo&quot;: {
4383 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4384 # appropriate identifiers.
4385 &quot;a_key&quot;: &quot;A String&quot;,
4386 },
4387 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4388 # identifiers.
4389 &quot;a_key&quot;: &quot;A String&quot;,
4390 },
4391 },
4392 },
4393 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4394 # message that was returned, such as `NOT FOUND`.
4395 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4396 # status code that was returned. For example, a `404` means the
4397 # resource was not found.
4398 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4399 # defined by the server.
4400 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4401 # This value is inRFC3339
4402 # text format.
4403 &quot;instancesBulkInsertOperationMetadata&quot;: {
4404 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4405 # Example key: zones/us-central1-a
4406 &quot;a_key&quot;: {
4407 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4408 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4409 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4410 # error.
4411 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4412 # if the flow is rolling forward or rolling back.
4413 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4414 },
4415 },
4416 },
4417 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4418 # Operation resources.
4419 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4420 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4421 # group of operations results from a `bulkInsert` API request.
4422 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4423 # `update`, or `delete`, and so on.
4424 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4425 # There is no requirement that this be linear or support any granularity of
4426 # operations. This should not be used to guess when the operation will be
4427 # complete. This number should monotonically increase as the operation
4428 # progresses.
4429 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4430 # applicable when performing regional operations.
4431 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4432 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4433 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4434 # this field will contain information on all underlying zonal actions and
4435 # their state.
4436 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4437 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4438 # Example key: zones/us-central1-a
4439 &quot;a_key&quot;: {
4440 &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
4441 # populated.
4442 # different programming environments, including REST APIs and RPC APIs. It is
4443 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4444 # three pieces of data: error code, error message, and error details.
4445 #
4446 # You can find out more about this error model and how to work with it in the
4447 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4448 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4449 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4450 # message types for APIs to use.
4451 {
4452 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4453 },
4454 ],
4455 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4456 # user-facing error message should be localized and sent in the
4457 # google.rpc.Status.details field, or localized by the client.
4458 },
4459 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4460 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4461 },
4462 },
4463 },
4464 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4465 # This value is inRFC3339
4466 # text format.
4467 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4468 # following:
4469 # `PENDING`, `RUNNING`, or `DONE`.
4470 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4471 # operation.
4472 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4473 # of the target resource.
4474 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4475 # operations related to creating a snapshot, this points to the disk
4476 # that the snapshot was created from.
4477 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4478 # `[email protected]` or
4479 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4480 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4481 # operation, this field will be populated.
4482 {
4483 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4484 # Engine returns NO_RESULTS_ON_PAGE if there
4485 # are no results in the response.
4486 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4487 # value format. For example:
4488 #
4489 # &quot;data&quot;: [
4490 # {
4491 # &quot;key&quot;: &quot;scope&quot;,
4492 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4493 # }
4494 {
4495 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4496 # returned. For example, for warnings where there are no results in a list
4497 # request for a particular zone, this key might be scope and
4498 # the key value might be the zone name. Other examples might be a key
4499 # indicating a deprecated resource and a suggested replacement, or a
4500 # warning about invalid network settings (for example, if an instance
4501 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4502 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4503 },
4504 ],
4505 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4506 },
4507 ],
4508 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4509 # applicable when performing per-zone operations.
4510 }</pre>
4511 </div>
4512
4513 <div class="method">
4514 <code class="details" id="requestRemovePeering">requestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)</code>
4515 <pre>Requests to remove a peering from the specified network. Applicable only
4516 for PeeringConnection with update_strategy=CONSENSUS.
4517
4518 Args:
4519 project: string, Project ID for this request. (required)
4520 network: string, Name of the network resource to remove peering from. (required)
4521 body: object, The request body.
4522 The object takes the form of:
4523
4524 {
4525 &quot;name&quot;: &quot;A String&quot;, # Name of the peering, which should conform to RFC1035.
4526 }
4527
4528 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4529 that if you must retry your request, the server will know to ignore the
4530 request if it has already been completed.
4531
4532 For example, consider a situation where you make an initial request and
4533 the request times out. If you make the request again with the same
4534 request ID, the server can check if original operation with the same
4535 request ID was received, and if so, will ignore the second request. This
4536 prevents clients from accidentally creating duplicate commitments.
4537
4538 The request ID must be
4539 a valid UUID with the exception that zero UUID is not supported
4540 (00000000-0000-0000-0000-000000000000).
4541 x__xgafv: string, V1 error format.
4542 Allowed values
4543 1 - v1 error format
4544 2 - v2 error format
4545
4546 Returns:
4547 An object of the form:
4548
4549 { # Represents an Operation resource.
4550 #
4551 # Google Compute Engine has three Operation resources:
4552 #
4553 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4554 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4555 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4556 #
4557 # You can use an operation resource to manage asynchronous API requests.
4558 # For more information, readHandling
4559 # API responses.
4560 #
4561 # Operations can be global, regional or zonal.
4562 #
4563 # - For global operations, use the `globalOperations`
4564 # resource.
4565 # - For regional operations, use the
4566 # `regionOperations` resource.
4567 # - For zonal operations, use
4568 # the `zoneOperations` resource.
4569 #
4570 #
4571 #
4572 # For more information, read
4573 # Global, Regional, and Zonal Resources.
4574 #
4575 # Note that completed Operation resources have a limited
4576 # retention period.
4577 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4578 # Not present otherwise.
4579 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4580 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4581 # set when the operation is created.
4582 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4583 # text format.
4584 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4585 # this field will be populated.
4586 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4587 # operation.
4588 {
4589 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4590 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4591 # details. There is a set of defined message types to use for providing
4592 # details.The syntax depends on the error code. For example,
4593 # QuotaExceededInfo will have details when the error code is
4594 # QUOTA_EXCEEDED.
4595 {
4596 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4597 #
4598 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4599 # is not enabled:
4600 #
4601 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4602 # &quot;domain&quot;: &quot;googleapis.com&quot;
4603 # &quot;metadata&quot;: {
4604 # &quot;resource&quot;: &quot;projects/123&quot;,
4605 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4606 # }
4607 # }
4608 #
4609 # This response indicates that the pubsub.googleapis.com API is not enabled.
4610 #
4611 # Example of an error that is returned when attempting to create a Spanner
4612 # instance in a region that is out of stock:
4613 #
4614 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4615 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4616 # &quot;metadata&quot;: {
4617 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4618 # }
4619 # }
4620 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4621 # is typically the registered service name of the tool or product that
4622 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4623 # generated by some common infrastructure, the error domain must be a
4624 # globally unique value that identifies the infrastructure. For Google API
4625 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4626 &quot;metadatas&quot;: { # Additional structured details about this error.
4627 #
4628 # Keys must match a regular expression of `a-z+` but should
4629 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4630 # length. When identifying the current value of an exceeded limit, the units
4631 # should be contained in the key, not the value. For example, rather than
4632 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4633 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4634 # instances that can be created in a single (batch) request.
4635 &quot;a_key&quot;: &quot;A String&quot;,
4636 },
4637 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4638 # proximate cause of the error. Error reasons are unique within a particular
4639 # domain of errors. This should be at most 63 characters and match a
4640 # regular expression of `A-Z+[A-Z0-9]`, which represents
4641 # UPPER_SNAKE_CASE.
4642 },
4643 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4644 #
4645 # For example, if a quota check failed with an error indicating the calling
4646 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4647 # directly to the right place in the developer console to flip the bit.
4648 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4649 { # Describes a URL link.
4650 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4651 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4652 },
4653 ],
4654 },
4655 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4656 # which can be attached to an RPC error.
4657 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4658 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4659 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4660 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4661 },
4662 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4663 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4664 &quot;a_key&quot;: &quot;A String&quot;,
4665 },
4666 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4667 # type or metric.
4668 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4669 # or metric.
4670 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4671 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4672 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4673 },
4674 },
4675 ],
4676 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4677 # This property is optional.
4678 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4679 },
4680 ],
4681 },
4682 &quot;getVersionOperationMetadata&quot;: {
4683 &quot;inlineSbomInfo&quot;: {
4684 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4685 # appropriate identifiers.
4686 &quot;a_key&quot;: &quot;A String&quot;,
4687 },
4688 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4689 # identifiers.
4690 &quot;a_key&quot;: &quot;A String&quot;,
4691 },
4692 },
4693 },
4694 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4695 # message that was returned, such as `NOT FOUND`.
4696 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4697 # status code that was returned. For example, a `404` means the
4698 # resource was not found.
4699 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4700 # defined by the server.
4701 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4702 # This value is inRFC3339
4703 # text format.
4704 &quot;instancesBulkInsertOperationMetadata&quot;: {
4705 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4706 # Example key: zones/us-central1-a
4707 &quot;a_key&quot;: {
4708 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4709 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4710 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4711 # error.
4712 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4713 # if the flow is rolling forward or rolling back.
4714 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4715 },
4716 },
4717 },
4718 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4719 # Operation resources.
4720 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4721 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4722 # group of operations results from a `bulkInsert` API request.
4723 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4724 # `update`, or `delete`, and so on.
4725 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4726 # There is no requirement that this be linear or support any granularity of
4727 # operations. This should not be used to guess when the operation will be
4728 # complete. This number should monotonically increase as the operation
4729 # progresses.
4730 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4731 # applicable when performing regional operations.
4732 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4733 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4734 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4735 # this field will contain information on all underlying zonal actions and
4736 # their state.
4737 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4738 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4739 # Example key: zones/us-central1-a
4740 &quot;a_key&quot;: {
4741 &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
4742 # populated.
4743 # different programming environments, including REST APIs and RPC APIs. It is
4744 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4745 # three pieces of data: error code, error message, and error details.
4746 #
4747 # You can find out more about this error model and how to work with it in the
4748 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4749 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4750 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4751 # message types for APIs to use.
4752 {
4753 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4754 },
4755 ],
4756 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4757 # user-facing error message should be localized and sent in the
4758 # google.rpc.Status.details field, or localized by the client.
4759 },
4760 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4761 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4762 },
4763 },
4764 },
4765 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4766 # This value is inRFC3339
4767 # text format.
4768 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4769 # following:
4770 # `PENDING`, `RUNNING`, or `DONE`.
4771 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4772 # operation.
4773 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4774 # of the target resource.
4775 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4776 # operations related to creating a snapshot, this points to the disk
4777 # that the snapshot was created from.
4778 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4779 # `[email protected]` or
4780 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4781 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4782 # operation, this field will be populated.
4783 {
4784 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4785 # Engine returns NO_RESULTS_ON_PAGE if there
4786 # are no results in the response.
4787 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4788 # value format. For example:
4789 #
4790 # &quot;data&quot;: [
4791 # {
4792 # &quot;key&quot;: &quot;scope&quot;,
4793 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4794 # }
4795 {
4796 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4797 # returned. For example, for warnings where there are no results in a list
4798 # request for a particular zone, this key might be scope and
4799 # the key value might be the zone name. Other examples might be a key
4800 # indicating a deprecated resource and a suggested replacement, or a
4801 # warning about invalid network settings (for example, if an instance
4802 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4803 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4804 },
4805 ],
4806 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4807 },
4808 ],
4809 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4810 # applicable when performing per-zone operations.
4811 }</pre>
4812 </div>
4813
4814 <div class="method">
4815 <code class="details" id="switchToCustomMode">switchToCustomMode(project, network, requestId=None, x__xgafv=None)</code>
4816 <pre>Switches the network mode from auto subnet mode to custom subnet mode.
4817
4818 Args:
4819 project: string, Project ID for this request. (required)
4820 network: string, Name of the network to be updated. (required)
4821 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4822 that if you must retry your request, the server will know to ignore the
4823 request if it has already been completed.
4824
4825 For example, consider a situation where you make an initial request and
4826 the request times out. If you make the request again with the same
4827 request ID, the server can check if original operation with the same
4828 request ID was received, and if so, will ignore the second request. This
4829 prevents clients from accidentally creating duplicate commitments.
4830
4831 The request ID must be
4832 a valid UUID with the exception that zero UUID is not supported
4833 (00000000-0000-0000-0000-000000000000).
4834 x__xgafv: string, V1 error format.
4835 Allowed values
4836 1 - v1 error format
4837 2 - v2 error format
4838
4839 Returns:
4840 An object of the form:
4841
4842 { # Represents an Operation resource.
4843 #
4844 # Google Compute Engine has three Operation resources:
4845 #
4846 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4847 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4848 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4849 #
4850 # You can use an operation resource to manage asynchronous API requests.
4851 # For more information, readHandling
4852 # API responses.
4853 #
4854 # Operations can be global, regional or zonal.
4855 #
4856 # - For global operations, use the `globalOperations`
4857 # resource.
4858 # - For regional operations, use the
4859 # `regionOperations` resource.
4860 # - For zonal operations, use
4861 # the `zoneOperations` resource.
4862 #
4863 #
4864 #
4865 # For more information, read
4866 # Global, Regional, and Zonal Resources.
4867 #
4868 # Note that completed Operation resources have a limited
4869 # retention period.
4870 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4871 # Not present otherwise.
4872 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4873 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4874 # set when the operation is created.
4875 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4876 # text format.
4877 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4878 # this field will be populated.
4879 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4880 # operation.
4881 {
4882 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4883 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4884 # details. There is a set of defined message types to use for providing
4885 # details.The syntax depends on the error code. For example,
4886 # QuotaExceededInfo will have details when the error code is
4887 # QUOTA_EXCEEDED.
4888 {
4889 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4890 #
4891 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4892 # is not enabled:
4893 #
4894 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4895 # &quot;domain&quot;: &quot;googleapis.com&quot;
4896 # &quot;metadata&quot;: {
4897 # &quot;resource&quot;: &quot;projects/123&quot;,
4898 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4899 # }
4900 # }
4901 #
4902 # This response indicates that the pubsub.googleapis.com API is not enabled.
4903 #
4904 # Example of an error that is returned when attempting to create a Spanner
4905 # instance in a region that is out of stock:
4906 #
4907 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4908 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4909 # &quot;metadata&quot;: {
4910 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4911 # }
4912 # }
4913 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4914 # is typically the registered service name of the tool or product that
4915 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4916 # generated by some common infrastructure, the error domain must be a
4917 # globally unique value that identifies the infrastructure. For Google API
4918 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4919 &quot;metadatas&quot;: { # Additional structured details about this error.
4920 #
4921 # Keys must match a regular expression of `a-z+` but should
4922 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4923 # length. When identifying the current value of an exceeded limit, the units
4924 # should be contained in the key, not the value. For example, rather than
4925 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4926 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4927 # instances that can be created in a single (batch) request.
4928 &quot;a_key&quot;: &quot;A String&quot;,
4929 },
4930 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4931 # proximate cause of the error. Error reasons are unique within a particular
4932 # domain of errors. This should be at most 63 characters and match a
4933 # regular expression of `A-Z+[A-Z0-9]`, which represents
4934 # UPPER_SNAKE_CASE.
4935 },
4936 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4937 #
4938 # For example, if a quota check failed with an error indicating the calling
4939 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4940 # directly to the right place in the developer console to flip the bit.
4941 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4942 { # Describes a URL link.
4943 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4944 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4945 },
4946 ],
4947 },
4948 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4949 # which can be attached to an RPC error.
4950 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4951 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4952 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4953 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4954 },
4955 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4956 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4957 &quot;a_key&quot;: &quot;A String&quot;,
4958 },
4959 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4960 # type or metric.
4961 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4962 # or metric.
4963 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4964 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4965 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4966 },
4967 },
4968 ],
4969 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4970 # This property is optional.
4971 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4972 },
4973 ],
4974 },
4975 &quot;getVersionOperationMetadata&quot;: {
4976 &quot;inlineSbomInfo&quot;: {
4977 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4978 # appropriate identifiers.
4979 &quot;a_key&quot;: &quot;A String&quot;,
4980 },
4981 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4982 # identifiers.
4983 &quot;a_key&quot;: &quot;A String&quot;,
4984 },
4985 },
4986 },
4987 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4988 # message that was returned, such as `NOT FOUND`.
4989 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4990 # status code that was returned. For example, a `404` means the
4991 # resource was not found.
4992 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4993 # defined by the server.
4994 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4995 # This value is inRFC3339
4996 # text format.
4997 &quot;instancesBulkInsertOperationMetadata&quot;: {
4998 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4999 # Example key: zones/us-central1-a
5000 &quot;a_key&quot;: {
5001 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5002 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5003 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5004 # error.
5005 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5006 # if the flow is rolling forward or rolling back.
5007 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5008 },
5009 },
5010 },
5011 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5012 # Operation resources.
5013 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5014 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5015 # group of operations results from a `bulkInsert` API request.
5016 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5017 # `update`, or `delete`, and so on.
5018 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5019 # There is no requirement that this be linear or support any granularity of
5020 # operations. This should not be used to guess when the operation will be
5021 # complete. This number should monotonically increase as the operation
5022 # progresses.
5023 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5024 # applicable when performing regional operations.
5025 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5026 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5027 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5028 # this field will contain information on all underlying zonal actions and
5029 # their state.
5030 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5031 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5032 # Example key: zones/us-central1-a
5033 &quot;a_key&quot;: {
5034 &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
5035 # populated.
5036 # different programming environments, including REST APIs and RPC APIs. It is
5037 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5038 # three pieces of data: error code, error message, and error details.
5039 #
5040 # You can find out more about this error model and how to work with it in the
5041 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5042 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5043 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5044 # message types for APIs to use.
5045 {
5046 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5047 },
5048 ],
5049 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5050 # user-facing error message should be localized and sent in the
5051 # google.rpc.Status.details field, or localized by the client.
5052 },
5053 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5054 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5055 },
5056 },
5057 },
5058 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5059 # This value is inRFC3339
5060 # text format.
5061 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5062 # following:
5063 # `PENDING`, `RUNNING`, or `DONE`.
5064 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5065 # operation.
5066 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5067 # of the target resource.
5068 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5069 # operations related to creating a snapshot, this points to the disk
5070 # that the snapshot was created from.
5071 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5072 # `[email protected]` or
5073 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5074 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5075 # operation, this field will be populated.
5076 {
5077 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5078 # Engine returns NO_RESULTS_ON_PAGE if there
5079 # are no results in the response.
5080 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5081 # value format. For example:
5082 #
5083 # &quot;data&quot;: [
5084 # {
5085 # &quot;key&quot;: &quot;scope&quot;,
5086 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5087 # }
5088 {
5089 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5090 # returned. For example, for warnings where there are no results in a list
5091 # request for a particular zone, this key might be scope and
5092 # the key value might be the zone name. Other examples might be a key
5093 # indicating a deprecated resource and a suggested replacement, or a
5094 # warning about invalid network settings (for example, if an instance
5095 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5096 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5097 },
5098 ],
5099 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5100 },
5101 ],
5102 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5103 # applicable when performing per-zone operations.
5104 }</pre>
5105 </div>
5106
5107 <div class="method">
5108 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
5109 <pre>Returns permissions that a caller has on the specified resource.
5110
5111 Args:
5112 project: string, Project ID for this request. (required)
5113 resource: string, Name or id of the resource for this request. (required)
5114 body: object, The request body.
5115 The object takes the form of:
5116
5117 {
5118 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
5119 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
5120 &quot;A String&quot;,
5121 ],
5122 }
5123
5124 x__xgafv: string, V1 error format.
5125 Allowed values
5126 1 - v1 error format
5127 2 - v2 error format
5128
5129 Returns:
5130 An object of the form:
5131
5132 {
5133 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
5134 # allowed.
5135 &quot;A String&quot;,
5136 ],
5137 }</pre>
5138 </div>
5139
5140 <div class="method">
5141 <code class="details" id="updatePeering">updatePeering(project, network, body=None, requestId=None, x__xgafv=None)</code>
5142 <pre>Updates the specified network peering with the data included in the
5143 request. You can only modify the NetworkPeering.export_custom_routes field
5144 and the NetworkPeering.import_custom_routes field.
5145
5146 Args:
5147 project: string, Project ID for this request. (required)
5148 network: string, Name of the network resource which the updated peering is belonging to. (required)
5149 body: object, The request body.
5150 The object takes the form of:
5151
5152 {
5153 &quot;networkPeering&quot;: { # A network peering attached to a network resource. The message includes the
5154 # peering name, peer network, peering state, and a flag indicating whether
5155 # Google Compute Engine should automatically create routes for the peering.
5156 &quot;advertisePeerSubnetsViaRouters&quot;: True or False, # Whether Cloud Routers in this network can automatically advertise subnets
5157 # from the peer network.
5158 &quot;autoCreateRoutes&quot;: True or False, # This field will be deprecated soon. Use theexchange_subnet_routes field instead.
5159 # Indicates whether full mesh connectivity is created and managed
5160 # automatically between peered networks. Currently this field should always
5161 # be true since Google Compute Engine will automatically create and manage
5162 # subnetwork routes between two networks when peering state isACTIVE.
5163 &quot;connectionStatus&quot;: { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection
5164 # as a whole.
5165 # local peering. This field provides information about the effective settings
5166 # for the connection as a whole, including pending delete/update requests for
5167 # CONSENSUS peerings.
5168 &quot;consensusState&quot;: { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update
5169 # and delete for a consensus peering connection.
5170 # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the
5171 # strategy to CONSENSUS.
5172 &quot;deleteStatus&quot;: &quot;A String&quot;, # The status of the delete request.
5173 &quot;updateStatus&quot;: &quot;A String&quot;, # The status of the update request.
5174 },
5175 &quot;trafficConfiguration&quot;: { # The active connectivity settings for the peering connection based on the
5176 # settings of the network peerings.
5177 &quot;exportCustomRoutesToPeer&quot;: True or False, # Whether custom routes are being exported to the peer network.
5178 &quot;exportSubnetRoutesWithPublicIpToPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being exported to the
5179 # peer network.
5180 &quot;importCustomRoutesFromPeer&quot;: True or False, # Whether custom routes are being imported from the peer network.
5181 &quot;importSubnetRoutesWithPublicIpFromPeer&quot;: True or False, # Whether subnet routes with public IP ranges are being imported
5182 # from the peer network.
5183 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are being imported or
5184 # exported between peer networks.
5185 },
5186 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the update/delete semantics for this
5187 # peering connection.
5188 },
5189 &quot;exchangeSubnetRoutes&quot;: True or False, # Indicates whether full mesh connectivity is created and managed
5190 # automatically between peered networks. Currently this field should always
5191 # be true since Google Compute Engine will automatically create and manage
5192 # subnetwork routes between two networks when peering state isACTIVE.
5193 &quot;exportCustomRoutes&quot;: True or False, # Whether to export the custom routes to peer network. The default value is
5194 # false.
5195 &quot;exportSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are exported. The default value
5196 # is true, all subnet routes are exported.IPv4
5197 # special-use ranges are always
5198 # exported to peers and are not controlled by this field.
5199 &quot;importCustomRoutes&quot;: True or False, # Whether to import the custom routes from peer network. The default value is
5200 # false.
5201 &quot;importSubnetRoutesWithPublicIp&quot;: True or False, # Whether subnet routes with public IP range are imported. The default value
5202 # is false.IPv4
5203 # special-use ranges are always
5204 # imported from peers and are not controlled by this field.
5205 &quot;name&quot;: &quot;A String&quot;, # Name of this peering. Provided by the client when the peering is created.
5206 # The name must comply withRFC1035.
5207 # Specifically, the name must be 1-63 characters long and match regular
5208 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
5209 # lowercase letter, and all the following characters must be a dash,
5210 # lowercase letter, or digit, except the last character, which cannot be a
5211 # dash.
5212 &quot;network&quot;: &quot;A String&quot;, # The URL of the peer network. It can be either full URL or partial URL. The
5213 # peer network may belong to a different project. If the partial URL does not
5214 # contain project, it is assumed that the peer network is in the same project
5215 # as the current network.
5216 &quot;peerMtu&quot;: 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network.
5217 &quot;stackType&quot;: &quot;A String&quot;, # Which IP version(s) of traffic and routes are allowed to be imported or
5218 # exported between peer networks. The default value is IPV4_ONLY.
5219 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State for the peering.
5220 &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. [Output Only] Details about the current state of the peering.
5221 &quot;updateStrategy&quot;: &quot;A String&quot;, # The update strategy determines the semantics for updates and deletes to the
5222 # peering connection configuration.
5223 },
5224 }
5225
5226 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5227 that if you must retry your request, the server will know to ignore the
5228 request if it has already been completed.
5229
5230 For example, consider a situation where you make an initial request and
5231 the request times out. If you make the request again with the same
5232 request ID, the server can check if original operation with the same
5233 request ID was received, and if so, will ignore the second request. This
5234 prevents clients from accidentally creating duplicate commitments.
5235
5236 The request ID must be
5237 a valid UUID with the exception that zero UUID is not supported
5238 (00000000-0000-0000-0000-000000000000).
5239 x__xgafv: string, V1 error format.
5240 Allowed values
5241 1 - v1 error format
5242 2 - v2 error format
5243
5244 Returns:
5245 An object of the form:
5246
5247 { # Represents an Operation resource.
5248 #
5249 # Google Compute Engine has three Operation resources:
5250 #
5251 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
5252 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
5253 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
5254 #
5255 # You can use an operation resource to manage asynchronous API requests.
5256 # For more information, readHandling
5257 # API responses.
5258 #
5259 # Operations can be global, regional or zonal.
5260 #
5261 # - For global operations, use the `globalOperations`
5262 # resource.
5263 # - For regional operations, use the
5264 # `regionOperations` resource.
5265 # - For zonal operations, use
5266 # the `zoneOperations` resource.
5267 #
5268 #
5269 #
5270 # For more information, read
5271 # Global, Regional, and Zonal Resources.
5272 #
5273 # Note that completed Operation resources have a limited
5274 # retention period.
5275 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5276 # Not present otherwise.
5277 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5278 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5279 # set when the operation is created.
5280 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5281 # text format.
5282 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5283 # this field will be populated.
5284 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5285 # operation.
5286 {
5287 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5288 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5289 # details. There is a set of defined message types to use for providing
5290 # details.The syntax depends on the error code. For example,
5291 # QuotaExceededInfo will have details when the error code is
5292 # QUOTA_EXCEEDED.
5293 {
5294 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5295 #
5296 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5297 # is not enabled:
5298 #
5299 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5300 # &quot;domain&quot;: &quot;googleapis.com&quot;
5301 # &quot;metadata&quot;: {
5302 # &quot;resource&quot;: &quot;projects/123&quot;,
5303 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5304 # }
5305 # }
5306 #
5307 # This response indicates that the pubsub.googleapis.com API is not enabled.
5308 #
5309 # Example of an error that is returned when attempting to create a Spanner
5310 # instance in a region that is out of stock:
5311 #
5312 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5313 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5314 # &quot;metadata&quot;: {
5315 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5316 # }
5317 # }
5318 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5319 # is typically the registered service name of the tool or product that
5320 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5321 # generated by some common infrastructure, the error domain must be a
5322 # globally unique value that identifies the infrastructure. For Google API
5323 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5324 &quot;metadatas&quot;: { # Additional structured details about this error.
5325 #
5326 # Keys must match a regular expression of `a-z+` but should
5327 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5328 # length. When identifying the current value of an exceeded limit, the units
5329 # should be contained in the key, not the value. For example, rather than
5330 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5331 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5332 # instances that can be created in a single (batch) request.
5333 &quot;a_key&quot;: &quot;A String&quot;,
5334 },
5335 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5336 # proximate cause of the error. Error reasons are unique within a particular
5337 # domain of errors. This should be at most 63 characters and match a
5338 # regular expression of `A-Z+[A-Z0-9]`, which represents
5339 # UPPER_SNAKE_CASE.
5340 },
5341 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5342 #
5343 # For example, if a quota check failed with an error indicating the calling
5344 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5345 # directly to the right place in the developer console to flip the bit.
5346 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5347 { # Describes a URL link.
5348 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5349 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5350 },
5351 ],
5352 },
5353 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5354 # which can be attached to an RPC error.
5355 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5356 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5357 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5358 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5359 },
5360 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5361 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5362 &quot;a_key&quot;: &quot;A String&quot;,
5363 },
5364 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5365 # type or metric.
5366 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5367 # or metric.
5368 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5369 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5370 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5371 },
5372 },
5373 ],
5374 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5375 # This property is optional.
5376 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5377 },
5378 ],
5379 },
5380 &quot;getVersionOperationMetadata&quot;: {
5381 &quot;inlineSbomInfo&quot;: {
5382 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5383 # appropriate identifiers.
5384 &quot;a_key&quot;: &quot;A String&quot;,
5385 },
5386 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5387 # identifiers.
5388 &quot;a_key&quot;: &quot;A String&quot;,
5389 },
5390 },
5391 },
5392 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5393 # message that was returned, such as `NOT FOUND`.
5394 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5395 # status code that was returned. For example, a `404` means the
5396 # resource was not found.
5397 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5398 # defined by the server.
5399 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5400 # This value is inRFC3339
5401 # text format.
5402 &quot;instancesBulkInsertOperationMetadata&quot;: {
5403 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5404 # Example key: zones/us-central1-a
5405 &quot;a_key&quot;: {
5406 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5407 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5408 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5409 # error.
5410 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5411 # if the flow is rolling forward or rolling back.
5412 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5413 },
5414 },
5415 },
5416 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5417 # Operation resources.
5418 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5419 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5420 # group of operations results from a `bulkInsert` API request.
5421 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5422 # `update`, or `delete`, and so on.
5423 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5424 # There is no requirement that this be linear or support any granularity of
5425 # operations. This should not be used to guess when the operation will be
5426 # complete. This number should monotonically increase as the operation
5427 # progresses.
5428 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5429 # applicable when performing regional operations.
5430 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5431 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5432 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5433 # this field will contain information on all underlying zonal actions and
5434 # their state.
5435 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5436 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5437 # Example key: zones/us-central1-a
5438 &quot;a_key&quot;: {
5439 &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
5440 # populated.
5441 # different programming environments, including REST APIs and RPC APIs. It is
5442 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5443 # three pieces of data: error code, error message, and error details.
5444 #
5445 # You can find out more about this error model and how to work with it in the
5446 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5447 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5448 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5449 # message types for APIs to use.
5450 {
5451 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5452 },
5453 ],
5454 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5455 # user-facing error message should be localized and sent in the
5456 # google.rpc.Status.details field, or localized by the client.
5457 },
5458 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5459 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5460 },
5461 },
5462 },
5463 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5464 # This value is inRFC3339
5465 # text format.
5466 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5467 # following:
5468 # `PENDING`, `RUNNING`, or `DONE`.
5469 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5470 # operation.
5471 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5472 # of the target resource.
5473 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5474 # operations related to creating a snapshot, this points to the disk
5475 # that the snapshot was created from.
5476 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5477 # `[email protected]` or
5478 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5479 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5480 # operation, this field will be populated.
5481 {
5482 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5483 # Engine returns NO_RESULTS_ON_PAGE if there
5484 # are no results in the response.
5485 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5486 # value format. For example:
5487 #
5488 # &quot;data&quot;: [
5489 # {
5490 # &quot;key&quot;: &quot;scope&quot;,
5491 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5492 # }
5493 {
5494 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5495 # returned. For example, for warnings where there are no results in a list
5496 # request for a particular zone, this key might be scope and
5497 # the key value might be the zone name. Other examples might be a key
5498 # indicating a deprecated resource and a suggested replacement, or a
5499 # warning about invalid network settings (for example, if an instance
5500 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5501 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5502 },
5503 ],
5504 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5505 },
5506 ],
5507 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5508 # applicable when performing per-zone operations.
5509 }</pre>
5510 </div>
5511
5512 </body></html>