Debian Codegraph @

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