Debian Codegraph @

docs/dyn/compute_alpha.routers.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.routers.html">routers</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves an aggregated list of routers.</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</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, region, router, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified Router resource.</p>
89 <p class="toc_element">
90 <code><a href="#deleteNamedSet">deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes Named Set</p>
92 <p class="toc_element">
93 <code><a href="#deleteRoutePolicy">deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Deletes Route Policy</p>
95 <p class="toc_element">
96 <code><a href="#get">get(project, region, router, x__xgafv=None)</a></code></p>
97 <p class="firstline">Returns the specified Router resource.</p>
98 <p class="toc_element">
99 <code><a href="#getNamedSet">getNamedSet(project, region, router, namedSet=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Returns specified Named Set</p>
101 <p class="toc_element">
102 <code><a href="#getNatIpInfo">getNatIpInfo(project, region, router, natName=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Retrieves runtime NAT IP information.</p>
104 <p class="toc_element">
105 <code><a href="#getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, natName=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Retrieves runtime Nat mapping information of VM endpoints.</p>
107 <p class="toc_element">
108 <code><a href="#getNatMappingInfo_next">getNatMappingInfo_next()</a></code></p>
109 <p class="firstline">Retrieves the next page of results.</p>
110 <p class="toc_element">
111 <code><a href="#getRoutePolicy">getRoutePolicy(project, region, router, policy=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Returns specified Route Policy</p>
113 <p class="toc_element">
114 <code><a href="#getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</a></code></p>
115 <p class="firstline">Retrieves runtime information of the specified router.</p>
116 <p class="toc_element">
117 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Creates a Router resource in the specified project and region using</p>
119 <p class="toc_element">
120 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Retrieves a list of Router resources available to the specified project.</p>
122 <p class="toc_element">
123 <code><a href="#listBgpRoutes">listBgpRoutes(project, region, router, addressFamily=None, destinationPrefix=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peer=None, policyApplied=None, returnPartialSuccess=None, routeType=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Retrieves a list of router bgp routes available to the specified project.</p>
125 <p class="toc_element">
126 <code><a href="#listBgpRoutes_next">listBgpRoutes_next()</a></code></p>
127 <p class="firstline">Retrieves the next page of results.</p>
128 <p class="toc_element">
129 <code><a href="#listNamedSets">listNamedSets(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Retrieves a list of router named set subresources available to the</p>
131 <p class="toc_element">
132 <code><a href="#listNamedSets_next">listNamedSets_next()</a></code></p>
133 <p class="firstline">Retrieves the next page of results.</p>
134 <p class="toc_element">
135 <code><a href="#listRoutePolicies">listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Retrieves a list of router route policy subresources available to the</p>
137 <p class="toc_element">
138 <code><a href="#listRoutePolicies_next">listRoutePolicies_next()</a></code></p>
139 <p class="firstline">Retrieves the next page of results.</p>
140 <p class="toc_element">
141 <code><a href="#list_next">list_next()</a></code></p>
142 <p class="firstline">Retrieves the next page of results.</p>
143 <p class="toc_element">
144 <code><a href="#patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Patches the specified Router resource with the data included in the</p>
146 <p class="toc_element">
147 <code><a href="#patchNamedSet">patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
148 <p class="firstline">Patches Named Set</p>
149 <p class="toc_element">
150 <code><a href="#patchRoutePolicy">patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
151 <p class="firstline">Patches Route Policy</p>
152 <p class="toc_element">
153 <code><a href="#preview">preview(project, region, router, body=None, x__xgafv=None)</a></code></p>
154 <p class="firstline">Preview fields auto-generated during router create andupdate operations.</p>
155 <p class="toc_element">
156 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
157 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
158 <p class="toc_element">
159 <code><a href="#update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
160 <p class="firstline">Updates the specified Router resource with the data included in the</p>
161 <p class="toc_element">
162 <code><a href="#updateNamedSet">updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
163 <p class="firstline">Updates or creates new Named Set</p>
164 <p class="toc_element">
165 <code><a href="#updateRoutePolicy">updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
166 <p class="firstline">Updates or creates new Route Policy</p>
167 <h3>Method Details</h3>
168 <div class="method">
169 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
170 <pre>Retrieves an aggregated list of routers.
171
172 To prevent failure, Google recommends that you set the
173 `returnPartialSuccess` parameter to `true`.
174
175 Args:
176 project: string, Project ID for this request. (required)
177 filter: string, A filter expression that filters resources listed in the response. Most
178 Compute resources support two types of filter expressions:
179 expressions that support regular expressions and expressions that follow
180 API improvement proposal AIP-160.
181 These two types of filter expressions cannot be mixed in one request.
182
183 If you want to use AIP-160, your expression must specify the field name, an
184 operator, and the value that you want to use for filtering. The value
185 must be a string, a number, or a boolean. The operator
186 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
187
188 For example, if you are filtering Compute Engine instances, you can
189 exclude instances named `example-instance` by specifying
190 `name != example-instance`.
191
192 The `:*` comparison can be used to test whether a key has been defined.
193 For example, to find all objects with `owner` label use:
194 ```
195 labels.owner:*
196 ```
197
198 You can also filter nested fields. For example, you could specify
199 `scheduling.automaticRestart = false` to include instances only
200 if they are not scheduled for automatic restarts. You can use filtering
201 on nested fields to filter based onresource labels.
202
203 To filter on multiple expressions, provide each separate expression within
204 parentheses. For example:
205 ```
206 (scheduling.automaticRestart = true)
207 (cpuPlatform = &quot;Intel Skylake&quot;)
208 ```
209 By default, each expression is an `AND` expression. However, you
210 can include `AND` and `OR` expressions explicitly.
211 For example:
212 ```
213 (cpuPlatform = &quot;Intel Skylake&quot;) OR
214 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
215 (scheduling.automaticRestart = true)
216 ```
217
218 If you want to use a regular expression, use the `eq` (equal) or `ne`
219 (not equal) operator against a single un-parenthesized expression with or
220 without quotes or against multiple parenthesized expressions. Examples:
221
222 `fieldname eq unquoted literal`
223 `fieldname eq &#x27;single quoted literal&#x27;`
224 `fieldname eq &quot;double quoted literal&quot;`
225 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
226
227 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
228 The literal value must match the entire field.
229
230 For example, to filter for instances that do not end with name &quot;instance&quot;,
231 you would use `name ne .*instance`.
232
233 You cannot combine constraints on multiple fields using regular
234 expressions.
235 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
236 global) should be included in the response. For new resource types added
237 after this field, the flag has no effect as new resource types will always
238 include every visible scope for each scope type in response. For resource
239 types which predate this field, if this flag is omitted or false, only
240 scopes of the scope types where the resource type is expected to be found
241 will be included.
242 maxResults: integer, The maximum number of results per page that should be returned.
243 If the number of available results is larger than `maxResults`,
244 Compute Engine returns a `nextPageToken` that can be used to get
245 the next page of results in subsequent list requests. Acceptable values are
246 `0` to `500`, inclusive. (Default: `500`)
247 orderBy: string, Sorts list results by a certain order. By default, results
248 are returned in alphanumerical order based on the resource name.
249
250 You can also sort results in descending order based on the creation
251 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
252 results based on the `creationTimestamp` field in
253 reverse chronological order (newest result first). Use this to sort
254 resources like operations so that the newest operation is returned first.
255
256 Currently, only sorting by `name` or
257 `creationTimestamp desc` is supported.
258 pageToken: string, Specifies a page token to use. Set `pageToken` to the
259 `nextPageToken` returned by a previous list request to get
260 the next page of results.
261 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
262 of failure. The default value is false.
263
264 For example, when partial success behavior is enabled, aggregatedList for a
265 single zone scope either returns all resources in the zone or no resources,
266 with an error code.
267 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
268 aggregated list request is invoked for subnetworks list-usable api.
269 x__xgafv: string, V1 error format.
270 Allowed values
271 1 - v1 error format
272 2 - v2 error format
273
274 Returns:
275 An object of the form:
276
277 { # Contains a list of routers.
278 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
279 &quot;items&quot;: { # A list of Router resources.
280 &quot;a_key&quot;: { # Name of the scope containing this set of routers.
281 &quot;routers&quot;: [ # A list of routers contained in this scope.
282 { # Represents a Cloud Router resource.
283 #
284 # For more information about Cloud Router, read theCloud
285 # Router overview.
286 &quot;bgp&quot;: { # BGP information specific to this router.
287 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
288 # The options are DEFAULT or CUSTOM.
289 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
290 # This field can only be populated if advertise_mode is CUSTOM and
291 # is advertised to all peers of the router.
292 # These groups will be advertised in addition to any specified prefixes.
293 # Leave this field blank to advertise no custom groups.
294 &quot;A String&quot;,
295 ],
296 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
297 # This field can only be populated if advertise_mode is CUSTOM and
298 # is advertised to all peers of the router.
299 # These IP ranges will be advertised in addition to any specified groups.
300 # Leave this field blank to advertise no custom IP ranges.
301 { # Description-tagged IP ranges for the router to advertise.
302 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
303 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
304 },
305 ],
306 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
307 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
308 # value will be fixed for this router resource. All VPN tunnels that link
309 # to this router will have the same local ASN.
310 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
311 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
312 # least /30, even if the BGP sessions are over IPv6. It must not overlap
313 # with any IPv4 BGP session ranges.
314 #
315 #
316 # Other vendors commonly call this &quot;router ID&quot;.
317 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
318 # sent to the peer.
319 #
320 #
321 # Hold time is three times the interval at which keepalive messages are
322 # sent, and the hold time is the maximum number of seconds allowed to
323 # elapse between successive keepalive messages that BGP receives from a
324 # peer.
325 #
326 #
327 # BGP will use the smaller of either the local hold time value or the
328 # peer&#x27;s hold time value as the hold time for the BGP connection between
329 # the two peers.
330 #
331 #
332 # If set, this value must be between 20 and 60. The default is 20.
333 },
334 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
335 # establish BGP peering. This information must specify the peer ASN and
336 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
337 {
338 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
339 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
340 # which currently supports the following option:
341 #
342 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
343 # excludes any routes learned for subnets that use
344 # VPC Network Peering.
345 #
346 #
347 # Note that this field can only be populated if advertise_mode is CUSTOM
348 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
349 # These groups are advertised in addition to any specified prefixes.
350 # Leave this field blank to advertise no custom groups.
351 &quot;A String&quot;,
352 ],
353 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
354 # This field can only be populated if advertise_mode is CUSTOM and
355 # overrides the list defined for the router (in the &quot;bgp&quot; message).
356 # These IP ranges are advertised in addition to any specified groups.
357 # Leave this field blank to advertise no custom IP ranges.
358 { # Description-tagged IP ranges for the router to advertise.
359 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
360 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
361 },
362 ],
363 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
364 # than one matching route of maximum length, the routes with the lowest
365 # priority value win.
366 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
367 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
368 # received from the peer router. The actual value is negotiated between
369 # the two routers and is equal to the greater of this value and the
370 # transmit interval of the other router.
371 #
372 #
373 # If set, this value must be between 1000 and 30000.
374 #
375 #
376 # The default is 1000.
377 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
378 # transmitted to the peer router. The actual value is negotiated between
379 # the two routers and is equal to the greater of this value and the
380 # corresponding receive interval of the other router.
381 #
382 #
383 # If set, this value must be between 1000 and 30000.
384 #
385 #
386 # The default is 1000.
387 &quot;mode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
388 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
389 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
390 # peer router to initiate the BFD session for this BGP peer. If set to
391 # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.
392 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
393 # before BFD declares that a peer is unavailable.
394 #
395 #
396 # If set, the value must be a value between 5 and 16.
397 #
398 #
399 # The default is 5.
400 &quot;packetMode&quot;: &quot;A String&quot;, # The BFD packet mode for this BGP peer.
401 # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer.
402 # In this mode, if the peer router also has BFD echo mode enabled, BFD
403 # echo packets will be sent to the other router. If the peer router does
404 # not have BFD echo mode enabled, only control packets will be sent. If
405 # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If
406 # this router and the peer router have a multihop connection, this should
407 # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop
408 # connections. The default is CONTROL_AND_ECHO.
409 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
410 #
411 #
412 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
413 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
414 # peer router to initiate the BFD session for this BGP peer. If set to
415 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
416 &quot;slowTimerInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
417 # transmitted to and received from the peer router when BFD echo mode is
418 # enabled on both routers. The actual transmit and receive intervals are
419 # negotiated between the two routers and are equal to the greater of this
420 # value and the corresponding interval on the other router.
421 # If set, this value must be between 1000 and 30000.
422 # The default is 5000.
423 },
424 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
425 # session.
426 {
427 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
428 # CIDR-formatted prefix. If an IP address is provided without a subnet
429 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
430 # range, and, for IPv6, `/128`.
431 },
432 ],
433 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
434 # value is applied to all custom learned route ranges for the session.
435 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
436 # value, Google Cloud assigns a priority of `100` to the ranges.
437 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
438 #
439 #
440 # If set to FALSE, any active session with the peer is terminated and
441 # all associated routing information is removed. If set to TRUE, the
442 # peer connection can be established with routing information. The default
443 # is TRUE.
444 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
445 # the peerIpAddress is version 4.
446 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
447 # peerIpAddress is version 6.
448 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
449 # evaluated. The name must correspond to an existing policy that has
450 # ROUTE_POLICY_TYPE_EXPORT type.
451 &quot;A String&quot;,
452 ],
453 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
454 # evaluated. The name must correspond to an existing policy that has
455 # ROUTE_POLICY_TYPE_IMPORT type.
456 &quot;A String&quot;,
457 ],
458 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
459 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
460 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
461 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
462 &quot;linkedCustomHardware&quot;: &quot;A String&quot;, # The linked custom hardware resource.
463 # The URI of the custom hardware link attachment
464 # is where you will establish the BGP session from the Cloud Router.
465 # This link attachment must reside in the same subnetwork as the associated
466 # router interface.
467 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
468 #
469 # - MANAGED_BY_USER is the default value and can be managed by you
470 # or other users
471 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
472 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
473 # PARTNER. Google automatically creates, updates, and deletes this type of
474 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
475 # or deleted.
476 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
477 # name of one of the entries in the Router.md5_authentication_keys. The
478 # field must comply with RFC1035.
479 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
480 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
481 # characters long and match the regular expression
482 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
483 # lowercase letter, and all following characters must be a dash, lowercase
484 # letter, or digit, except the last character, which cannot be a dash.
485 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
486 # a different value.
487 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
488 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
489 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
490 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
491 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
492 # Appliances. The VM instance must be located in zones contained in the
493 # same region as this Cloud Router.
494 # The VM instance is the peer side of the BGP session.
495 },
496 ],
497 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
498 # text format.
499 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
500 # create the resource.
501 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
502 # attachments (interconnectAttachments).
503 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
504 # defined by the server.
505 &quot;interfaces&quot;: [ # Router interfaces.
506 # To create a BGP peer that uses a router interface,
507 # the interface must have one of the following fields specified:
508 #
509 # - linkedVpnTunnel
510 # - linkedInterconnectAttachment
511 # - subnetwork
512 #
513 #
514 # You can create a router interface without any of these fields specified.
515 # However, you cannot create a BGP peer that uses that interface.
516 {
517 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
518 #
519 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
520 # be a CIDR-formatted string, for example, 169.254.0.1/30.
521 # Note: Do not truncate the IP address, as it represents the IP address of
522 # the interface.
523 # - For Internet Protocol version 6 (IPv6), the value
524 # must be a unique local address (ULA) range from fdff:1::/64
525 # with a mask length of 126 or less. This value should be a CIDR-formatted
526 # string, for example, fdff:1::1/112. Within the router&#x27;s
527 # VPC, this IPv6 prefix will be reserved exclusively for this connection
528 # and cannot be used for any other purpose.
529 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
530 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
531 # as the router. Each interface can have one linked resource, which can be
532 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
533 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
534 # router. Each interface can have one linked resource, which can be
535 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
536 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
537 #
538 # - MANAGED_BY_USER is the default value and can be managed directly
539 # by users.
540 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
541 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
542 # of type PARTNER. Google automatically creates, updates, and deletes
543 # this type of interface when the PARTNER InterconnectAttachment is
544 # created, updated, or deleted.
545 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
546 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
547 # characters long and match the regular expression
548 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
549 # lowercase letter, and all following characters must be a dash, lowercase
550 # letter, or digit, except the last character, which cannot be a dash.
551 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
552 # BGP sessions to a VM instance acting as a third-party
553 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
554 # an SD-WAN VM.
555 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
556 # you are creating. The redundantInterface must belong to the same Cloud
557 # Router as the interface here. To establish the BGP session to a Router
558 # Appliance VM, you must create two BGP peers. The two BGP peers must be
559 # attached to two separate interfaces that are redundant with each other.
560 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
561 # be 1-63 characters long and match the regular expression
562 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
563 # lowercase letter, and all following characters must be a dash, lowercase
564 # letter, or digit, except the last character, which cannot be a dash.
565 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
566 # must be in the same region as the Cloud Router.
567 # When you establish a BGP session to a VM instance using this interface,
568 # the VM instance must belong to the same subnetwork as the subnetwork
569 # specified here.
570 },
571 ],
572 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
573 # routers.
574 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
575 {
576 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
577 #
578 # For patch and update calls, it can be skipped to
579 # copy the value from the previous configuration. This is allowed if the
580 # key with the same name existed before the operation. Maximum length is 80
581 # characters. Can only contain printable ASCII characters.
582 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
583 #
584 # Must be unique within a router. Must be referenced by exactly
585 # one bgpPeer. Must comply withRFC1035.
586 },
587 ],
588 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
589 # The name must be 1-63 characters long, and comply withRFC1035.
590 # Specifically, the name must be 1-63 characters long and match the regular
591 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
592 # character must be a lowercase letter, and all following characters must
593 # be a dash, lowercase letter, or digit, except the last character, which
594 # cannot be a dash.
595 &quot;nats&quot;: [ # A list of NAT services created in this router.
596 { # Represents a Nat resource. It enables the VMs within the specified
597 # subnetworks to access Internet without external IP addresses. It specifies
598 # a list of subnetworks (and the ranges within) that want to use NAT.
599 # Customers can also provide the external IPs that would be used for NAT. GCP
600 # would auto-allocate ephemeral IPs if no external IPs are provided.
601 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
602 # Must be one of: PREMIUM, STANDARD.
603 # If not specified, then the current
604 # project-level default tier is used.
605 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
606 # must be valid static external IPs that have been assigned to the NAT.
607 # These IPs should be used for updating/patching a NAT only.
608 &quot;A String&quot;,
609 ],
610 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
611 # state. This value is equal to tcp_time_wait_timeout_sec.
612 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
613 # 120s. The field is output only.
614 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
615 #
616 #
617 # If not specified, it is disabled by default.
618 #
619 #
620 # If set to true,
621 #
622 # - Dynamic Port Allocation will be enabled on this NAT
623 # config.
624 # - enableEndpointIndependentMapping cannot be set to true.
625 # - If minPorts is set, minPortsPerVm must be set to a
626 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
627 # minimum of 32 ports will be allocated to a VM from this NAT
628 # config.
629 &quot;enableEndpointIndependentMapping&quot;: True or False,
630 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
631 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
632 &quot;A String&quot;,
633 ],
634 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
635 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
636 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
637 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
638 # logs are exported for all connections handled by this NAT.
639 # This option can take one of the following values:
640 #
641 # - ERRORS_ONLY: Export logs only for connection failures.
642 # - TRANSLATIONS_ONLY: Export logs only for successful
643 # connections.
644 # - ALL: Export logs for all connections, successful and
645 # unsuccessful.
646 },
647 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
648 # Dynamic Port Allocation is enabled.
649 #
650 #
651 # If Dynamic Port Allocation is not enabled, this field has no effect.
652 #
653 #
654 # If Dynamic Port Allocation is enabled, and this field is set, it must be
655 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
656 # is not set.
657 #
658 #
659 # If Dynamic Port Allocation is enabled and this field is not set,
660 # a maximum of 65536 ports will be allocated to a VM from this NAT
661 # config.
662 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
663 # set, a default number of ports is allocated to a VM. This is rounded
664 # up to the nearest power of 2. For example, if the value of this field is
665 # 50, at least 64 ports are allocated to a VM.
666 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
667 # The name must be 1-63 characters long and comply withRFC1035.
668 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
669 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
670 # selected for the SubnetworkIpRangeToNat64Option above.
671 { # Specifies a subnetwork to enable NAT64.
672 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
673 },
674 ],
675 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
676 # values:
677 #
678 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
679 # customers. When there are not enough specified Nat IPs, the Nat service
680 # fails for new VMs.
681 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
682 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
683 # be empty.
684 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
685 # addresses must be valid static external IP addresses assigned to the
686 # project.
687 &quot;A String&quot;,
688 ],
689 &quot;rules&quot;: [ # A list of rules associated with this NAT.
690 {
691 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
692 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
693 # addresses must be valid static external IP addresses assigned to the
694 # project.
695 # This field is used for public NAT.
696 &quot;A String&quot;,
697 ],
698 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
699 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
700 # This field is used for private NAT.
701 &quot;A String&quot;,
702 ],
703 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
704 # must be valid static external IPs that have been assigned to the NAT.
705 # These IPs should be used for updating/patching a NAT rule only.
706 # This field is used for public NAT.
707 &quot;A String&quot;,
708 ],
709 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
710 # drained. This is only supported on patch/update, and these
711 # subnetworks must have previously been used as active ranges in this
712 # NAT Rule.
713 # This field is used for private NAT.
714 &quot;A String&quot;,
715 ],
716 },
717 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
718 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
719 # from a VM is evaluated against. If it evaluates to true, the
720 # corresponding `action` is enforced.
721 #
722 # The following examples are valid match expressions for public NAT:
723 #
724 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
725 # &#x27;2.2.0.0/16&#x27;)`
726 #
727 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
728 #
729 # The following example is a valid match expression for private NAT:
730 #
731 # `nexthop.hub ==
732 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
733 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
734 # must be a positive value between 0 and 65000, and
735 # must be unique among rules within a NAT.
736 &quot;sourceWorkloadIdentities&quot;: [ # A list of source workload identities.
737 &quot;A String&quot;,
738 ],
739 },
740 ],
741 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
742 #
743 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
744 # Subnetwork are allowed to Nat.
745 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
746 # in every Subnetwork are allowed to Nat.
747 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
748 # (specified in the field subnetwork below)
749 #
750 #
751 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
752 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
753 # should not be any other Router.Nat section in any Router for this network
754 # in this region.
755 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
756 # values:
757 #
758 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
759 # every Subnetwork are allowed to Nat.
760 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
761 # (specified in the field nat64_subnetwork below)
762 #
763 #
764 # The default is NAT64_OPTION_UNSPECIFIED.
765 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
766 # Router.Nat section in this region can also enable NAT64 for any
767 # Subnetworks in this network. Other Router.Nat sections can still be
768 # present to enable NAT44 only.
769 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
770 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
771 # SubnetworkIpRangeToNatOption above.
772 { # Defines the IP ranges that want to use NAT for a subnetwork.
773 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
774 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
775 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
776 # is one of the values in source_ip_ranges_to_nat.
777 &quot;A String&quot;,
778 ],
779 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
780 # options of a single value are valid except
781 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
782 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
783 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
784 # Default: [ALL_IP_RANGES]
785 &quot;A String&quot;,
786 ],
787 },
788 ],
789 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
790 # if not set.
791 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
792 # Defaults to 120s if not set.
793 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
794 # not set.
795 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
796 # translation. If unspecified, it defaults to PUBLIC.
797 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
798 },
799 ],
800 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
801 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
802 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
803 # as part of resource payload.
804 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
805 # The field is allowed for INSERT
806 # only. The keys/values to set on the resource should be specified in
807 # either ID { : } or Namespaced format
808 # { : }.
809 # For example the following are valid inputs:
810 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
811 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
812 # Note:
813 # * Invalid combinations of ID &amp; namespaced format is not supported. For
814 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
815 # * Inconsistent format is not supported. For instance:
816 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
817 &quot;a_key&quot;: &quot;A String&quot;,
818 },
819 },
820 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
821 # You must specify this field as part of the HTTP request URL. It is
822 # not settable as a field in the request body.
823 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
824 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
825 },
826 ],
827 &quot;warning&quot;: { # Informational warning which replaces the list of routers when
828 # the list is empty.
829 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
830 # Engine returns NO_RESULTS_ON_PAGE if there
831 # are no results in the response.
832 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
833 # value format. For example:
834 #
835 # &quot;data&quot;: [
836 # {
837 # &quot;key&quot;: &quot;scope&quot;,
838 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
839 # }
840 {
841 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
842 # returned. For example, for warnings where there are no results in a list
843 # request for a particular zone, this key might be scope and
844 # the key value might be the zone name. Other examples might be a key
845 # indicating a deprecated resource and a suggested replacement, or a
846 # warning about invalid network settings (for example, if an instance
847 # attempts to perform IP forwarding but is not enabled for IP forwarding).
848 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
849 },
850 ],
851 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
852 },
853 },
854 },
855 &quot;kind&quot;: &quot;compute#routerAggregatedList&quot;, # Output only. Type of resource.
856 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
857 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
858 # the query parameter pageToken in the next list request.
859 # Subsequent list requests will have their own nextPageToken to
860 # continue paging through the results.
861 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
862 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
863 &quot;A String&quot;,
864 ],
865 &quot;warning&quot;: { # [Output Only] Informational warning message.
866 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
867 # Engine returns NO_RESULTS_ON_PAGE if there
868 # are no results in the response.
869 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
870 # value format. For example:
871 #
872 # &quot;data&quot;: [
873 # {
874 # &quot;key&quot;: &quot;scope&quot;,
875 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
876 # }
877 {
878 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
879 # returned. For example, for warnings where there are no results in a list
880 # request for a particular zone, this key might be scope and
881 # the key value might be the zone name. Other examples might be a key
882 # indicating a deprecated resource and a suggested replacement, or a
883 # warning about invalid network settings (for example, if an instance
884 # attempts to perform IP forwarding but is not enabled for IP forwarding).
885 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
886 },
887 ],
888 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
889 },
890 }</pre>
891 </div>
892
893 <div class="method">
894 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
895 <pre>Retrieves the next page of results.
896
897 Args:
898 previous_request: The request for the previous page. (required)
899 previous_response: The response from the request for the previous page. (required)
900
901 Returns:
902 A request object that you can call &#x27;execute()&#x27; on to request the next
903 page. Returns None if there are no more items in the collection.
904 </pre>
905 </div>
906
907 <div class="method">
908 <code class="details" id="close">close()</code>
909 <pre>Close httplib2 connections.</pre>
910 </div>
911
912 <div class="method">
913 <code class="details" id="delete">delete(project, region, router, requestId=None, x__xgafv=None)</code>
914 <pre>Deletes the specified Router resource.
915
916 Args:
917 project: string, Project ID for this request. (required)
918 region: string, Name of the region for this request. (required)
919 router: string, Name of the Router resource to delete. (required)
920 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
921 that if you must retry your request, the server will know to ignore the
922 request if it has already been completed.
923
924 For example, consider a situation where you make an initial request and
925 the request times out. If you make the request again with the same
926 request ID, the server can check if original operation with the same
927 request ID was received, and if so, will ignore the second request. This
928 prevents clients from accidentally creating duplicate commitments.
929
930 The request ID must be
931 a valid UUID with the exception that zero UUID is not supported
932 (00000000-0000-0000-0000-000000000000).
933 x__xgafv: string, V1 error format.
934 Allowed values
935 1 - v1 error format
936 2 - v2 error format
937
938 Returns:
939 An object of the form:
940
941 { # Represents an Operation resource.
942 #
943 # Google Compute Engine has three Operation resources:
944 #
945 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
946 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
947 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
948 #
949 # You can use an operation resource to manage asynchronous API requests.
950 # For more information, readHandling
951 # API responses.
952 #
953 # Operations can be global, regional or zonal.
954 #
955 # - For global operations, use the `globalOperations`
956 # resource.
957 # - For regional operations, use the
958 # `regionOperations` resource.
959 # - For zonal operations, use
960 # the `zoneOperations` resource.
961 #
962 #
963 #
964 # For more information, read
965 # Global, Regional, and Zonal Resources.
966 #
967 # Note that completed Operation resources have a limited
968 # retention period.
969 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
970 # Not present otherwise.
971 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
972 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
973 # set when the operation is created.
974 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
975 # text format.
976 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
977 # this field will be populated.
978 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
979 # operation.
980 {
981 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
982 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
983 # details. There is a set of defined message types to use for providing
984 # details.The syntax depends on the error code. For example,
985 # QuotaExceededInfo will have details when the error code is
986 # QUOTA_EXCEEDED.
987 {
988 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
989 #
990 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
991 # is not enabled:
992 #
993 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
994 # &quot;domain&quot;: &quot;googleapis.com&quot;
995 # &quot;metadata&quot;: {
996 # &quot;resource&quot;: &quot;projects/123&quot;,
997 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
998 # }
999 # }
1000 #
1001 # This response indicates that the pubsub.googleapis.com API is not enabled.
1002 #
1003 # Example of an error that is returned when attempting to create a Spanner
1004 # instance in a region that is out of stock:
1005 #
1006 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1007 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1008 # &quot;metadata&quot;: {
1009 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1010 # }
1011 # }
1012 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1013 # is typically the registered service name of the tool or product that
1014 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1015 # generated by some common infrastructure, the error domain must be a
1016 # globally unique value that identifies the infrastructure. For Google API
1017 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1018 &quot;metadatas&quot;: { # Additional structured details about this error.
1019 #
1020 # Keys must match a regular expression of `a-z+` but should
1021 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1022 # length. When identifying the current value of an exceeded limit, the units
1023 # should be contained in the key, not the value. For example, rather than
1024 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1025 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1026 # instances that can be created in a single (batch) request.
1027 &quot;a_key&quot;: &quot;A String&quot;,
1028 },
1029 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1030 # proximate cause of the error. Error reasons are unique within a particular
1031 # domain of errors. This should be at most 63 characters and match a
1032 # regular expression of `A-Z+[A-Z0-9]`, which represents
1033 # UPPER_SNAKE_CASE.
1034 },
1035 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1036 #
1037 # For example, if a quota check failed with an error indicating the calling
1038 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1039 # directly to the right place in the developer console to flip the bit.
1040 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1041 { # Describes a URL link.
1042 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1043 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1044 },
1045 ],
1046 },
1047 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1048 # which can be attached to an RPC error.
1049 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1050 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1051 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1052 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1053 },
1054 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1055 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1056 &quot;a_key&quot;: &quot;A String&quot;,
1057 },
1058 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1059 # type or metric.
1060 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1061 # or metric.
1062 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1063 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1064 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1065 },
1066 },
1067 ],
1068 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1069 # This property is optional.
1070 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1071 },
1072 ],
1073 },
1074 &quot;getVersionOperationMetadata&quot;: {
1075 &quot;inlineSbomInfo&quot;: {
1076 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1077 # appropriate identifiers.
1078 &quot;a_key&quot;: &quot;A String&quot;,
1079 },
1080 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1081 # identifiers.
1082 &quot;a_key&quot;: &quot;A String&quot;,
1083 },
1084 },
1085 },
1086 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1087 # message that was returned, such as `NOT FOUND`.
1088 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1089 # status code that was returned. For example, a `404` means the
1090 # resource was not found.
1091 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1092 # defined by the server.
1093 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1094 # This value is inRFC3339
1095 # text format.
1096 &quot;instancesBulkInsertOperationMetadata&quot;: {
1097 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1098 # Example key: zones/us-central1-a
1099 &quot;a_key&quot;: {
1100 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1101 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1102 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1103 # error.
1104 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1105 # if the flow is rolling forward or rolling back.
1106 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1107 },
1108 },
1109 },
1110 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1111 # Operation resources.
1112 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1113 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1114 # group of operations results from a `bulkInsert` API request.
1115 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1116 # `update`, or `delete`, and so on.
1117 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1118 # There is no requirement that this be linear or support any granularity of
1119 # operations. This should not be used to guess when the operation will be
1120 # complete. This number should monotonically increase as the operation
1121 # progresses.
1122 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1123 # applicable when performing regional operations.
1124 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1125 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1126 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1127 # this field will contain information on all underlying zonal actions and
1128 # their state.
1129 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1130 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1131 # Example key: zones/us-central1-a
1132 &quot;a_key&quot;: {
1133 &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
1134 # populated.
1135 # different programming environments, including REST APIs and RPC APIs. It is
1136 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1137 # three pieces of data: error code, error message, and error details.
1138 #
1139 # You can find out more about this error model and how to work with it in the
1140 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1141 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1142 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1143 # message types for APIs to use.
1144 {
1145 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1146 },
1147 ],
1148 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1149 # user-facing error message should be localized and sent in the
1150 # google.rpc.Status.details field, or localized by the client.
1151 },
1152 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1153 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1154 },
1155 },
1156 },
1157 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1158 # This value is inRFC3339
1159 # text format.
1160 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1161 # following:
1162 # `PENDING`, `RUNNING`, or `DONE`.
1163 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1164 # operation.
1165 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1166 # of the target resource.
1167 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1168 # operations related to creating a snapshot, this points to the disk
1169 # that the snapshot was created from.
1170 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1171 # `[email protected]` or
1172 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1173 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1174 # operation, this field will be populated.
1175 {
1176 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1177 # Engine returns NO_RESULTS_ON_PAGE if there
1178 # are no results in the response.
1179 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1180 # value format. For example:
1181 #
1182 # &quot;data&quot;: [
1183 # {
1184 # &quot;key&quot;: &quot;scope&quot;,
1185 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1186 # }
1187 {
1188 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1189 # returned. For example, for warnings where there are no results in a list
1190 # request for a particular zone, this key might be scope and
1191 # the key value might be the zone name. Other examples might be a key
1192 # indicating a deprecated resource and a suggested replacement, or a
1193 # warning about invalid network settings (for example, if an instance
1194 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1195 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1196 },
1197 ],
1198 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1199 },
1200 ],
1201 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1202 # applicable when performing per-zone operations.
1203 }</pre>
1204 </div>
1205
1206 <div class="method">
1207 <code class="details" id="deleteNamedSet">deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)</code>
1208 <pre>Deletes Named Set
1209
1210 Args:
1211 project: string, Project ID for this request. (required)
1212 region: string, Name of the region for this request. (required)
1213 router: string, Name of the Router resource where Named Set is defined. (required)
1214 namedSet: string, The Named Set name for this request. Name must conform to RFC1035
1215 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1216 that if you must retry your request, the server will know to ignore the
1217 request if it has already been completed.
1218
1219 For example, consider a situation where you make an initial request and
1220 the request times out. If you make the request again with the same
1221 request ID, the server can check if original operation with the same
1222 request ID was received, and if so, will ignore the second request. This
1223 prevents clients from accidentally creating duplicate commitments.
1224
1225 The request ID must be
1226 a valid UUID with the exception that zero UUID is not supported
1227 (00000000-0000-0000-0000-000000000000).
1228 x__xgafv: string, V1 error format.
1229 Allowed values
1230 1 - v1 error format
1231 2 - v2 error format
1232
1233 Returns:
1234 An object of the form:
1235
1236 { # Represents an Operation resource.
1237 #
1238 # Google Compute Engine has three Operation resources:
1239 #
1240 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1241 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1242 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1243 #
1244 # You can use an operation resource to manage asynchronous API requests.
1245 # For more information, readHandling
1246 # API responses.
1247 #
1248 # Operations can be global, regional or zonal.
1249 #
1250 # - For global operations, use the `globalOperations`
1251 # resource.
1252 # - For regional operations, use the
1253 # `regionOperations` resource.
1254 # - For zonal operations, use
1255 # the `zoneOperations` resource.
1256 #
1257 #
1258 #
1259 # For more information, read
1260 # Global, Regional, and Zonal Resources.
1261 #
1262 # Note that completed Operation resources have a limited
1263 # retention period.
1264 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1265 # Not present otherwise.
1266 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1267 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1268 # set when the operation is created.
1269 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1270 # text format.
1271 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1272 # this field will be populated.
1273 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1274 # operation.
1275 {
1276 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1277 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1278 # details. There is a set of defined message types to use for providing
1279 # details.The syntax depends on the error code. For example,
1280 # QuotaExceededInfo will have details when the error code is
1281 # QUOTA_EXCEEDED.
1282 {
1283 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1284 #
1285 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1286 # is not enabled:
1287 #
1288 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1289 # &quot;domain&quot;: &quot;googleapis.com&quot;
1290 # &quot;metadata&quot;: {
1291 # &quot;resource&quot;: &quot;projects/123&quot;,
1292 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1293 # }
1294 # }
1295 #
1296 # This response indicates that the pubsub.googleapis.com API is not enabled.
1297 #
1298 # Example of an error that is returned when attempting to create a Spanner
1299 # instance in a region that is out of stock:
1300 #
1301 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1302 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1303 # &quot;metadata&quot;: {
1304 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1305 # }
1306 # }
1307 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1308 # is typically the registered service name of the tool or product that
1309 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1310 # generated by some common infrastructure, the error domain must be a
1311 # globally unique value that identifies the infrastructure. For Google API
1312 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1313 &quot;metadatas&quot;: { # Additional structured details about this error.
1314 #
1315 # Keys must match a regular expression of `a-z+` but should
1316 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1317 # length. When identifying the current value of an exceeded limit, the units
1318 # should be contained in the key, not the value. For example, rather than
1319 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1320 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1321 # instances that can be created in a single (batch) request.
1322 &quot;a_key&quot;: &quot;A String&quot;,
1323 },
1324 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1325 # proximate cause of the error. Error reasons are unique within a particular
1326 # domain of errors. This should be at most 63 characters and match a
1327 # regular expression of `A-Z+[A-Z0-9]`, which represents
1328 # UPPER_SNAKE_CASE.
1329 },
1330 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1331 #
1332 # For example, if a quota check failed with an error indicating the calling
1333 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1334 # directly to the right place in the developer console to flip the bit.
1335 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1336 { # Describes a URL link.
1337 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1338 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1339 },
1340 ],
1341 },
1342 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1343 # which can be attached to an RPC error.
1344 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1345 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1346 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1347 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1348 },
1349 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1350 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1351 &quot;a_key&quot;: &quot;A String&quot;,
1352 },
1353 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1354 # type or metric.
1355 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1356 # or metric.
1357 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1358 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1359 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1360 },
1361 },
1362 ],
1363 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1364 # This property is optional.
1365 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1366 },
1367 ],
1368 },
1369 &quot;getVersionOperationMetadata&quot;: {
1370 &quot;inlineSbomInfo&quot;: {
1371 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1372 # appropriate identifiers.
1373 &quot;a_key&quot;: &quot;A String&quot;,
1374 },
1375 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1376 # identifiers.
1377 &quot;a_key&quot;: &quot;A String&quot;,
1378 },
1379 },
1380 },
1381 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1382 # message that was returned, such as `NOT FOUND`.
1383 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1384 # status code that was returned. For example, a `404` means the
1385 # resource was not found.
1386 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1387 # defined by the server.
1388 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1389 # This value is inRFC3339
1390 # text format.
1391 &quot;instancesBulkInsertOperationMetadata&quot;: {
1392 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1393 # Example key: zones/us-central1-a
1394 &quot;a_key&quot;: {
1395 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1396 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1397 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1398 # error.
1399 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1400 # if the flow is rolling forward or rolling back.
1401 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1402 },
1403 },
1404 },
1405 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1406 # Operation resources.
1407 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1408 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1409 # group of operations results from a `bulkInsert` API request.
1410 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1411 # `update`, or `delete`, and so on.
1412 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1413 # There is no requirement that this be linear or support any granularity of
1414 # operations. This should not be used to guess when the operation will be
1415 # complete. This number should monotonically increase as the operation
1416 # progresses.
1417 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1418 # applicable when performing regional operations.
1419 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1420 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1421 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1422 # this field will contain information on all underlying zonal actions and
1423 # their state.
1424 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1425 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1426 # Example key: zones/us-central1-a
1427 &quot;a_key&quot;: {
1428 &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
1429 # populated.
1430 # different programming environments, including REST APIs and RPC APIs. It is
1431 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1432 # three pieces of data: error code, error message, and error details.
1433 #
1434 # You can find out more about this error model and how to work with it in the
1435 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1436 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1437 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1438 # message types for APIs to use.
1439 {
1440 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1441 },
1442 ],
1443 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1444 # user-facing error message should be localized and sent in the
1445 # google.rpc.Status.details field, or localized by the client.
1446 },
1447 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1448 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1449 },
1450 },
1451 },
1452 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1453 # This value is inRFC3339
1454 # text format.
1455 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1456 # following:
1457 # `PENDING`, `RUNNING`, or `DONE`.
1458 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1459 # operation.
1460 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1461 # of the target resource.
1462 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1463 # operations related to creating a snapshot, this points to the disk
1464 # that the snapshot was created from.
1465 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1466 # `[email protected]` or
1467 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1468 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1469 # operation, this field will be populated.
1470 {
1471 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1472 # Engine returns NO_RESULTS_ON_PAGE if there
1473 # are no results in the response.
1474 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1475 # value format. For example:
1476 #
1477 # &quot;data&quot;: [
1478 # {
1479 # &quot;key&quot;: &quot;scope&quot;,
1480 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1481 # }
1482 {
1483 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1484 # returned. For example, for warnings where there are no results in a list
1485 # request for a particular zone, this key might be scope and
1486 # the key value might be the zone name. Other examples might be a key
1487 # indicating a deprecated resource and a suggested replacement, or a
1488 # warning about invalid network settings (for example, if an instance
1489 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1490 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1491 },
1492 ],
1493 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1494 },
1495 ],
1496 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1497 # applicable when performing per-zone operations.
1498 }</pre>
1499 </div>
1500
1501 <div class="method">
1502 <code class="details" id="deleteRoutePolicy">deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)</code>
1503 <pre>Deletes Route Policy
1504
1505 Args:
1506 project: string, Project ID for this request. (required)
1507 region: string, Name of the region for this request. (required)
1508 router: string, Name of the Router resource where Route Policy is defined. (required)
1509 policy: string, The Policy name for this request. Name must conform to RFC1035
1510 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1511 that if you must retry your request, the server will know to ignore the
1512 request if it has already been completed.
1513
1514 For example, consider a situation where you make an initial request and
1515 the request times out. If you make the request again with the same
1516 request ID, the server can check if original operation with the same
1517 request ID was received, and if so, will ignore the second request. This
1518 prevents clients from accidentally creating duplicate commitments.
1519
1520 The request ID must be
1521 a valid UUID with the exception that zero UUID is not supported
1522 (00000000-0000-0000-0000-000000000000).
1523 x__xgafv: string, V1 error format.
1524 Allowed values
1525 1 - v1 error format
1526 2 - v2 error format
1527
1528 Returns:
1529 An object of the form:
1530
1531 { # Represents an Operation resource.
1532 #
1533 # Google Compute Engine has three Operation resources:
1534 #
1535 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1536 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1537 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1538 #
1539 # You can use an operation resource to manage asynchronous API requests.
1540 # For more information, readHandling
1541 # API responses.
1542 #
1543 # Operations can be global, regional or zonal.
1544 #
1545 # - For global operations, use the `globalOperations`
1546 # resource.
1547 # - For regional operations, use the
1548 # `regionOperations` resource.
1549 # - For zonal operations, use
1550 # the `zoneOperations` resource.
1551 #
1552 #
1553 #
1554 # For more information, read
1555 # Global, Regional, and Zonal Resources.
1556 #
1557 # Note that completed Operation resources have a limited
1558 # retention period.
1559 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1560 # Not present otherwise.
1561 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1562 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1563 # set when the operation is created.
1564 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1565 # text format.
1566 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1567 # this field will be populated.
1568 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1569 # operation.
1570 {
1571 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1572 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1573 # details. There is a set of defined message types to use for providing
1574 # details.The syntax depends on the error code. For example,
1575 # QuotaExceededInfo will have details when the error code is
1576 # QUOTA_EXCEEDED.
1577 {
1578 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1579 #
1580 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1581 # is not enabled:
1582 #
1583 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1584 # &quot;domain&quot;: &quot;googleapis.com&quot;
1585 # &quot;metadata&quot;: {
1586 # &quot;resource&quot;: &quot;projects/123&quot;,
1587 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1588 # }
1589 # }
1590 #
1591 # This response indicates that the pubsub.googleapis.com API is not enabled.
1592 #
1593 # Example of an error that is returned when attempting to create a Spanner
1594 # instance in a region that is out of stock:
1595 #
1596 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1597 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1598 # &quot;metadata&quot;: {
1599 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1600 # }
1601 # }
1602 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1603 # is typically the registered service name of the tool or product that
1604 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1605 # generated by some common infrastructure, the error domain must be a
1606 # globally unique value that identifies the infrastructure. For Google API
1607 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1608 &quot;metadatas&quot;: { # Additional structured details about this error.
1609 #
1610 # Keys must match a regular expression of `a-z+` but should
1611 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1612 # length. When identifying the current value of an exceeded limit, the units
1613 # should be contained in the key, not the value. For example, rather than
1614 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1615 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1616 # instances that can be created in a single (batch) request.
1617 &quot;a_key&quot;: &quot;A String&quot;,
1618 },
1619 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1620 # proximate cause of the error. Error reasons are unique within a particular
1621 # domain of errors. This should be at most 63 characters and match a
1622 # regular expression of `A-Z+[A-Z0-9]`, which represents
1623 # UPPER_SNAKE_CASE.
1624 },
1625 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1626 #
1627 # For example, if a quota check failed with an error indicating the calling
1628 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1629 # directly to the right place in the developer console to flip the bit.
1630 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1631 { # Describes a URL link.
1632 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1633 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1634 },
1635 ],
1636 },
1637 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1638 # which can be attached to an RPC error.
1639 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1640 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1641 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1642 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1643 },
1644 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1645 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1646 &quot;a_key&quot;: &quot;A String&quot;,
1647 },
1648 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1649 # type or metric.
1650 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1651 # or metric.
1652 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1653 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1654 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1655 },
1656 },
1657 ],
1658 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1659 # This property is optional.
1660 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1661 },
1662 ],
1663 },
1664 &quot;getVersionOperationMetadata&quot;: {
1665 &quot;inlineSbomInfo&quot;: {
1666 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1667 # appropriate identifiers.
1668 &quot;a_key&quot;: &quot;A String&quot;,
1669 },
1670 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1671 # identifiers.
1672 &quot;a_key&quot;: &quot;A String&quot;,
1673 },
1674 },
1675 },
1676 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1677 # message that was returned, such as `NOT FOUND`.
1678 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1679 # status code that was returned. For example, a `404` means the
1680 # resource was not found.
1681 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1682 # defined by the server.
1683 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1684 # This value is inRFC3339
1685 # text format.
1686 &quot;instancesBulkInsertOperationMetadata&quot;: {
1687 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1688 # Example key: zones/us-central1-a
1689 &quot;a_key&quot;: {
1690 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1691 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1692 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1693 # error.
1694 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1695 # if the flow is rolling forward or rolling back.
1696 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1697 },
1698 },
1699 },
1700 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1701 # Operation resources.
1702 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1703 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1704 # group of operations results from a `bulkInsert` API request.
1705 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1706 # `update`, or `delete`, and so on.
1707 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1708 # There is no requirement that this be linear or support any granularity of
1709 # operations. This should not be used to guess when the operation will be
1710 # complete. This number should monotonically increase as the operation
1711 # progresses.
1712 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1713 # applicable when performing regional operations.
1714 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1715 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1716 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1717 # this field will contain information on all underlying zonal actions and
1718 # their state.
1719 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1720 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1721 # Example key: zones/us-central1-a
1722 &quot;a_key&quot;: {
1723 &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
1724 # populated.
1725 # different programming environments, including REST APIs and RPC APIs. It is
1726 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1727 # three pieces of data: error code, error message, and error details.
1728 #
1729 # You can find out more about this error model and how to work with it in the
1730 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1731 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1732 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1733 # message types for APIs to use.
1734 {
1735 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1736 },
1737 ],
1738 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1739 # user-facing error message should be localized and sent in the
1740 # google.rpc.Status.details field, or localized by the client.
1741 },
1742 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1743 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1744 },
1745 },
1746 },
1747 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1748 # This value is inRFC3339
1749 # text format.
1750 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1751 # following:
1752 # `PENDING`, `RUNNING`, or `DONE`.
1753 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1754 # operation.
1755 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1756 # of the target resource.
1757 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1758 # operations related to creating a snapshot, this points to the disk
1759 # that the snapshot was created from.
1760 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1761 # `[email protected]` or
1762 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1763 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1764 # operation, this field will be populated.
1765 {
1766 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1767 # Engine returns NO_RESULTS_ON_PAGE if there
1768 # are no results in the response.
1769 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1770 # value format. For example:
1771 #
1772 # &quot;data&quot;: [
1773 # {
1774 # &quot;key&quot;: &quot;scope&quot;,
1775 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1776 # }
1777 {
1778 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1779 # returned. For example, for warnings where there are no results in a list
1780 # request for a particular zone, this key might be scope and
1781 # the key value might be the zone name. Other examples might be a key
1782 # indicating a deprecated resource and a suggested replacement, or a
1783 # warning about invalid network settings (for example, if an instance
1784 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1785 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1786 },
1787 ],
1788 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1789 },
1790 ],
1791 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1792 # applicable when performing per-zone operations.
1793 }</pre>
1794 </div>
1795
1796 <div class="method">
1797 <code class="details" id="get">get(project, region, router, x__xgafv=None)</code>
1798 <pre>Returns the specified Router resource.
1799
1800 Args:
1801 project: string, Project ID for this request. (required)
1802 region: string, Name of the region for this request. (required)
1803 router: string, Name of the Router resource to return. (required)
1804 x__xgafv: string, V1 error format.
1805 Allowed values
1806 1 - v1 error format
1807 2 - v2 error format
1808
1809 Returns:
1810 An object of the form:
1811
1812 { # Represents a Cloud Router resource.
1813 #
1814 # For more information about Cloud Router, read theCloud
1815 # Router overview.
1816 &quot;bgp&quot;: { # BGP information specific to this router.
1817 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
1818 # The options are DEFAULT or CUSTOM.
1819 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
1820 # This field can only be populated if advertise_mode is CUSTOM and
1821 # is advertised to all peers of the router.
1822 # These groups will be advertised in addition to any specified prefixes.
1823 # Leave this field blank to advertise no custom groups.
1824 &quot;A String&quot;,
1825 ],
1826 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
1827 # This field can only be populated if advertise_mode is CUSTOM and
1828 # is advertised to all peers of the router.
1829 # These IP ranges will be advertised in addition to any specified groups.
1830 # Leave this field blank to advertise no custom IP ranges.
1831 { # Description-tagged IP ranges for the router to advertise.
1832 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
1833 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
1834 },
1835 ],
1836 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
1837 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
1838 # value will be fixed for this router resource. All VPN tunnels that link
1839 # to this router will have the same local ASN.
1840 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
1841 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
1842 # least /30, even if the BGP sessions are over IPv6. It must not overlap
1843 # with any IPv4 BGP session ranges.
1844 #
1845 #
1846 # Other vendors commonly call this &quot;router ID&quot;.
1847 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
1848 # sent to the peer.
1849 #
1850 #
1851 # Hold time is three times the interval at which keepalive messages are
1852 # sent, and the hold time is the maximum number of seconds allowed to
1853 # elapse between successive keepalive messages that BGP receives from a
1854 # peer.
1855 #
1856 #
1857 # BGP will use the smaller of either the local hold time value or the
1858 # peer&#x27;s hold time value as the hold time for the BGP connection between
1859 # the two peers.
1860 #
1861 #
1862 # If set, this value must be between 20 and 60. The default is 20.
1863 },
1864 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
1865 # establish BGP peering. This information must specify the peer ASN and
1866 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
1867 {
1868 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
1869 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
1870 # which currently supports the following option:
1871 #
1872 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
1873 # excludes any routes learned for subnets that use
1874 # VPC Network Peering.
1875 #
1876 #
1877 # Note that this field can only be populated if advertise_mode is CUSTOM
1878 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
1879 # These groups are advertised in addition to any specified prefixes.
1880 # Leave this field blank to advertise no custom groups.
1881 &quot;A String&quot;,
1882 ],
1883 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
1884 # This field can only be populated if advertise_mode is CUSTOM and
1885 # overrides the list defined for the router (in the &quot;bgp&quot; message).
1886 # These IP ranges are advertised in addition to any specified groups.
1887 # Leave this field blank to advertise no custom IP ranges.
1888 { # Description-tagged IP ranges for the router to advertise.
1889 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
1890 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
1891 },
1892 ],
1893 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
1894 # than one matching route of maximum length, the routes with the lowest
1895 # priority value win.
1896 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
1897 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
1898 # received from the peer router. The actual value is negotiated between
1899 # the two routers and is equal to the greater of this value and the
1900 # transmit interval of the other router.
1901 #
1902 #
1903 # If set, this value must be between 1000 and 30000.
1904 #
1905 #
1906 # The default is 1000.
1907 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
1908 # transmitted to the peer router. The actual value is negotiated between
1909 # the two routers and is equal to the greater of this value and the
1910 # corresponding receive interval of the other router.
1911 #
1912 #
1913 # If set, this value must be between 1000 and 30000.
1914 #
1915 #
1916 # The default is 1000.
1917 &quot;mode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
1918 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
1919 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
1920 # peer router to initiate the BFD session for this BGP peer. If set to
1921 # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.
1922 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
1923 # before BFD declares that a peer is unavailable.
1924 #
1925 #
1926 # If set, the value must be a value between 5 and 16.
1927 #
1928 #
1929 # The default is 5.
1930 &quot;packetMode&quot;: &quot;A String&quot;, # The BFD packet mode for this BGP peer.
1931 # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer.
1932 # In this mode, if the peer router also has BFD echo mode enabled, BFD
1933 # echo packets will be sent to the other router. If the peer router does
1934 # not have BFD echo mode enabled, only control packets will be sent. If
1935 # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If
1936 # this router and the peer router have a multihop connection, this should
1937 # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop
1938 # connections. The default is CONTROL_AND_ECHO.
1939 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
1940 #
1941 #
1942 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
1943 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
1944 # peer router to initiate the BFD session for this BGP peer. If set to
1945 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
1946 &quot;slowTimerInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
1947 # transmitted to and received from the peer router when BFD echo mode is
1948 # enabled on both routers. The actual transmit and receive intervals are
1949 # negotiated between the two routers and are equal to the greater of this
1950 # value and the corresponding interval on the other router.
1951 # If set, this value must be between 1000 and 30000.
1952 # The default is 5000.
1953 },
1954 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
1955 # session.
1956 {
1957 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
1958 # CIDR-formatted prefix. If an IP address is provided without a subnet
1959 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
1960 # range, and, for IPv6, `/128`.
1961 },
1962 ],
1963 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
1964 # value is applied to all custom learned route ranges for the session.
1965 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
1966 # value, Google Cloud assigns a priority of `100` to the ranges.
1967 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
1968 #
1969 #
1970 # If set to FALSE, any active session with the peer is terminated and
1971 # all associated routing information is removed. If set to TRUE, the
1972 # peer connection can be established with routing information. The default
1973 # is TRUE.
1974 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
1975 # the peerIpAddress is version 4.
1976 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
1977 # peerIpAddress is version 6.
1978 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
1979 # evaluated. The name must correspond to an existing policy that has
1980 # ROUTE_POLICY_TYPE_EXPORT type.
1981 &quot;A String&quot;,
1982 ],
1983 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
1984 # evaluated. The name must correspond to an existing policy that has
1985 # ROUTE_POLICY_TYPE_IMPORT type.
1986 &quot;A String&quot;,
1987 ],
1988 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
1989 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
1990 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
1991 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
1992 &quot;linkedCustomHardware&quot;: &quot;A String&quot;, # The linked custom hardware resource.
1993 # The URI of the custom hardware link attachment
1994 # is where you will establish the BGP session from the Cloud Router.
1995 # This link attachment must reside in the same subnetwork as the associated
1996 # router interface.
1997 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
1998 #
1999 # - MANAGED_BY_USER is the default value and can be managed by you
2000 # or other users
2001 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
2002 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
2003 # PARTNER. Google automatically creates, updates, and deletes this type of
2004 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
2005 # or deleted.
2006 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
2007 # name of one of the entries in the Router.md5_authentication_keys. The
2008 # field must comply with RFC1035.
2009 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
2010 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
2011 # characters long and match the regular expression
2012 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
2013 # lowercase letter, and all following characters must be a dash, lowercase
2014 # letter, or digit, except the last character, which cannot be a dash.
2015 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
2016 # a different value.
2017 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
2018 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
2019 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
2020 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
2021 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
2022 # Appliances. The VM instance must be located in zones contained in the
2023 # same region as this Cloud Router.
2024 # The VM instance is the peer side of the BGP session.
2025 },
2026 ],
2027 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2028 # text format.
2029 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2030 # create the resource.
2031 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
2032 # attachments (interconnectAttachments).
2033 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2034 # defined by the server.
2035 &quot;interfaces&quot;: [ # Router interfaces.
2036 # To create a BGP peer that uses a router interface,
2037 # the interface must have one of the following fields specified:
2038 #
2039 # - linkedVpnTunnel
2040 # - linkedInterconnectAttachment
2041 # - subnetwork
2042 #
2043 #
2044 # You can create a router interface without any of these fields specified.
2045 # However, you cannot create a BGP peer that uses that interface.
2046 {
2047 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
2048 #
2049 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
2050 # be a CIDR-formatted string, for example, 169.254.0.1/30.
2051 # Note: Do not truncate the IP address, as it represents the IP address of
2052 # the interface.
2053 # - For Internet Protocol version 6 (IPv6), the value
2054 # must be a unique local address (ULA) range from fdff:1::/64
2055 # with a mask length of 126 or less. This value should be a CIDR-formatted
2056 # string, for example, fdff:1::1/112. Within the router&#x27;s
2057 # VPC, this IPv6 prefix will be reserved exclusively for this connection
2058 # and cannot be used for any other purpose.
2059 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
2060 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
2061 # as the router. Each interface can have one linked resource, which can be
2062 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
2063 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
2064 # router. Each interface can have one linked resource, which can be
2065 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
2066 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
2067 #
2068 # - MANAGED_BY_USER is the default value and can be managed directly
2069 # by users.
2070 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
2071 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
2072 # of type PARTNER. Google automatically creates, updates, and deletes
2073 # this type of interface when the PARTNER InterconnectAttachment is
2074 # created, updated, or deleted.
2075 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
2076 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
2077 # characters long and match the regular expression
2078 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
2079 # lowercase letter, and all following characters must be a dash, lowercase
2080 # letter, or digit, except the last character, which cannot be a dash.
2081 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
2082 # BGP sessions to a VM instance acting as a third-party
2083 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
2084 # an SD-WAN VM.
2085 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
2086 # you are creating. The redundantInterface must belong to the same Cloud
2087 # Router as the interface here. To establish the BGP session to a Router
2088 # Appliance VM, you must create two BGP peers. The two BGP peers must be
2089 # attached to two separate interfaces that are redundant with each other.
2090 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
2091 # be 1-63 characters long and match the regular expression
2092 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
2093 # lowercase letter, and all following characters must be a dash, lowercase
2094 # letter, or digit, except the last character, which cannot be a dash.
2095 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
2096 # must be in the same region as the Cloud Router.
2097 # When you establish a BGP session to a VM instance using this interface,
2098 # the VM instance must belong to the same subnetwork as the subnetwork
2099 # specified here.
2100 },
2101 ],
2102 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
2103 # routers.
2104 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
2105 {
2106 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
2107 #
2108 # For patch and update calls, it can be skipped to
2109 # copy the value from the previous configuration. This is allowed if the
2110 # key with the same name existed before the operation. Maximum length is 80
2111 # characters. Can only contain printable ASCII characters.
2112 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
2113 #
2114 # Must be unique within a router. Must be referenced by exactly
2115 # one bgpPeer. Must comply withRFC1035.
2116 },
2117 ],
2118 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2119 # The name must be 1-63 characters long, and comply withRFC1035.
2120 # Specifically, the name must be 1-63 characters long and match the regular
2121 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2122 # character must be a lowercase letter, and all following characters must
2123 # be a dash, lowercase letter, or digit, except the last character, which
2124 # cannot be a dash.
2125 &quot;nats&quot;: [ # A list of NAT services created in this router.
2126 { # Represents a Nat resource. It enables the VMs within the specified
2127 # subnetworks to access Internet without external IP addresses. It specifies
2128 # a list of subnetworks (and the ranges within) that want to use NAT.
2129 # Customers can also provide the external IPs that would be used for NAT. GCP
2130 # would auto-allocate ephemeral IPs if no external IPs are provided.
2131 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
2132 # Must be one of: PREMIUM, STANDARD.
2133 # If not specified, then the current
2134 # project-level default tier is used.
2135 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
2136 # must be valid static external IPs that have been assigned to the NAT.
2137 # These IPs should be used for updating/patching a NAT only.
2138 &quot;A String&quot;,
2139 ],
2140 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
2141 # state. This value is equal to tcp_time_wait_timeout_sec.
2142 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
2143 # 120s. The field is output only.
2144 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
2145 #
2146 #
2147 # If not specified, it is disabled by default.
2148 #
2149 #
2150 # If set to true,
2151 #
2152 # - Dynamic Port Allocation will be enabled on this NAT
2153 # config.
2154 # - enableEndpointIndependentMapping cannot be set to true.
2155 # - If minPorts is set, minPortsPerVm must be set to a
2156 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
2157 # minimum of 32 ports will be allocated to a VM from this NAT
2158 # config.
2159 &quot;enableEndpointIndependentMapping&quot;: True or False,
2160 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
2161 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
2162 &quot;A String&quot;,
2163 ],
2164 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
2165 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
2166 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
2167 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
2168 # logs are exported for all connections handled by this NAT.
2169 # This option can take one of the following values:
2170 #
2171 # - ERRORS_ONLY: Export logs only for connection failures.
2172 # - TRANSLATIONS_ONLY: Export logs only for successful
2173 # connections.
2174 # - ALL: Export logs for all connections, successful and
2175 # unsuccessful.
2176 },
2177 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
2178 # Dynamic Port Allocation is enabled.
2179 #
2180 #
2181 # If Dynamic Port Allocation is not enabled, this field has no effect.
2182 #
2183 #
2184 # If Dynamic Port Allocation is enabled, and this field is set, it must be
2185 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
2186 # is not set.
2187 #
2188 #
2189 # If Dynamic Port Allocation is enabled and this field is not set,
2190 # a maximum of 65536 ports will be allocated to a VM from this NAT
2191 # config.
2192 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
2193 # set, a default number of ports is allocated to a VM. This is rounded
2194 # up to the nearest power of 2. For example, if the value of this field is
2195 # 50, at least 64 ports are allocated to a VM.
2196 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
2197 # The name must be 1-63 characters long and comply withRFC1035.
2198 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
2199 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
2200 # selected for the SubnetworkIpRangeToNat64Option above.
2201 { # Specifies a subnetwork to enable NAT64.
2202 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
2203 },
2204 ],
2205 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
2206 # values:
2207 #
2208 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
2209 # customers. When there are not enough specified Nat IPs, the Nat service
2210 # fails for new VMs.
2211 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
2212 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
2213 # be empty.
2214 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
2215 # addresses must be valid static external IP addresses assigned to the
2216 # project.
2217 &quot;A String&quot;,
2218 ],
2219 &quot;rules&quot;: [ # A list of rules associated with this NAT.
2220 {
2221 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
2222 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
2223 # addresses must be valid static external IP addresses assigned to the
2224 # project.
2225 # This field is used for public NAT.
2226 &quot;A String&quot;,
2227 ],
2228 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
2229 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
2230 # This field is used for private NAT.
2231 &quot;A String&quot;,
2232 ],
2233 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
2234 # must be valid static external IPs that have been assigned to the NAT.
2235 # These IPs should be used for updating/patching a NAT rule only.
2236 # This field is used for public NAT.
2237 &quot;A String&quot;,
2238 ],
2239 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
2240 # drained. This is only supported on patch/update, and these
2241 # subnetworks must have previously been used as active ranges in this
2242 # NAT Rule.
2243 # This field is used for private NAT.
2244 &quot;A String&quot;,
2245 ],
2246 },
2247 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
2248 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
2249 # from a VM is evaluated against. If it evaluates to true, the
2250 # corresponding `action` is enforced.
2251 #
2252 # The following examples are valid match expressions for public NAT:
2253 #
2254 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
2255 # &#x27;2.2.0.0/16&#x27;)`
2256 #
2257 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
2258 #
2259 # The following example is a valid match expression for private NAT:
2260 #
2261 # `nexthop.hub ==
2262 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
2263 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
2264 # must be a positive value between 0 and 65000, and
2265 # must be unique among rules within a NAT.
2266 &quot;sourceWorkloadIdentities&quot;: [ # A list of source workload identities.
2267 &quot;A String&quot;,
2268 ],
2269 },
2270 ],
2271 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
2272 #
2273 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
2274 # Subnetwork are allowed to Nat.
2275 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
2276 # in every Subnetwork are allowed to Nat.
2277 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
2278 # (specified in the field subnetwork below)
2279 #
2280 #
2281 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
2282 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
2283 # should not be any other Router.Nat section in any Router for this network
2284 # in this region.
2285 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
2286 # values:
2287 #
2288 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
2289 # every Subnetwork are allowed to Nat.
2290 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
2291 # (specified in the field nat64_subnetwork below)
2292 #
2293 #
2294 # The default is NAT64_OPTION_UNSPECIFIED.
2295 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
2296 # Router.Nat section in this region can also enable NAT64 for any
2297 # Subnetworks in this network. Other Router.Nat sections can still be
2298 # present to enable NAT44 only.
2299 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
2300 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
2301 # SubnetworkIpRangeToNatOption above.
2302 { # Defines the IP ranges that want to use NAT for a subnetwork.
2303 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
2304 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
2305 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
2306 # is one of the values in source_ip_ranges_to_nat.
2307 &quot;A String&quot;,
2308 ],
2309 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
2310 # options of a single value are valid except
2311 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
2312 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
2313 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
2314 # Default: [ALL_IP_RANGES]
2315 &quot;A String&quot;,
2316 ],
2317 },
2318 ],
2319 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
2320 # if not set.
2321 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
2322 # Defaults to 120s if not set.
2323 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
2324 # not set.
2325 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
2326 # translation. If unspecified, it defaults to PUBLIC.
2327 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
2328 },
2329 ],
2330 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
2331 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
2332 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2333 # as part of resource payload.
2334 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2335 # The field is allowed for INSERT
2336 # only. The keys/values to set on the resource should be specified in
2337 # either ID { : } or Namespaced format
2338 # { : }.
2339 # For example the following are valid inputs:
2340 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2341 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2342 # Note:
2343 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2344 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2345 # * Inconsistent format is not supported. For instance:
2346 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
2347 &quot;a_key&quot;: &quot;A String&quot;,
2348 },
2349 },
2350 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
2351 # You must specify this field as part of the HTTP request URL. It is
2352 # not settable as a field in the request body.
2353 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2354 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2355 }</pre>
2356 </div>
2357
2358 <div class="method">
2359 <code class="details" id="getNamedSet">getNamedSet(project, region, router, namedSet=None, x__xgafv=None)</code>
2360 <pre>Returns specified Named Set
2361
2362 Args:
2363 project: string, Project ID for this request. (required)
2364 region: string, Name of the region for this request. (required)
2365 router: string, Name of the Router resource to query for the named set. The name should
2366 conform to RFC1035. (required)
2367 namedSet: string, The Named Set name for this request. Name must conform to RFC1035
2368 x__xgafv: string, V1 error format.
2369 Allowed values
2370 1 - v1 error format
2371 2 - v2 error format
2372
2373 Returns:
2374 An object of the form:
2375
2376 {
2377 &quot;etag&quot;: &quot;A String&quot;, # end_interface: MixerGetResponseWithEtagBuilder
2378 &quot;resource&quot;: {
2379 &quot;description&quot;: &quot;A String&quot;, # An optional description of named set.
2380 &quot;elements&quot;: [ # CEL expressions that are comparable to constructs of this set&#x27;s type
2381 # (see Policy Language).
2382 { # Represents a textual expression in the Common Expression Language (CEL)
2383 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2384 # are documented at https://github.com/google/cel-spec.
2385 #
2386 # Example (Comparison):
2387 #
2388 # title: &quot;Summary size limit&quot;
2389 # description: &quot;Determines if a summary is less than 100 chars&quot;
2390 # expression: &quot;document.summary.size() &lt; 100&quot;
2391 #
2392 # Example (Equality):
2393 #
2394 # title: &quot;Requestor is owner&quot;
2395 # description: &quot;Determines if requestor is the document owner&quot;
2396 # expression: &quot;document.owner == request.auth.claims.email&quot;
2397 #
2398 # Example (Logic):
2399 #
2400 # title: &quot;Public documents&quot;
2401 # description: &quot;Determine whether the document should be publicly visible&quot;
2402 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2403 #
2404 # Example (Data Manipulation):
2405 #
2406 # title: &quot;Notification string&quot;
2407 # description: &quot;Create a notification string with a timestamp.&quot;
2408 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2409 #
2410 # The exact variables and functions that may be referenced within an expression
2411 # are determined by the service that evaluates it. See the service
2412 # documentation for additional information.
2413 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2414 # describes the expression, e.g. when hovered over it in a UI.
2415 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2416 # syntax.
2417 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2418 # reporting, e.g. a file name and a position in the file.
2419 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2420 # its purpose. This can be used e.g. in UIs which allow to enter the
2421 # expression.
2422 },
2423 ],
2424 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Named Set being applied to this Router, which is
2425 # essentially a hash of the Named Set used for optimistic locking.
2426 # The fingerprint is initially generated by Compute Engine and changes
2427 # after every request to modify or update the Named Set. You must always
2428 # provide an up-to-date fingerprint hash in order to update or change
2429 # labels.
2430 #
2431 # To see the latest fingerprint, make a getNamedSet() request
2432 # to retrieve a Named Set.
2433 &quot;name&quot;: &quot;A String&quot;, # This set&#x27;s name, which must be a resource ID segment and unique within all
2434 # named sets owned by the Router. Name should conform to RFC1035.
2435 &quot;type&quot;: &quot;A String&quot;, # This named set&#x27;s type
2436 },
2437 }</pre>
2438 </div>
2439
2440 <div class="method">
2441 <code class="details" id="getNatIpInfo">getNatIpInfo(project, region, router, natName=None, x__xgafv=None)</code>
2442 <pre>Retrieves runtime NAT IP information.
2443
2444 Args:
2445 project: string, Project ID for this request. (required)
2446 region: string, Name of the region for this request. (required)
2447 router: string, Name of the Router resource to query for Nat IP information. The name
2448 should conform to RFC1035. (required)
2449 natName: string, Name of the nat service to filter the NAT IP information.
2450 If it is omitted, all nats for this router will be returned.
2451 Name should conform to RFC1035.
2452 x__xgafv: string, V1 error format.
2453 Allowed values
2454 1 - v1 error format
2455 2 - v2 error format
2456
2457 Returns:
2458 An object of the form:
2459
2460 {
2461 &quot;result&quot;: [ # [Output Only] A list of NAT IP information.
2462 { # Contains NAT IP information of a NAT config (i.e. usage status, mode).
2463 &quot;natIpInfoMappings&quot;: [ # Output only. A list of all NAT IPs assigned to this NAT config.
2464 { # Contains information of a NAT IP.
2465 &quot;mode&quot;: &quot;A String&quot;, # Output only. Specifies whether NAT IP is auto or manual.
2466 &quot;natIp&quot;: &quot;A String&quot;, # Output only. NAT IP address. For example: 203.0.113.11.
2467 &quot;usage&quot;: &quot;A String&quot;, # Output only. Specifies whether NAT IP is currently serving at least one endpoint or
2468 # not.
2469 },
2470 ],
2471 &quot;natName&quot;: &quot;A String&quot;, # Output only. Name of the NAT config which the NAT IP belongs to.
2472 },
2473 ],
2474 }</pre>
2475 </div>
2476
2477 <div class="method">
2478 <code class="details" id="getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, natName=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2479 <pre>Retrieves runtime Nat mapping information of VM endpoints.
2480
2481 Args:
2482 project: string, Project ID for this request. (required)
2483 region: string, Name of the region for this request. (required)
2484 router: string, Name of the Router resource to query for Nat Mapping information of
2485 VM endpoints. (required)
2486 filter: string, A filter expression that filters resources listed in the response. Most
2487 Compute resources support two types of filter expressions:
2488 expressions that support regular expressions and expressions that follow
2489 API improvement proposal AIP-160.
2490 These two types of filter expressions cannot be mixed in one request.
2491
2492 If you want to use AIP-160, your expression must specify the field name, an
2493 operator, and the value that you want to use for filtering. The value
2494 must be a string, a number, or a boolean. The operator
2495 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2496
2497 For example, if you are filtering Compute Engine instances, you can
2498 exclude instances named `example-instance` by specifying
2499 `name != example-instance`.
2500
2501 The `:*` comparison can be used to test whether a key has been defined.
2502 For example, to find all objects with `owner` label use:
2503 ```
2504 labels.owner:*
2505 ```
2506
2507 You can also filter nested fields. For example, you could specify
2508 `scheduling.automaticRestart = false` to include instances only
2509 if they are not scheduled for automatic restarts. You can use filtering
2510 on nested fields to filter based onresource labels.
2511
2512 To filter on multiple expressions, provide each separate expression within
2513 parentheses. For example:
2514 ```
2515 (scheduling.automaticRestart = true)
2516 (cpuPlatform = &quot;Intel Skylake&quot;)
2517 ```
2518 By default, each expression is an `AND` expression. However, you
2519 can include `AND` and `OR` expressions explicitly.
2520 For example:
2521 ```
2522 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2523 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2524 (scheduling.automaticRestart = true)
2525 ```
2526
2527 If you want to use a regular expression, use the `eq` (equal) or `ne`
2528 (not equal) operator against a single un-parenthesized expression with or
2529 without quotes or against multiple parenthesized expressions. Examples:
2530
2531 `fieldname eq unquoted literal`
2532 `fieldname eq &#x27;single quoted literal&#x27;`
2533 `fieldname eq &quot;double quoted literal&quot;`
2534 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2535
2536 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2537 The literal value must match the entire field.
2538
2539 For example, to filter for instances that do not end with name &quot;instance&quot;,
2540 you would use `name ne .*instance`.
2541
2542 You cannot combine constraints on multiple fields using regular
2543 expressions.
2544 maxResults: integer, The maximum number of results per page that should be returned.
2545 If the number of available results is larger than `maxResults`,
2546 Compute Engine returns a `nextPageToken` that can be used to get
2547 the next page of results in subsequent list requests. Acceptable values are
2548 `0` to `500`, inclusive. (Default: `500`)
2549 natName: string, Name of the nat service to filter the Nat Mapping information.
2550 If it is omitted, all nats for this router will be returned.
2551 Name should conform to RFC1035.
2552 orderBy: string, Sorts list results by a certain order. By default, results
2553 are returned in alphanumerical order based on the resource name.
2554
2555 You can also sort results in descending order based on the creation
2556 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2557 results based on the `creationTimestamp` field in
2558 reverse chronological order (newest result first). Use this to sort
2559 resources like operations so that the newest operation is returned first.
2560
2561 Currently, only sorting by `name` or
2562 `creationTimestamp desc` is supported.
2563 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2564 `nextPageToken` returned by a previous list request to get
2565 the next page of results.
2566 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2567 of failure. The default value is false.
2568
2569 For example, when partial success behavior is enabled, aggregatedList for a
2570 single zone scope either returns all resources in the zone or no resources,
2571 with an error code.
2572 x__xgafv: string, V1 error format.
2573 Allowed values
2574 1 - v1 error format
2575 2 - v2 error format
2576
2577 Returns:
2578 An object of the form:
2579
2580 { # Contains a list of VmEndpointNatMappings.
2581 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2582 # defined by the server.
2583 &quot;kind&quot;: &quot;compute#vmEndpointNatMappingsList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#vmEndpointNatMappingsList for lists of Nat mappings of
2584 # VM endpoints.
2585 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2586 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2587 # the query parameter pageToken in the next list request.
2588 # Subsequent list requests will have their own nextPageToken to
2589 # continue paging through the results.
2590 &quot;result&quot;: [ # [Output Only] A list of Nat mapping information of VM endpoints.
2591 { # Contain information of Nat mapping for a VM endpoint (i.e., NIC).
2592 &quot;instanceName&quot;: &quot;A String&quot;, # Output only. Name of the VM instance which the endpoint belongs to
2593 &quot;interfaceNatMappings&quot;: [
2594 { # Contain information of Nat mapping for an interface of this endpoint.
2595 &quot;drainNatIpPortRanges&quot;: [ # Output only. List of all drain IP:port-range mappings assigned to this interface.
2596 # These ranges are inclusive, that is, both the first and the last
2597 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2598 # &quot;1.1.1.1:2234-2234&quot;].
2599 &quot;A String&quot;,
2600 ],
2601 &quot;natIpPortRanges&quot;: [ # Output only. A list of all IP:port-range mappings assigned to this interface.
2602 # These ranges are inclusive, that is, both the first and the last
2603 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2604 # &quot;1.1.1.1:2234-2234&quot;].
2605 &quot;A String&quot;,
2606 ],
2607 &quot;numTotalDrainNatPorts&quot;: 42, # Output only. Total number of drain ports across all NAT IPs allocated to this
2608 # interface. It equals to the aggregated port number in the field
2609 # drain_nat_ip_port_ranges.
2610 &quot;numTotalNatPorts&quot;: 42, # Output only. Total number of ports across all NAT IPs allocated to this interface.
2611 # It equals to the aggregated port number in the field nat_ip_port_ranges.
2612 &quot;ruleMappings&quot;: [ # Output only. Information about mappings provided by rules in this NAT.
2613 { # Contains information of NAT Mappings provided by a NAT Rule.
2614 &quot;drainNatIpPortRanges&quot;: [ # Output only. List of all drain IP:port-range mappings assigned to this interface
2615 # by this rule.
2616 # These ranges are inclusive, that is, both the first and the last
2617 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2618 # &quot;1.1.1.1:2234-2234&quot;].
2619 &quot;A String&quot;,
2620 ],
2621 &quot;natIpPortRanges&quot;: [ # Output only. A list of all IP:port-range mappings assigned to this interface by this
2622 # rule.
2623 # These ranges are inclusive, that is, both the first and the last
2624 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2625 # &quot;1.1.1.1:2234-2234&quot;].
2626 &quot;A String&quot;,
2627 ],
2628 &quot;numTotalDrainNatPorts&quot;: 42, # Output only. Total number of drain ports across all NAT IPs allocated to this
2629 # interface by this rule.
2630 # It equals the aggregated port number in the field
2631 # drain_nat_ip_port_ranges.
2632 &quot;numTotalNatPorts&quot;: 42, # Output only. Total number of ports across all NAT IPs allocated to this interface
2633 # by this rule.
2634 # It equals the aggregated port number in the field nat_ip_port_ranges.
2635 &quot;ruleNumber&quot;: 42, # Output only. Rule number of the NAT Rule.
2636 },
2637 ],
2638 &quot;sourceAliasIpRange&quot;: &quot;A String&quot;, # Output only. Alias IP range for this interface endpoint.
2639 # It will be a private (RFC 1918) IP range.
2640 # Examples: &quot;10.33.4.55/32&quot;, or &quot;192.168.5.0/24&quot;.
2641 &quot;sourceVirtualIp&quot;: &quot;A String&quot;, # Output only. Primary IP of the VM for this NIC.
2642 },
2643 ],
2644 },
2645 ],
2646 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2647 &quot;warning&quot;: { # [Output Only] Informational warning message.
2648 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2649 # Engine returns NO_RESULTS_ON_PAGE if there
2650 # are no results in the response.
2651 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2652 # value format. For example:
2653 #
2654 # &quot;data&quot;: [
2655 # {
2656 # &quot;key&quot;: &quot;scope&quot;,
2657 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2658 # }
2659 {
2660 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2661 # returned. For example, for warnings where there are no results in a list
2662 # request for a particular zone, this key might be scope and
2663 # the key value might be the zone name. Other examples might be a key
2664 # indicating a deprecated resource and a suggested replacement, or a
2665 # warning about invalid network settings (for example, if an instance
2666 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2667 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2668 },
2669 ],
2670 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2671 },
2672 }</pre>
2673 </div>
2674
2675 <div class="method">
2676 <code class="details" id="getNatMappingInfo_next">getNatMappingInfo_next()</code>
2677 <pre>Retrieves the next page of results.
2678
2679 Args:
2680 previous_request: The request for the previous page. (required)
2681 previous_response: The response from the request for the previous page. (required)
2682
2683 Returns:
2684 A request object that you can call &#x27;execute()&#x27; on to request the next
2685 page. Returns None if there are no more items in the collection.
2686 </pre>
2687 </div>
2688
2689 <div class="method">
2690 <code class="details" id="getRoutePolicy">getRoutePolicy(project, region, router, policy=None, x__xgafv=None)</code>
2691 <pre>Returns specified Route Policy
2692
2693 Args:
2694 project: string, Project ID for this request. (required)
2695 region: string, Name of the region for this request. (required)
2696 router: string, Name of the Router resource to query for the route policy. The name should
2697 conform to RFC1035. (required)
2698 policy: string, The Policy name for this request. Name must conform to RFC1035
2699 x__xgafv: string, V1 error format.
2700 Allowed values
2701 1 - v1 error format
2702 2 - v2 error format
2703
2704 Returns:
2705 An object of the form:
2706
2707 {
2708 &quot;etag&quot;: &quot;A String&quot;, # end_interface: MixerGetResponseWithEtagBuilder
2709 &quot;resource&quot;: {
2710 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
2711 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
2712 # essentially a hash of the Route Policy used for optimistic locking.
2713 # The fingerprint is initially generated by Compute Engine and changes
2714 # after every request to modify or update Route Policy. You must always
2715 # provide an up-to-date fingerprint hash in order to update or change
2716 # labels.
2717 #
2718 # To see the latest fingerprint, make a getRoutePolicy() request
2719 # to retrieve a Route Policy.
2720 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
2721 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
2722 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
2723 # in order of priority). Order of policies is not retained and might change
2724 # when getting policy later.
2725 {
2726 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
2727 { # Represents a textual expression in the Common Expression Language (CEL)
2728 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2729 # are documented at https://github.com/google/cel-spec.
2730 #
2731 # Example (Comparison):
2732 #
2733 # title: &quot;Summary size limit&quot;
2734 # description: &quot;Determines if a summary is less than 100 chars&quot;
2735 # expression: &quot;document.summary.size() &lt; 100&quot;
2736 #
2737 # Example (Equality):
2738 #
2739 # title: &quot;Requestor is owner&quot;
2740 # description: &quot;Determines if requestor is the document owner&quot;
2741 # expression: &quot;document.owner == request.auth.claims.email&quot;
2742 #
2743 # Example (Logic):
2744 #
2745 # title: &quot;Public documents&quot;
2746 # description: &quot;Determine whether the document should be publicly visible&quot;
2747 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2748 #
2749 # Example (Data Manipulation):
2750 #
2751 # title: &quot;Notification string&quot;
2752 # description: &quot;Create a notification string with a timestamp.&quot;
2753 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2754 #
2755 # The exact variables and functions that may be referenced within an expression
2756 # are determined by the service that evaluates it. See the service
2757 # documentation for additional information.
2758 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2759 # describes the expression, e.g. when hovered over it in a UI.
2760 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2761 # syntax.
2762 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2763 # reporting, e.g. a file name and a position in the file.
2764 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2765 # its purpose. This can be used e.g. in UIs which allow to enter the
2766 # expression.
2767 },
2768 ],
2769 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
2770 # applies. When not set, the term applies to all
2771 # routes.
2772 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2773 # are documented at https://github.com/google/cel-spec.
2774 #
2775 # Example (Comparison):
2776 #
2777 # title: &quot;Summary size limit&quot;
2778 # description: &quot;Determines if a summary is less than 100 chars&quot;
2779 # expression: &quot;document.summary.size() &lt; 100&quot;
2780 #
2781 # Example (Equality):
2782 #
2783 # title: &quot;Requestor is owner&quot;
2784 # description: &quot;Determines if requestor is the document owner&quot;
2785 # expression: &quot;document.owner == request.auth.claims.email&quot;
2786 #
2787 # Example (Logic):
2788 #
2789 # title: &quot;Public documents&quot;
2790 # description: &quot;Determine whether the document should be publicly visible&quot;
2791 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2792 #
2793 # Example (Data Manipulation):
2794 #
2795 # title: &quot;Notification string&quot;
2796 # description: &quot;Create a notification string with a timestamp.&quot;
2797 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2798 #
2799 # The exact variables and functions that may be referenced within an expression
2800 # are determined by the service that evaluates it. See the service
2801 # documentation for additional information.
2802 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2803 # describes the expression, e.g. when hovered over it in a UI.
2804 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2805 # syntax.
2806 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2807 # reporting, e.g. a file name and a position in the file.
2808 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2809 # its purpose. This can be used e.g. in UIs which allow to enter the
2810 # expression.
2811 },
2812 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
2813 # (inclusive) and 2^31 (exclusive), and unique within the list.
2814 },
2815 ],
2816 &quot;type&quot;: &quot;A String&quot;,
2817 },
2818 }</pre>
2819 </div>
2820
2821 <div class="method">
2822 <code class="details" id="getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</code>
2823 <pre>Retrieves runtime information of the specified router.
2824
2825 Args:
2826 project: string, Project ID for this request. (required)
2827 region: string, Name of the region for this request. (required)
2828 router: string, Name of the Router resource to query. (required)
2829 x__xgafv: string, V1 error format.
2830 Allowed values
2831 1 - v1 error format
2832 2 - v2 error format
2833
2834 Returns:
2835 An object of the form:
2836
2837 {
2838 &quot;kind&quot;: &quot;compute#routerStatusResponse&quot;, # Output only. Type of resource.
2839 &quot;result&quot;: {
2840 &quot;bestRoutes&quot;: [ # A list of the best dynamic routes for this Cloud Router&#x27;s Virtual Private
2841 # Cloud (VPC) network in the same region as this Cloud Router.
2842 #
2843 # Lists all of the best routes per prefix that are programmed into this
2844 # region&#x27;s VPC data plane.
2845 #
2846 # When global dynamic routing mode is turned on in the VPC network, this list
2847 # can include cross-region dynamic routes from Cloud Routers in other
2848 # regions.
2849 { # Represents a Route resource.
2850 #
2851 # A route defines a path from VM instances in the VPC network to a specific
2852 # destination. This destination can be inside or outside the VPC network.
2853 # For more information, read theRoutes overview.
2854 &quot;allowConflictingSubnetworks&quot;: True or False, # Whether this route can conflict with existing subnetworks. Setting this to
2855 # true allows this route to conflict with subnetworks that have already been
2856 # configured on the corresponding network.
2857 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
2858 {
2859 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
2860 42,
2861 ],
2862 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
2863 # values:
2864 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
2865 # in has traversed
2866 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
2867 # systems that the route has traversed
2868 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
2869 # ordered set of Member Autonomous Systems in the local confederation that
2870 # the route has traversed
2871 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
2872 # Member Autonomous Systems in the local confederation that the route has
2873 # traversed
2874 },
2875 ],
2876 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2877 # text format.
2878 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
2879 # create the resource.
2880 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
2881 # IPv4 and IPv6 are supported.
2882 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
2883 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
2884 # compressed format.
2885 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2886 # defined by the server.
2887 &quot;ilbRouteBehaviorOnUnhealthy&quot;: &quot;A String&quot;, # ILB route behavior when ILB is deemed unhealthy based on user specified
2888 # threshold on the Backend Service of the internal load balancing.
2889 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
2890 # Route resources.
2891 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2892 # The name must be 1-63 characters long, and comply withRFC1035.
2893 # Specifically, the name must be 1-63 characters long and match the regular
2894 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
2895 # lowercase letter, and all following characters (except for the last
2896 # character) must be a dash, lowercase letter, or digit. The last character
2897 # must be a lowercase letter or digit.
2898 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
2899 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
2900 # You can only specify the internet gateway using a full or
2901 # partial valid URL: projects/project/global/gateways/default-internet-gateway
2902 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
2903 # that will handle matching packets.
2904 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
2905 # packets or the IP address of the forwarding Rule.
2906 # For example, the following are all valid URLs:
2907 #
2908 #
2909 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2910 # - regions/region/forwardingRules/forwardingRule
2911 #
2912 #
2913 # If an IP address is provided, must specify an IPv4 address in dot-decimal
2914 # notation or an IPv6 address in RFC 4291 format. For example, the following
2915 # are all valid IP addresses:
2916 #
2917 #
2918 # - 10.128.0.56
2919 # - 2001:db8::2d9:51:0:0
2920 # - 2001:db8:0:0:2d9:51:0:0
2921 #
2922 #
2923 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
2924 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
2925 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
2926 # this as a full or partial URL.
2927 # For example:
2928 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
2929 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
2930 # calculates based on factors such as network performance, distance, and
2931 # available bandwidth between regions.
2932 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
2933 # for the route.
2934 # This field will only be populated for dynamic routes generated by
2935 # Cloud Router with a linked interconnectAttachment or the static route
2936 # generated by each L2 Interconnect Attachment.
2937 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
2938 # Both IPv6 address and IPv4 addresses are supported.
2939 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
2940 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
2941 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
2942 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
2943 # IPv4-mapped IPv6 address.
2944 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
2945 # the desirability of a particular route in a network.
2946 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
2947 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
2948 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
2949 # or INCOMPLETE.
2950 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
2951 # which should conform to RFC1035.
2952 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
2953 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2954 # as part of resource payload.
2955 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2956 # Tag keys and values have the same definition as resource
2957 # manager tags. The field is allowed for INSERT
2958 # only. The keys/values to set on the resource should be specified in
2959 # either ID { : } or Namespaced format
2960 # { : }.
2961 # For example the following are valid inputs:
2962 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2963 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2964 # Note:
2965 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2966 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2967 &quot;a_key&quot;: &quot;A String&quot;,
2968 },
2969 },
2970 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
2971 # where there is more than one matching route of equal prefix length. In
2972 # cases where multiple routes have equal prefix length, the one with the
2973 # lowest-numbered priority value wins. The default value is `1000`. The
2974 # priority value must be from `0` to `65535`, inclusive.
2975 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
2976 # dynamic routes learned by Cloud Routers. It is also applicable to routes
2977 # undergoing migration.
2978 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
2979 # values:
2980 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
2981 # another Cloud Router and will readvertise to one of its BGP peers
2982 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
2983 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
2984 # - &#x27;STATIC&#x27; for a static route
2985 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
2986 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2987 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
2988 &quot;A String&quot;,
2989 ],
2990 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
2991 # route, this field will be populated with warning messages.
2992 {
2993 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2994 # Engine returns NO_RESULTS_ON_PAGE if there
2995 # are no results in the response.
2996 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2997 # value format. For example:
2998 #
2999 # &quot;data&quot;: [
3000 # {
3001 # &quot;key&quot;: &quot;scope&quot;,
3002 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3003 # }
3004 {
3005 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3006 # returned. For example, for warnings where there are no results in a list
3007 # request for a particular zone, this key might be scope and
3008 # the key value might be the zone name. Other examples might be a key
3009 # indicating a deprecated resource and a suggested replacement, or a
3010 # warning about invalid network settings (for example, if an instance
3011 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3012 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3013 },
3014 ],
3015 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3016 },
3017 ],
3018 },
3019 ],
3020 &quot;bestRoutesForRouter&quot;: [ # A list of the best BGP routes learned by this Cloud Router.
3021 #
3022 # It is possible that routes listed might not be programmed into the data
3023 # plane, if the Google Cloud control plane finds a more optimal route for a
3024 # prefix than a route learned by this Cloud Router.
3025 { # Represents a Route resource.
3026 #
3027 # A route defines a path from VM instances in the VPC network to a specific
3028 # destination. This destination can be inside or outside the VPC network.
3029 # For more information, read theRoutes overview.
3030 &quot;allowConflictingSubnetworks&quot;: True or False, # Whether this route can conflict with existing subnetworks. Setting this to
3031 # true allows this route to conflict with subnetworks that have already been
3032 # configured on the corresponding network.
3033 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
3034 {
3035 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
3036 42,
3037 ],
3038 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
3039 # values:
3040 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
3041 # in has traversed
3042 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
3043 # systems that the route has traversed
3044 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
3045 # ordered set of Member Autonomous Systems in the local confederation that
3046 # the route has traversed
3047 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
3048 # Member Autonomous Systems in the local confederation that the route has
3049 # traversed
3050 },
3051 ],
3052 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3053 # text format.
3054 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
3055 # create the resource.
3056 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
3057 # IPv4 and IPv6 are supported.
3058 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
3059 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
3060 # compressed format.
3061 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3062 # defined by the server.
3063 &quot;ilbRouteBehaviorOnUnhealthy&quot;: &quot;A String&quot;, # ILB route behavior when ILB is deemed unhealthy based on user specified
3064 # threshold on the Backend Service of the internal load balancing.
3065 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
3066 # Route resources.
3067 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3068 # The name must be 1-63 characters long, and comply withRFC1035.
3069 # Specifically, the name must be 1-63 characters long and match the regular
3070 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
3071 # lowercase letter, and all following characters (except for the last
3072 # character) must be a dash, lowercase letter, or digit. The last character
3073 # must be a lowercase letter or digit.
3074 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
3075 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
3076 # You can only specify the internet gateway using a full or
3077 # partial valid URL: projects/project/global/gateways/default-internet-gateway
3078 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
3079 # that will handle matching packets.
3080 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
3081 # packets or the IP address of the forwarding Rule.
3082 # For example, the following are all valid URLs:
3083 #
3084 #
3085 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3086 # - regions/region/forwardingRules/forwardingRule
3087 #
3088 #
3089 # If an IP address is provided, must specify an IPv4 address in dot-decimal
3090 # notation or an IPv6 address in RFC 4291 format. For example, the following
3091 # are all valid IP addresses:
3092 #
3093 #
3094 # - 10.128.0.56
3095 # - 2001:db8::2d9:51:0:0
3096 # - 2001:db8:0:0:2d9:51:0:0
3097 #
3098 #
3099 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
3100 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
3101 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
3102 # this as a full or partial URL.
3103 # For example:
3104 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
3105 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
3106 # calculates based on factors such as network performance, distance, and
3107 # available bandwidth between regions.
3108 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
3109 # for the route.
3110 # This field will only be populated for dynamic routes generated by
3111 # Cloud Router with a linked interconnectAttachment or the static route
3112 # generated by each L2 Interconnect Attachment.
3113 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
3114 # Both IPv6 address and IPv4 addresses are supported.
3115 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
3116 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
3117 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
3118 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
3119 # IPv4-mapped IPv6 address.
3120 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
3121 # the desirability of a particular route in a network.
3122 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
3123 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
3124 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
3125 # or INCOMPLETE.
3126 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
3127 # which should conform to RFC1035.
3128 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
3129 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3130 # as part of resource payload.
3131 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3132 # Tag keys and values have the same definition as resource
3133 # manager tags. The field is allowed for INSERT
3134 # only. The keys/values to set on the resource should be specified in
3135 # either ID { : } or Namespaced format
3136 # { : }.
3137 # For example the following are valid inputs:
3138 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3139 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3140 # Note:
3141 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3142 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3143 &quot;a_key&quot;: &quot;A String&quot;,
3144 },
3145 },
3146 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
3147 # where there is more than one matching route of equal prefix length. In
3148 # cases where multiple routes have equal prefix length, the one with the
3149 # lowest-numbered priority value wins. The default value is `1000`. The
3150 # priority value must be from `0` to `65535`, inclusive.
3151 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
3152 # dynamic routes learned by Cloud Routers. It is also applicable to routes
3153 # undergoing migration.
3154 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
3155 # values:
3156 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
3157 # another Cloud Router and will readvertise to one of its BGP peers
3158 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
3159 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
3160 # - &#x27;STATIC&#x27; for a static route
3161 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
3162 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3163 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
3164 &quot;A String&quot;,
3165 ],
3166 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
3167 # route, this field will be populated with warning messages.
3168 {
3169 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3170 # Engine returns NO_RESULTS_ON_PAGE if there
3171 # are no results in the response.
3172 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3173 # value format. For example:
3174 #
3175 # &quot;data&quot;: [
3176 # {
3177 # &quot;key&quot;: &quot;scope&quot;,
3178 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3179 # }
3180 {
3181 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3182 # returned. For example, for warnings where there are no results in a list
3183 # request for a particular zone, this key might be scope and
3184 # the key value might be the zone name. Other examples might be a key
3185 # indicating a deprecated resource and a suggested replacement, or a
3186 # warning about invalid network settings (for example, if an instance
3187 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3188 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3189 },
3190 ],
3191 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3192 },
3193 ],
3194 },
3195 ],
3196 &quot;bgpPeerStatus&quot;: [
3197 {
3198 &quot;advertisedRoutes&quot;: [ # Routes that were advertised to the remote BGP peer
3199 { # Represents a Route resource.
3200 #
3201 # A route defines a path from VM instances in the VPC network to a specific
3202 # destination. This destination can be inside or outside the VPC network.
3203 # For more information, read theRoutes overview.
3204 &quot;allowConflictingSubnetworks&quot;: True or False, # Whether this route can conflict with existing subnetworks. Setting this to
3205 # true allows this route to conflict with subnetworks that have already been
3206 # configured on the corresponding network.
3207 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
3208 {
3209 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
3210 42,
3211 ],
3212 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
3213 # values:
3214 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
3215 # in has traversed
3216 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
3217 # systems that the route has traversed
3218 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
3219 # ordered set of Member Autonomous Systems in the local confederation that
3220 # the route has traversed
3221 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
3222 # Member Autonomous Systems in the local confederation that the route has
3223 # traversed
3224 },
3225 ],
3226 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3227 # text format.
3228 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
3229 # create the resource.
3230 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
3231 # IPv4 and IPv6 are supported.
3232 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
3233 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
3234 # compressed format.
3235 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3236 # defined by the server.
3237 &quot;ilbRouteBehaviorOnUnhealthy&quot;: &quot;A String&quot;, # ILB route behavior when ILB is deemed unhealthy based on user specified
3238 # threshold on the Backend Service of the internal load balancing.
3239 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
3240 # Route resources.
3241 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3242 # The name must be 1-63 characters long, and comply withRFC1035.
3243 # Specifically, the name must be 1-63 characters long and match the regular
3244 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
3245 # lowercase letter, and all following characters (except for the last
3246 # character) must be a dash, lowercase letter, or digit. The last character
3247 # must be a lowercase letter or digit.
3248 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
3249 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
3250 # You can only specify the internet gateway using a full or
3251 # partial valid URL: projects/project/global/gateways/default-internet-gateway
3252 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
3253 # that will handle matching packets.
3254 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
3255 # packets or the IP address of the forwarding Rule.
3256 # For example, the following are all valid URLs:
3257 #
3258 #
3259 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3260 # - regions/region/forwardingRules/forwardingRule
3261 #
3262 #
3263 # If an IP address is provided, must specify an IPv4 address in dot-decimal
3264 # notation or an IPv6 address in RFC 4291 format. For example, the following
3265 # are all valid IP addresses:
3266 #
3267 #
3268 # - 10.128.0.56
3269 # - 2001:db8::2d9:51:0:0
3270 # - 2001:db8:0:0:2d9:51:0:0
3271 #
3272 #
3273 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
3274 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
3275 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
3276 # this as a full or partial URL.
3277 # For example:
3278 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
3279 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
3280 # calculates based on factors such as network performance, distance, and
3281 # available bandwidth between regions.
3282 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
3283 # for the route.
3284 # This field will only be populated for dynamic routes generated by
3285 # Cloud Router with a linked interconnectAttachment or the static route
3286 # generated by each L2 Interconnect Attachment.
3287 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
3288 # Both IPv6 address and IPv4 addresses are supported.
3289 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
3290 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
3291 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
3292 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
3293 # IPv4-mapped IPv6 address.
3294 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
3295 # the desirability of a particular route in a network.
3296 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
3297 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
3298 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
3299 # or INCOMPLETE.
3300 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
3301 # which should conform to RFC1035.
3302 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
3303 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3304 # as part of resource payload.
3305 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3306 # Tag keys and values have the same definition as resource
3307 # manager tags. The field is allowed for INSERT
3308 # only. The keys/values to set on the resource should be specified in
3309 # either ID { : } or Namespaced format
3310 # { : }.
3311 # For example the following are valid inputs:
3312 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3313 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3314 # Note:
3315 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3316 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3317 &quot;a_key&quot;: &quot;A String&quot;,
3318 },
3319 },
3320 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
3321 # where there is more than one matching route of equal prefix length. In
3322 # cases where multiple routes have equal prefix length, the one with the
3323 # lowest-numbered priority value wins. The default value is `1000`. The
3324 # priority value must be from `0` to `65535`, inclusive.
3325 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
3326 # dynamic routes learned by Cloud Routers. It is also applicable to routes
3327 # undergoing migration.
3328 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
3329 # values:
3330 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
3331 # another Cloud Router and will readvertise to one of its BGP peers
3332 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
3333 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
3334 # - &#x27;STATIC&#x27; for a static route
3335 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
3336 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3337 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
3338 &quot;A String&quot;,
3339 ],
3340 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
3341 # route, this field will be populated with warning messages.
3342 {
3343 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3344 # Engine returns NO_RESULTS_ON_PAGE if there
3345 # are no results in the response.
3346 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3347 # value format. For example:
3348 #
3349 # &quot;data&quot;: [
3350 # {
3351 # &quot;key&quot;: &quot;scope&quot;,
3352 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3353 # }
3354 {
3355 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3356 # returned. For example, for warnings where there are no results in a list
3357 # request for a particular zone, this key might be scope and
3358 # the key value might be the zone name. Other examples might be a key
3359 # indicating a deprecated resource and a suggested replacement, or a
3360 # warning about invalid network settings (for example, if an instance
3361 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3362 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3363 },
3364 ],
3365 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3366 },
3367 ],
3368 },
3369 ],
3370 &quot;bfdStatus&quot;: { # Next free: 15
3371 &quot;bfdSessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
3372 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
3373 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
3374 # peer router to initiate the BFD session for this BGP peer. If set to
3375 # DISABLED, BFD is disabled for this BGP peer.
3376 &quot;configUpdateTimestampMicros&quot;: &quot;A String&quot;, # Unix timestamp of the most recent config update.
3377 &quot;controlPacketCounts&quot;: { # Control packet counts for the current BFD session.
3378 &quot;numRx&quot;: 42, # Number of packets received since the beginning of the current BFD
3379 # session.
3380 &quot;numRxRejected&quot;: 42, # Number of packets received that were rejected because of errors since the
3381 # beginning of the current BFD session.
3382 &quot;numRxSuccessful&quot;: 42, # Number of packets received that were successfully processed since the
3383 # beginning of the current BFD session.
3384 &quot;numTx&quot;: 42, # Number of packets transmitted since the beginning of the current BFD
3385 # session.
3386 },
3387 &quot;controlPacketIntervals&quot;: [ # Inter-packet time interval statistics for control packets.
3388 { # Next free: 7
3389 &quot;avgMs&quot;: &quot;A String&quot;, # Average observed inter-packet interval in milliseconds.
3390 &quot;duration&quot;: &quot;A String&quot;, # From how long ago in the past these intervals were observed.
3391 &quot;maxMs&quot;: &quot;A String&quot;, # Maximum observed inter-packet interval in milliseconds.
3392 &quot;minMs&quot;: &quot;A String&quot;, # Minimum observed inter-packet interval in milliseconds.
3393 &quot;numIntervals&quot;: &quot;A String&quot;, # Number of inter-packet intervals from which these statistics were derived.
3394 &quot;type&quot;: &quot;A String&quot;, # The type of packets for which inter-packet intervals were computed.
3395 },
3396 ],
3397 &quot;echoPacketCounts&quot;: { # Echo packet counts for the current BFD session.
3398 &quot;numRx&quot;: 42, # Number of packets received since the beginning of the current BFD
3399 # session.
3400 &quot;numRxRejected&quot;: 42, # Number of packets received that were rejected because of errors since the
3401 # beginning of the current BFD session.
3402 &quot;numRxSuccessful&quot;: 42, # Number of packets received that were successfully processed since the
3403 # beginning of the current BFD session.
3404 &quot;numTx&quot;: 42, # Number of packets transmitted since the beginning of the current BFD
3405 # session.
3406 },
3407 &quot;echoPacketIntervals&quot;: [ # Inter-packet time interval statistics for echo packets.
3408 { # Next free: 7
3409 &quot;avgMs&quot;: &quot;A String&quot;, # Average observed inter-packet interval in milliseconds.
3410 &quot;duration&quot;: &quot;A String&quot;, # From how long ago in the past these intervals were observed.
3411 &quot;maxMs&quot;: &quot;A String&quot;, # Maximum observed inter-packet interval in milliseconds.
3412 &quot;minMs&quot;: &quot;A String&quot;, # Minimum observed inter-packet interval in milliseconds.
3413 &quot;numIntervals&quot;: &quot;A String&quot;, # Number of inter-packet intervals from which these statistics were derived.
3414 &quot;type&quot;: &quot;A String&quot;, # The type of packets for which inter-packet intervals were computed.
3415 },
3416 ],
3417 &quot;localDiagnostic&quot;: &quot;A String&quot;, # The diagnostic code specifies the local system&#x27;s reason for the last change
3418 # in session state. This allows remote systems to determine the reason that
3419 # the previous session failed, for example. These diagnostic codes are
3420 # specified in section 4.1 ofRFC5880
3421 &quot;localState&quot;: &quot;A String&quot;, # The current BFD session state as seen by the transmitting system. These
3422 # states are specified in section 4.1 ofRFC5880
3423 &quot;negotiatedLocalControlTxIntervalMs&quot;: 42, # Negotiated transmit interval for control packets.
3424 &quot;negotiatedLocalEchoTxIntervalMs&quot;: 42, # Negotiated transmit interval for echo packets.
3425 &quot;rxPacket&quot;: { # The most recent Rx control packet for this BFD session.
3426 &quot;authenticationPresent&quot;: True or False, # The Authentication Present bit of the BFD packet. This is specified in
3427 # section 4.1 ofRFC5880
3428 &quot;controlPlaneIndependent&quot;: True or False, # The Control Plane Independent bit of the BFD packet. This is specified in
3429 # section 4.1 ofRFC5880
3430 &quot;demand&quot;: True or False, # The demand bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3431 &quot;diagnostic&quot;: &quot;A String&quot;, # The diagnostic code specifies the local system&#x27;s reason for the last change
3432 # in session state. This allows remote systems to determine the reason that
3433 # the previous session failed, for example. These diagnostic codes are
3434 # specified in section 4.1 ofRFC5880
3435 &quot;final&quot;: True or False, # The Final bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3436 &quot;length&quot;: 42, # The length of the BFD Control packet in bytes. This is specified in section
3437 # 4.1 ofRFC5880
3438 &quot;minEchoRxIntervalMs&quot;: 42, # The Required Min Echo RX Interval value in the BFD packet. This is
3439 # specified in section 4.1 ofRFC5880
3440 &quot;minRxIntervalMs&quot;: 42, # The Required Min RX Interval value in the BFD packet. This is specified in
3441 # section 4.1 ofRFC5880
3442 &quot;minTxIntervalMs&quot;: 42, # The Desired Min TX Interval value in the BFD packet. This is specified in
3443 # section 4.1 ofRFC5880
3444 &quot;multiplier&quot;: 42, # The detection time multiplier of the BFD packet. This is specified in
3445 # section 4.1 ofRFC5880
3446 &quot;multipoint&quot;: True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3447 &quot;myDiscriminator&quot;: 42, # The My Discriminator value in the BFD packet. This is specified in section
3448 # 4.1 ofRFC5880
3449 &quot;poll&quot;: True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3450 &quot;state&quot;: &quot;A String&quot;, # The current BFD session state as seen by the transmitting system. These
3451 # states are specified in section 4.1 ofRFC5880
3452 &quot;version&quot;: 42, # The version number of the BFD protocol, as specified in section 4.1 ofRFC5880.
3453 &quot;yourDiscriminator&quot;: 42, # The Your Discriminator value in the BFD packet. This is specified in
3454 # section 4.1 ofRFC5880
3455 },
3456 &quot;txPacket&quot;: { # The most recent Tx control packet for this BFD session.
3457 &quot;authenticationPresent&quot;: True or False, # The Authentication Present bit of the BFD packet. This is specified in
3458 # section 4.1 ofRFC5880
3459 &quot;controlPlaneIndependent&quot;: True or False, # The Control Plane Independent bit of the BFD packet. This is specified in
3460 # section 4.1 ofRFC5880
3461 &quot;demand&quot;: True or False, # The demand bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3462 &quot;diagnostic&quot;: &quot;A String&quot;, # The diagnostic code specifies the local system&#x27;s reason for the last change
3463 # in session state. This allows remote systems to determine the reason that
3464 # the previous session failed, for example. These diagnostic codes are
3465 # specified in section 4.1 ofRFC5880
3466 &quot;final&quot;: True or False, # The Final bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3467 &quot;length&quot;: 42, # The length of the BFD Control packet in bytes. This is specified in section
3468 # 4.1 ofRFC5880
3469 &quot;minEchoRxIntervalMs&quot;: 42, # The Required Min Echo RX Interval value in the BFD packet. This is
3470 # specified in section 4.1 ofRFC5880
3471 &quot;minRxIntervalMs&quot;: 42, # The Required Min RX Interval value in the BFD packet. This is specified in
3472 # section 4.1 ofRFC5880
3473 &quot;minTxIntervalMs&quot;: 42, # The Desired Min TX Interval value in the BFD packet. This is specified in
3474 # section 4.1 ofRFC5880
3475 &quot;multiplier&quot;: 42, # The detection time multiplier of the BFD packet. This is specified in
3476 # section 4.1 ofRFC5880
3477 &quot;multipoint&quot;: True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3478 &quot;myDiscriminator&quot;: 42, # The My Discriminator value in the BFD packet. This is specified in section
3479 # 4.1 ofRFC5880
3480 &quot;poll&quot;: True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3481 &quot;state&quot;: &quot;A String&quot;, # The current BFD session state as seen by the transmitting system. These
3482 # states are specified in section 4.1 ofRFC5880
3483 &quot;version&quot;: 42, # The version number of the BFD protocol, as specified in section 4.1 ofRFC5880.
3484 &quot;yourDiscriminator&quot;: 42, # The Your Discriminator value in the BFD packet. This is specified in
3485 # section 4.1 ofRFC5880
3486 },
3487 &quot;uptimeMs&quot;: &quot;A String&quot;, # Session uptime in milliseconds. Value will be 0 if session is not up.
3488 &quot;usingEchoMode&quot;: True or False, # Indicates if echo mode is currently being used.
3489 },
3490 &quot;enableIpv4&quot;: True or False, # Output only. Enable IPv4 traffic over BGP Peer.
3491 # It is enabled by default if the peerIpAddress is version 4.
3492 &quot;enableIpv6&quot;: True or False, # Output only. Enable IPv6 traffic over BGP Peer.
3493 # It is enabled by default if the peerIpAddress is version 6.
3494 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. IP address of the local BGP interface.
3495 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv4 address of the local BGP interface.
3496 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv6 address of the local BGP interface.
3497 &quot;linkedCustomHardware&quot;: &quot;A String&quot;, # Output only. The URI of the linked custom hardware resource,
3498 # CustomHardwareLinkAttachment. This CustomHardwareLinkAttachment resource
3499 # is the one that will establish the BGP session from the Cloud Router.
3500 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # Output only. URL of the VPN tunnel that this BGP peer controls.
3501 &quot;md5AuthEnabled&quot;: True or False, # Informs whether MD5 authentication is enabled on this BGP peer.
3502 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of this BGP peer. Unique within the Routers resource.
3503 &quot;numLearnedRoutes&quot;: 42, # Output only. Number of routes learned from the remote BGP Peer.
3504 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. IP address of the remote BGP interface.
3505 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv4 address of the remote BGP interface.
3506 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv6 address of the remote BGP interface.
3507 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # Output only. [Output only] URI of the VM instance that is used as third-party router
3508 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
3509 # Appliances.
3510 # The VM instance is the peer side of the BGP session.
3511 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the BGP session. For a list of possible values for this
3512 # field, seeBGP session states.
3513 &quot;status&quot;: &quot;A String&quot;, # Output only. Status of the BGP peer: {UP, DOWN}
3514 &quot;statusReason&quot;: &quot;A String&quot;, # Indicates why particular status was returned.
3515 &quot;uptime&quot;: &quot;A String&quot;, # Output only. Time this session has been up.
3516 # Format:
3517 # 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
3518 &quot;uptimeSeconds&quot;: &quot;A String&quot;, # Output only. Time this session has been up, in seconds.
3519 # Format:
3520 # 145
3521 },
3522 ],
3523 &quot;natStatus&quot;: [
3524 { # Status of a NAT contained in this router.
3525 &quot;autoAllocatedNatIps&quot;: [ # Output only. A list of IPs auto-allocated for NAT. Example: [&quot;1.1.1.1&quot;, &quot;129.2.16.89&quot;]
3526 &quot;A String&quot;,
3527 ],
3528 &quot;drainAutoAllocatedNatIps&quot;: [ # Output only. A list of IPs auto-allocated for NAT that are in drain mode.
3529 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3530 &quot;A String&quot;,
3531 ],
3532 &quot;drainUserAllocatedNatIps&quot;: [ # Output only. A list of IPs user-allocated for NAT that are in drain mode.
3533 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3534 &quot;A String&quot;,
3535 ],
3536 &quot;minExtraNatIpsNeeded&quot;: 42, # Output only. The number of extra IPs to allocate. This will be greater than 0 only if
3537 # user-specified IPs are NOT enough to allow all configured VMs to use NAT.
3538 # This value is meaningful only when auto-allocation of NAT IPs is *not*
3539 # used.
3540 &quot;name&quot;: &quot;A String&quot;, # Output only. Unique name of this NAT.
3541 &quot;numVmEndpointsWithNatMappings&quot;: 42, # Output only. Number of VM endpoints (i.e., Nics) that can use NAT.
3542 &quot;ruleStatus&quot;: [ # Status of rules in this NAT.
3543 { # Status of a NAT Rule contained in this NAT.
3544 &quot;activeNatIps&quot;: [ # Output only. A list of active IPs for NAT.
3545 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3546 &quot;A String&quot;,
3547 ],
3548 &quot;drainNatIps&quot;: [ # Output only. A list of IPs for NAT that are in drain mode.
3549 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3550 &quot;A String&quot;,
3551 ],
3552 &quot;minExtraIpsNeeded&quot;: 42, # Output only. The number of extra IPs to allocate. This will be greater than 0 only
3553 # if the existing IPs in this NAT Rule are NOT enough to allow all
3554 # configured VMs to use NAT.
3555 &quot;numVmEndpointsWithNatMappings&quot;: 42, # Output only. Number of VM endpoints (i.e., NICs) that have NAT Mappings from this
3556 # NAT Rule.
3557 &quot;ruleNumber&quot;: 42, # Output only. Rule number of the rule.
3558 },
3559 ],
3560 &quot;userAllocatedNatIpResources&quot;: [ # Output only. A list of fully qualified URLs of reserved IP address resources.
3561 &quot;A String&quot;,
3562 ],
3563 &quot;userAllocatedNatIps&quot;: [ # Output only. A list of IPs user-allocated for NAT.
3564 # They will be raw IP strings like &quot;179.12.26.133&quot;.
3565 &quot;A String&quot;,
3566 ],
3567 },
3568 ],
3569 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
3570 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
3571 },
3572 }</pre>
3573 </div>
3574
3575 <div class="method">
3576 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
3577 <pre>Creates a Router resource in the specified project and region using
3578 the data included in the request.
3579
3580 Args:
3581 project: string, Project ID for this request. (required)
3582 region: string, Name of the region for this request. (required)
3583 body: object, The request body.
3584 The object takes the form of:
3585
3586 { # Represents a Cloud Router resource.
3587 #
3588 # For more information about Cloud Router, read theCloud
3589 # Router overview.
3590 &quot;bgp&quot;: { # BGP information specific to this router.
3591 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
3592 # The options are DEFAULT or CUSTOM.
3593 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
3594 # This field can only be populated if advertise_mode is CUSTOM and
3595 # is advertised to all peers of the router.
3596 # These groups will be advertised in addition to any specified prefixes.
3597 # Leave this field blank to advertise no custom groups.
3598 &quot;A String&quot;,
3599 ],
3600 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
3601 # This field can only be populated if advertise_mode is CUSTOM and
3602 # is advertised to all peers of the router.
3603 # These IP ranges will be advertised in addition to any specified groups.
3604 # Leave this field blank to advertise no custom IP ranges.
3605 { # Description-tagged IP ranges for the router to advertise.
3606 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
3607 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
3608 },
3609 ],
3610 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
3611 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
3612 # value will be fixed for this router resource. All VPN tunnels that link
3613 # to this router will have the same local ASN.
3614 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
3615 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
3616 # least /30, even if the BGP sessions are over IPv6. It must not overlap
3617 # with any IPv4 BGP session ranges.
3618 #
3619 #
3620 # Other vendors commonly call this &quot;router ID&quot;.
3621 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
3622 # sent to the peer.
3623 #
3624 #
3625 # Hold time is three times the interval at which keepalive messages are
3626 # sent, and the hold time is the maximum number of seconds allowed to
3627 # elapse between successive keepalive messages that BGP receives from a
3628 # peer.
3629 #
3630 #
3631 # BGP will use the smaller of either the local hold time value or the
3632 # peer&#x27;s hold time value as the hold time for the BGP connection between
3633 # the two peers.
3634 #
3635 #
3636 # If set, this value must be between 20 and 60. The default is 20.
3637 },
3638 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
3639 # establish BGP peering. This information must specify the peer ASN and
3640 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
3641 {
3642 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
3643 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
3644 # which currently supports the following option:
3645 #
3646 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
3647 # excludes any routes learned for subnets that use
3648 # VPC Network Peering.
3649 #
3650 #
3651 # Note that this field can only be populated if advertise_mode is CUSTOM
3652 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
3653 # These groups are advertised in addition to any specified prefixes.
3654 # Leave this field blank to advertise no custom groups.
3655 &quot;A String&quot;,
3656 ],
3657 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
3658 # This field can only be populated if advertise_mode is CUSTOM and
3659 # overrides the list defined for the router (in the &quot;bgp&quot; message).
3660 # These IP ranges are advertised in addition to any specified groups.
3661 # Leave this field blank to advertise no custom IP ranges.
3662 { # Description-tagged IP ranges for the router to advertise.
3663 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
3664 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
3665 },
3666 ],
3667 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
3668 # than one matching route of maximum length, the routes with the lowest
3669 # priority value win.
3670 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
3671 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
3672 # received from the peer router. The actual value is negotiated between
3673 # the two routers and is equal to the greater of this value and the
3674 # transmit interval of the other router.
3675 #
3676 #
3677 # If set, this value must be between 1000 and 30000.
3678 #
3679 #
3680 # The default is 1000.
3681 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
3682 # transmitted to the peer router. The actual value is negotiated between
3683 # the two routers and is equal to the greater of this value and the
3684 # corresponding receive interval of the other router.
3685 #
3686 #
3687 # If set, this value must be between 1000 and 30000.
3688 #
3689 #
3690 # The default is 1000.
3691 &quot;mode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
3692 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
3693 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
3694 # peer router to initiate the BFD session for this BGP peer. If set to
3695 # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.
3696 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
3697 # before BFD declares that a peer is unavailable.
3698 #
3699 #
3700 # If set, the value must be a value between 5 and 16.
3701 #
3702 #
3703 # The default is 5.
3704 &quot;packetMode&quot;: &quot;A String&quot;, # The BFD packet mode for this BGP peer.
3705 # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer.
3706 # In this mode, if the peer router also has BFD echo mode enabled, BFD
3707 # echo packets will be sent to the other router. If the peer router does
3708 # not have BFD echo mode enabled, only control packets will be sent. If
3709 # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If
3710 # this router and the peer router have a multihop connection, this should
3711 # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop
3712 # connections. The default is CONTROL_AND_ECHO.
3713 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
3714 #
3715 #
3716 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
3717 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
3718 # peer router to initiate the BFD session for this BGP peer. If set to
3719 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
3720 &quot;slowTimerInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
3721 # transmitted to and received from the peer router when BFD echo mode is
3722 # enabled on both routers. The actual transmit and receive intervals are
3723 # negotiated between the two routers and are equal to the greater of this
3724 # value and the corresponding interval on the other router.
3725 # If set, this value must be between 1000 and 30000.
3726 # The default is 5000.
3727 },
3728 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
3729 # session.
3730 {
3731 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
3732 # CIDR-formatted prefix. If an IP address is provided without a subnet
3733 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
3734 # range, and, for IPv6, `/128`.
3735 },
3736 ],
3737 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
3738 # value is applied to all custom learned route ranges for the session.
3739 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
3740 # value, Google Cloud assigns a priority of `100` to the ranges.
3741 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
3742 #
3743 #
3744 # If set to FALSE, any active session with the peer is terminated and
3745 # all associated routing information is removed. If set to TRUE, the
3746 # peer connection can be established with routing information. The default
3747 # is TRUE.
3748 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
3749 # the peerIpAddress is version 4.
3750 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
3751 # peerIpAddress is version 6.
3752 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
3753 # evaluated. The name must correspond to an existing policy that has
3754 # ROUTE_POLICY_TYPE_EXPORT type.
3755 &quot;A String&quot;,
3756 ],
3757 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
3758 # evaluated. The name must correspond to an existing policy that has
3759 # ROUTE_POLICY_TYPE_IMPORT type.
3760 &quot;A String&quot;,
3761 ],
3762 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
3763 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
3764 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
3765 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
3766 &quot;linkedCustomHardware&quot;: &quot;A String&quot;, # The linked custom hardware resource.
3767 # The URI of the custom hardware link attachment
3768 # is where you will establish the BGP session from the Cloud Router.
3769 # This link attachment must reside in the same subnetwork as the associated
3770 # router interface.
3771 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
3772 #
3773 # - MANAGED_BY_USER is the default value and can be managed by you
3774 # or other users
3775 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
3776 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
3777 # PARTNER. Google automatically creates, updates, and deletes this type of
3778 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
3779 # or deleted.
3780 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
3781 # name of one of the entries in the Router.md5_authentication_keys. The
3782 # field must comply with RFC1035.
3783 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
3784 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
3785 # characters long and match the regular expression
3786 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
3787 # lowercase letter, and all following characters must be a dash, lowercase
3788 # letter, or digit, except the last character, which cannot be a dash.
3789 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
3790 # a different value.
3791 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
3792 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
3793 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
3794 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
3795 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
3796 # Appliances. The VM instance must be located in zones contained in the
3797 # same region as this Cloud Router.
3798 # The VM instance is the peer side of the BGP session.
3799 },
3800 ],
3801 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3802 # text format.
3803 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3804 # create the resource.
3805 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
3806 # attachments (interconnectAttachments).
3807 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
3808 # defined by the server.
3809 &quot;interfaces&quot;: [ # Router interfaces.
3810 # To create a BGP peer that uses a router interface,
3811 # the interface must have one of the following fields specified:
3812 #
3813 # - linkedVpnTunnel
3814 # - linkedInterconnectAttachment
3815 # - subnetwork
3816 #
3817 #
3818 # You can create a router interface without any of these fields specified.
3819 # However, you cannot create a BGP peer that uses that interface.
3820 {
3821 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
3822 #
3823 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
3824 # be a CIDR-formatted string, for example, 169.254.0.1/30.
3825 # Note: Do not truncate the IP address, as it represents the IP address of
3826 # the interface.
3827 # - For Internet Protocol version 6 (IPv6), the value
3828 # must be a unique local address (ULA) range from fdff:1::/64
3829 # with a mask length of 126 or less. This value should be a CIDR-formatted
3830 # string, for example, fdff:1::1/112. Within the router&#x27;s
3831 # VPC, this IPv6 prefix will be reserved exclusively for this connection
3832 # and cannot be used for any other purpose.
3833 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
3834 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
3835 # as the router. Each interface can have one linked resource, which can be
3836 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
3837 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
3838 # router. Each interface can have one linked resource, which can be
3839 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
3840 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
3841 #
3842 # - MANAGED_BY_USER is the default value and can be managed directly
3843 # by users.
3844 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
3845 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
3846 # of type PARTNER. Google automatically creates, updates, and deletes
3847 # this type of interface when the PARTNER InterconnectAttachment is
3848 # created, updated, or deleted.
3849 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
3850 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
3851 # characters long and match the regular expression
3852 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
3853 # lowercase letter, and all following characters must be a dash, lowercase
3854 # letter, or digit, except the last character, which cannot be a dash.
3855 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
3856 # BGP sessions to a VM instance acting as a third-party
3857 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
3858 # an SD-WAN VM.
3859 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
3860 # you are creating. The redundantInterface must belong to the same Cloud
3861 # Router as the interface here. To establish the BGP session to a Router
3862 # Appliance VM, you must create two BGP peers. The two BGP peers must be
3863 # attached to two separate interfaces that are redundant with each other.
3864 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
3865 # be 1-63 characters long and match the regular expression
3866 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
3867 # lowercase letter, and all following characters must be a dash, lowercase
3868 # letter, or digit, except the last character, which cannot be a dash.
3869 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
3870 # must be in the same region as the Cloud Router.
3871 # When you establish a BGP session to a VM instance using this interface,
3872 # the VM instance must belong to the same subnetwork as the subnetwork
3873 # specified here.
3874 },
3875 ],
3876 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
3877 # routers.
3878 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
3879 {
3880 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
3881 #
3882 # For patch and update calls, it can be skipped to
3883 # copy the value from the previous configuration. This is allowed if the
3884 # key with the same name existed before the operation. Maximum length is 80
3885 # characters. Can only contain printable ASCII characters.
3886 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
3887 #
3888 # Must be unique within a router. Must be referenced by exactly
3889 # one bgpPeer. Must comply withRFC1035.
3890 },
3891 ],
3892 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3893 # The name must be 1-63 characters long, and comply withRFC1035.
3894 # Specifically, the name must be 1-63 characters long and match the regular
3895 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3896 # character must be a lowercase letter, and all following characters must
3897 # be a dash, lowercase letter, or digit, except the last character, which
3898 # cannot be a dash.
3899 &quot;nats&quot;: [ # A list of NAT services created in this router.
3900 { # Represents a Nat resource. It enables the VMs within the specified
3901 # subnetworks to access Internet without external IP addresses. It specifies
3902 # a list of subnetworks (and the ranges within) that want to use NAT.
3903 # Customers can also provide the external IPs that would be used for NAT. GCP
3904 # would auto-allocate ephemeral IPs if no external IPs are provided.
3905 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
3906 # Must be one of: PREMIUM, STANDARD.
3907 # If not specified, then the current
3908 # project-level default tier is used.
3909 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
3910 # must be valid static external IPs that have been assigned to the NAT.
3911 # These IPs should be used for updating/patching a NAT only.
3912 &quot;A String&quot;,
3913 ],
3914 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
3915 # state. This value is equal to tcp_time_wait_timeout_sec.
3916 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
3917 # 120s. The field is output only.
3918 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
3919 #
3920 #
3921 # If not specified, it is disabled by default.
3922 #
3923 #
3924 # If set to true,
3925 #
3926 # - Dynamic Port Allocation will be enabled on this NAT
3927 # config.
3928 # - enableEndpointIndependentMapping cannot be set to true.
3929 # - If minPorts is set, minPortsPerVm must be set to a
3930 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
3931 # minimum of 32 ports will be allocated to a VM from this NAT
3932 # config.
3933 &quot;enableEndpointIndependentMapping&quot;: True or False,
3934 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
3935 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
3936 &quot;A String&quot;,
3937 ],
3938 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
3939 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
3940 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
3941 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
3942 # logs are exported for all connections handled by this NAT.
3943 # This option can take one of the following values:
3944 #
3945 # - ERRORS_ONLY: Export logs only for connection failures.
3946 # - TRANSLATIONS_ONLY: Export logs only for successful
3947 # connections.
3948 # - ALL: Export logs for all connections, successful and
3949 # unsuccessful.
3950 },
3951 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
3952 # Dynamic Port Allocation is enabled.
3953 #
3954 #
3955 # If Dynamic Port Allocation is not enabled, this field has no effect.
3956 #
3957 #
3958 # If Dynamic Port Allocation is enabled, and this field is set, it must be
3959 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
3960 # is not set.
3961 #
3962 #
3963 # If Dynamic Port Allocation is enabled and this field is not set,
3964 # a maximum of 65536 ports will be allocated to a VM from this NAT
3965 # config.
3966 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
3967 # set, a default number of ports is allocated to a VM. This is rounded
3968 # up to the nearest power of 2. For example, if the value of this field is
3969 # 50, at least 64 ports are allocated to a VM.
3970 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
3971 # The name must be 1-63 characters long and comply withRFC1035.
3972 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
3973 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
3974 # selected for the SubnetworkIpRangeToNat64Option above.
3975 { # Specifies a subnetwork to enable NAT64.
3976 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
3977 },
3978 ],
3979 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
3980 # values:
3981 #
3982 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
3983 # customers. When there are not enough specified Nat IPs, the Nat service
3984 # fails for new VMs.
3985 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
3986 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
3987 # be empty.
3988 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
3989 # addresses must be valid static external IP addresses assigned to the
3990 # project.
3991 &quot;A String&quot;,
3992 ],
3993 &quot;rules&quot;: [ # A list of rules associated with this NAT.
3994 {
3995 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
3996 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
3997 # addresses must be valid static external IP addresses assigned to the
3998 # project.
3999 # This field is used for public NAT.
4000 &quot;A String&quot;,
4001 ],
4002 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
4003 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
4004 # This field is used for private NAT.
4005 &quot;A String&quot;,
4006 ],
4007 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
4008 # must be valid static external IPs that have been assigned to the NAT.
4009 # These IPs should be used for updating/patching a NAT rule only.
4010 # This field is used for public NAT.
4011 &quot;A String&quot;,
4012 ],
4013 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
4014 # drained. This is only supported on patch/update, and these
4015 # subnetworks must have previously been used as active ranges in this
4016 # NAT Rule.
4017 # This field is used for private NAT.
4018 &quot;A String&quot;,
4019 ],
4020 },
4021 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
4022 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
4023 # from a VM is evaluated against. If it evaluates to true, the
4024 # corresponding `action` is enforced.
4025 #
4026 # The following examples are valid match expressions for public NAT:
4027 #
4028 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
4029 # &#x27;2.2.0.0/16&#x27;)`
4030 #
4031 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
4032 #
4033 # The following example is a valid match expression for private NAT:
4034 #
4035 # `nexthop.hub ==
4036 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
4037 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
4038 # must be a positive value between 0 and 65000, and
4039 # must be unique among rules within a NAT.
4040 &quot;sourceWorkloadIdentities&quot;: [ # A list of source workload identities.
4041 &quot;A String&quot;,
4042 ],
4043 },
4044 ],
4045 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
4046 #
4047 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
4048 # Subnetwork are allowed to Nat.
4049 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
4050 # in every Subnetwork are allowed to Nat.
4051 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
4052 # (specified in the field subnetwork below)
4053 #
4054 #
4055 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
4056 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
4057 # should not be any other Router.Nat section in any Router for this network
4058 # in this region.
4059 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
4060 # values:
4061 #
4062 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
4063 # every Subnetwork are allowed to Nat.
4064 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
4065 # (specified in the field nat64_subnetwork below)
4066 #
4067 #
4068 # The default is NAT64_OPTION_UNSPECIFIED.
4069 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
4070 # Router.Nat section in this region can also enable NAT64 for any
4071 # Subnetworks in this network. Other Router.Nat sections can still be
4072 # present to enable NAT44 only.
4073 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
4074 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
4075 # SubnetworkIpRangeToNatOption above.
4076 { # Defines the IP ranges that want to use NAT for a subnetwork.
4077 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
4078 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
4079 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
4080 # is one of the values in source_ip_ranges_to_nat.
4081 &quot;A String&quot;,
4082 ],
4083 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
4084 # options of a single value are valid except
4085 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
4086 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
4087 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
4088 # Default: [ALL_IP_RANGES]
4089 &quot;A String&quot;,
4090 ],
4091 },
4092 ],
4093 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
4094 # if not set.
4095 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
4096 # Defaults to 120s if not set.
4097 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
4098 # not set.
4099 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
4100 # translation. If unspecified, it defaults to PUBLIC.
4101 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
4102 },
4103 ],
4104 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
4105 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
4106 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
4107 # as part of resource payload.
4108 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
4109 # The field is allowed for INSERT
4110 # only. The keys/values to set on the resource should be specified in
4111 # either ID { : } or Namespaced format
4112 # { : }.
4113 # For example the following are valid inputs:
4114 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
4115 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
4116 # Note:
4117 # * Invalid combinations of ID &amp; namespaced format is not supported. For
4118 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
4119 # * Inconsistent format is not supported. For instance:
4120 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
4121 &quot;a_key&quot;: &quot;A String&quot;,
4122 },
4123 },
4124 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
4125 # You must specify this field as part of the HTTP request URL. It is
4126 # not settable as a field in the request body.
4127 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4128 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4129 }
4130
4131 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4132 that if you must retry your request, the server will know to ignore the
4133 request if it has already been completed.
4134
4135 For example, consider a situation where you make an initial request and
4136 the request times out. If you make the request again with the same
4137 request ID, the server can check if original operation with the same
4138 request ID was received, and if so, will ignore the second request. This
4139 prevents clients from accidentally creating duplicate commitments.
4140
4141 The request ID must be
4142 a valid UUID with the exception that zero UUID is not supported
4143 (00000000-0000-0000-0000-000000000000).
4144 x__xgafv: string, V1 error format.
4145 Allowed values
4146 1 - v1 error format
4147 2 - v2 error format
4148
4149 Returns:
4150 An object of the form:
4151
4152 { # Represents an Operation resource.
4153 #
4154 # Google Compute Engine has three Operation resources:
4155 #
4156 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4157 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4158 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4159 #
4160 # You can use an operation resource to manage asynchronous API requests.
4161 # For more information, readHandling
4162 # API responses.
4163 #
4164 # Operations can be global, regional or zonal.
4165 #
4166 # - For global operations, use the `globalOperations`
4167 # resource.
4168 # - For regional operations, use the
4169 # `regionOperations` resource.
4170 # - For zonal operations, use
4171 # the `zoneOperations` resource.
4172 #
4173 #
4174 #
4175 # For more information, read
4176 # Global, Regional, and Zonal Resources.
4177 #
4178 # Note that completed Operation resources have a limited
4179 # retention period.
4180 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4181 # Not present otherwise.
4182 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4183 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4184 # set when the operation is created.
4185 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4186 # text format.
4187 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4188 # this field will be populated.
4189 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4190 # operation.
4191 {
4192 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4193 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4194 # details. There is a set of defined message types to use for providing
4195 # details.The syntax depends on the error code. For example,
4196 # QuotaExceededInfo will have details when the error code is
4197 # QUOTA_EXCEEDED.
4198 {
4199 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4200 #
4201 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4202 # is not enabled:
4203 #
4204 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4205 # &quot;domain&quot;: &quot;googleapis.com&quot;
4206 # &quot;metadata&quot;: {
4207 # &quot;resource&quot;: &quot;projects/123&quot;,
4208 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4209 # }
4210 # }
4211 #
4212 # This response indicates that the pubsub.googleapis.com API is not enabled.
4213 #
4214 # Example of an error that is returned when attempting to create a Spanner
4215 # instance in a region that is out of stock:
4216 #
4217 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4218 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4219 # &quot;metadata&quot;: {
4220 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4221 # }
4222 # }
4223 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4224 # is typically the registered service name of the tool or product that
4225 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4226 # generated by some common infrastructure, the error domain must be a
4227 # globally unique value that identifies the infrastructure. For Google API
4228 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4229 &quot;metadatas&quot;: { # Additional structured details about this error.
4230 #
4231 # Keys must match a regular expression of `a-z+` but should
4232 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4233 # length. When identifying the current value of an exceeded limit, the units
4234 # should be contained in the key, not the value. For example, rather than
4235 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4236 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4237 # instances that can be created in a single (batch) request.
4238 &quot;a_key&quot;: &quot;A String&quot;,
4239 },
4240 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4241 # proximate cause of the error. Error reasons are unique within a particular
4242 # domain of errors. This should be at most 63 characters and match a
4243 # regular expression of `A-Z+[A-Z0-9]`, which represents
4244 # UPPER_SNAKE_CASE.
4245 },
4246 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4247 #
4248 # For example, if a quota check failed with an error indicating the calling
4249 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4250 # directly to the right place in the developer console to flip the bit.
4251 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4252 { # Describes a URL link.
4253 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4254 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4255 },
4256 ],
4257 },
4258 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4259 # which can be attached to an RPC error.
4260 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4261 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4262 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4263 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4264 },
4265 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4266 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4267 &quot;a_key&quot;: &quot;A String&quot;,
4268 },
4269 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4270 # type or metric.
4271 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4272 # or metric.
4273 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4274 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4275 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4276 },
4277 },
4278 ],
4279 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4280 # This property is optional.
4281 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4282 },
4283 ],
4284 },
4285 &quot;getVersionOperationMetadata&quot;: {
4286 &quot;inlineSbomInfo&quot;: {
4287 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4288 # appropriate identifiers.
4289 &quot;a_key&quot;: &quot;A String&quot;,
4290 },
4291 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4292 # identifiers.
4293 &quot;a_key&quot;: &quot;A String&quot;,
4294 },
4295 },
4296 },
4297 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4298 # message that was returned, such as `NOT FOUND`.
4299 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4300 # status code that was returned. For example, a `404` means the
4301 # resource was not found.
4302 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4303 # defined by the server.
4304 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4305 # This value is inRFC3339
4306 # text format.
4307 &quot;instancesBulkInsertOperationMetadata&quot;: {
4308 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4309 # Example key: zones/us-central1-a
4310 &quot;a_key&quot;: {
4311 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4312 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4313 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4314 # error.
4315 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4316 # if the flow is rolling forward or rolling back.
4317 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4318 },
4319 },
4320 },
4321 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4322 # Operation resources.
4323 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4324 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4325 # group of operations results from a `bulkInsert` API request.
4326 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4327 # `update`, or `delete`, and so on.
4328 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4329 # There is no requirement that this be linear or support any granularity of
4330 # operations. This should not be used to guess when the operation will be
4331 # complete. This number should monotonically increase as the operation
4332 # progresses.
4333 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4334 # applicable when performing regional operations.
4335 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4336 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4337 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4338 # this field will contain information on all underlying zonal actions and
4339 # their state.
4340 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4341 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4342 # Example key: zones/us-central1-a
4343 &quot;a_key&quot;: {
4344 &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
4345 # populated.
4346 # different programming environments, including REST APIs and RPC APIs. It is
4347 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4348 # three pieces of data: error code, error message, and error details.
4349 #
4350 # You can find out more about this error model and how to work with it in the
4351 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4352 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4353 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4354 # message types for APIs to use.
4355 {
4356 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4357 },
4358 ],
4359 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4360 # user-facing error message should be localized and sent in the
4361 # google.rpc.Status.details field, or localized by the client.
4362 },
4363 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4364 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4365 },
4366 },
4367 },
4368 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4369 # This value is inRFC3339
4370 # text format.
4371 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4372 # following:
4373 # `PENDING`, `RUNNING`, or `DONE`.
4374 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4375 # operation.
4376 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4377 # of the target resource.
4378 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4379 # operations related to creating a snapshot, this points to the disk
4380 # that the snapshot was created from.
4381 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4382 # `[email protected]` or
4383 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4384 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4385 # operation, this field will be populated.
4386 {
4387 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4388 # Engine returns NO_RESULTS_ON_PAGE if there
4389 # are no results in the response.
4390 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4391 # value format. For example:
4392 #
4393 # &quot;data&quot;: [
4394 # {
4395 # &quot;key&quot;: &quot;scope&quot;,
4396 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4397 # }
4398 {
4399 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4400 # returned. For example, for warnings where there are no results in a list
4401 # request for a particular zone, this key might be scope and
4402 # the key value might be the zone name. Other examples might be a key
4403 # indicating a deprecated resource and a suggested replacement, or a
4404 # warning about invalid network settings (for example, if an instance
4405 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4406 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4407 },
4408 ],
4409 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4410 },
4411 ],
4412 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4413 # applicable when performing per-zone operations.
4414 }</pre>
4415 </div>
4416
4417 <div class="method">
4418 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4419 <pre>Retrieves a list of Router resources available to the specified project.
4420
4421 Args:
4422 project: string, Project ID for this request. (required)
4423 region: string, Name of the region for this request. (required)
4424 filter: string, A filter expression that filters resources listed in the response. Most
4425 Compute resources support two types of filter expressions:
4426 expressions that support regular expressions and expressions that follow
4427 API improvement proposal AIP-160.
4428 These two types of filter expressions cannot be mixed in one request.
4429
4430 If you want to use AIP-160, your expression must specify the field name, an
4431 operator, and the value that you want to use for filtering. The value
4432 must be a string, a number, or a boolean. The operator
4433 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4434
4435 For example, if you are filtering Compute Engine instances, you can
4436 exclude instances named `example-instance` by specifying
4437 `name != example-instance`.
4438
4439 The `:*` comparison can be used to test whether a key has been defined.
4440 For example, to find all objects with `owner` label use:
4441 ```
4442 labels.owner:*
4443 ```
4444
4445 You can also filter nested fields. For example, you could specify
4446 `scheduling.automaticRestart = false` to include instances only
4447 if they are not scheduled for automatic restarts. You can use filtering
4448 on nested fields to filter based onresource labels.
4449
4450 To filter on multiple expressions, provide each separate expression within
4451 parentheses. For example:
4452 ```
4453 (scheduling.automaticRestart = true)
4454 (cpuPlatform = &quot;Intel Skylake&quot;)
4455 ```
4456 By default, each expression is an `AND` expression. However, you
4457 can include `AND` and `OR` expressions explicitly.
4458 For example:
4459 ```
4460 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4461 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4462 (scheduling.automaticRestart = true)
4463 ```
4464
4465 If you want to use a regular expression, use the `eq` (equal) or `ne`
4466 (not equal) operator against a single un-parenthesized expression with or
4467 without quotes or against multiple parenthesized expressions. Examples:
4468
4469 `fieldname eq unquoted literal`
4470 `fieldname eq &#x27;single quoted literal&#x27;`
4471 `fieldname eq &quot;double quoted literal&quot;`
4472 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4473
4474 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4475 The literal value must match the entire field.
4476
4477 For example, to filter for instances that do not end with name &quot;instance&quot;,
4478 you would use `name ne .*instance`.
4479
4480 You cannot combine constraints on multiple fields using regular
4481 expressions.
4482 maxResults: integer, The maximum number of results per page that should be returned.
4483 If the number of available results is larger than `maxResults`,
4484 Compute Engine returns a `nextPageToken` that can be used to get
4485 the next page of results in subsequent list requests. Acceptable values are
4486 `0` to `500`, inclusive. (Default: `500`)
4487 orderBy: string, Sorts list results by a certain order. By default, results
4488 are returned in alphanumerical order based on the resource name.
4489
4490 You can also sort results in descending order based on the creation
4491 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4492 results based on the `creationTimestamp` field in
4493 reverse chronological order (newest result first). Use this to sort
4494 resources like operations so that the newest operation is returned first.
4495
4496 Currently, only sorting by `name` or
4497 `creationTimestamp desc` is supported.
4498 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4499 `nextPageToken` returned by a previous list request to get
4500 the next page of results.
4501 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4502 of failure. The default value is false.
4503
4504 For example, when partial success behavior is enabled, aggregatedList for a
4505 single zone scope either returns all resources in the zone or no resources,
4506 with an error code.
4507 x__xgafv: string, V1 error format.
4508 Allowed values
4509 1 - v1 error format
4510 2 - v2 error format
4511
4512 Returns:
4513 An object of the form:
4514
4515 { # Contains a list of Router resources.
4516 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4517 &quot;items&quot;: [ # A list of Router resources.
4518 { # Represents a Cloud Router resource.
4519 #
4520 # For more information about Cloud Router, read theCloud
4521 # Router overview.
4522 &quot;bgp&quot;: { # BGP information specific to this router.
4523 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
4524 # The options are DEFAULT or CUSTOM.
4525 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
4526 # This field can only be populated if advertise_mode is CUSTOM and
4527 # is advertised to all peers of the router.
4528 # These groups will be advertised in addition to any specified prefixes.
4529 # Leave this field blank to advertise no custom groups.
4530 &quot;A String&quot;,
4531 ],
4532 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
4533 # This field can only be populated if advertise_mode is CUSTOM and
4534 # is advertised to all peers of the router.
4535 # These IP ranges will be advertised in addition to any specified groups.
4536 # Leave this field blank to advertise no custom IP ranges.
4537 { # Description-tagged IP ranges for the router to advertise.
4538 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
4539 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
4540 },
4541 ],
4542 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
4543 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
4544 # value will be fixed for this router resource. All VPN tunnels that link
4545 # to this router will have the same local ASN.
4546 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
4547 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
4548 # least /30, even if the BGP sessions are over IPv6. It must not overlap
4549 # with any IPv4 BGP session ranges.
4550 #
4551 #
4552 # Other vendors commonly call this &quot;router ID&quot;.
4553 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
4554 # sent to the peer.
4555 #
4556 #
4557 # Hold time is three times the interval at which keepalive messages are
4558 # sent, and the hold time is the maximum number of seconds allowed to
4559 # elapse between successive keepalive messages that BGP receives from a
4560 # peer.
4561 #
4562 #
4563 # BGP will use the smaller of either the local hold time value or the
4564 # peer&#x27;s hold time value as the hold time for the BGP connection between
4565 # the two peers.
4566 #
4567 #
4568 # If set, this value must be between 20 and 60. The default is 20.
4569 },
4570 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
4571 # establish BGP peering. This information must specify the peer ASN and
4572 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
4573 {
4574 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
4575 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
4576 # which currently supports the following option:
4577 #
4578 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
4579 # excludes any routes learned for subnets that use
4580 # VPC Network Peering.
4581 #
4582 #
4583 # Note that this field can only be populated if advertise_mode is CUSTOM
4584 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
4585 # These groups are advertised in addition to any specified prefixes.
4586 # Leave this field blank to advertise no custom groups.
4587 &quot;A String&quot;,
4588 ],
4589 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
4590 # This field can only be populated if advertise_mode is CUSTOM and
4591 # overrides the list defined for the router (in the &quot;bgp&quot; message).
4592 # These IP ranges are advertised in addition to any specified groups.
4593 # Leave this field blank to advertise no custom IP ranges.
4594 { # Description-tagged IP ranges for the router to advertise.
4595 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
4596 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
4597 },
4598 ],
4599 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
4600 # than one matching route of maximum length, the routes with the lowest
4601 # priority value win.
4602 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
4603 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
4604 # received from the peer router. The actual value is negotiated between
4605 # the two routers and is equal to the greater of this value and the
4606 # transmit interval of the other router.
4607 #
4608 #
4609 # If set, this value must be between 1000 and 30000.
4610 #
4611 #
4612 # The default is 1000.
4613 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
4614 # transmitted to the peer router. The actual value is negotiated between
4615 # the two routers and is equal to the greater of this value and the
4616 # corresponding receive interval of the other router.
4617 #
4618 #
4619 # If set, this value must be between 1000 and 30000.
4620 #
4621 #
4622 # The default is 1000.
4623 &quot;mode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
4624 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
4625 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
4626 # peer router to initiate the BFD session for this BGP peer. If set to
4627 # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.
4628 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
4629 # before BFD declares that a peer is unavailable.
4630 #
4631 #
4632 # If set, the value must be a value between 5 and 16.
4633 #
4634 #
4635 # The default is 5.
4636 &quot;packetMode&quot;: &quot;A String&quot;, # The BFD packet mode for this BGP peer.
4637 # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer.
4638 # In this mode, if the peer router also has BFD echo mode enabled, BFD
4639 # echo packets will be sent to the other router. If the peer router does
4640 # not have BFD echo mode enabled, only control packets will be sent. If
4641 # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If
4642 # this router and the peer router have a multihop connection, this should
4643 # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop
4644 # connections. The default is CONTROL_AND_ECHO.
4645 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
4646 #
4647 #
4648 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
4649 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
4650 # peer router to initiate the BFD session for this BGP peer. If set to
4651 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
4652 &quot;slowTimerInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
4653 # transmitted to and received from the peer router when BFD echo mode is
4654 # enabled on both routers. The actual transmit and receive intervals are
4655 # negotiated between the two routers and are equal to the greater of this
4656 # value and the corresponding interval on the other router.
4657 # If set, this value must be between 1000 and 30000.
4658 # The default is 5000.
4659 },
4660 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
4661 # session.
4662 {
4663 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
4664 # CIDR-formatted prefix. If an IP address is provided without a subnet
4665 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
4666 # range, and, for IPv6, `/128`.
4667 },
4668 ],
4669 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
4670 # value is applied to all custom learned route ranges for the session.
4671 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
4672 # value, Google Cloud assigns a priority of `100` to the ranges.
4673 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
4674 #
4675 #
4676 # If set to FALSE, any active session with the peer is terminated and
4677 # all associated routing information is removed. If set to TRUE, the
4678 # peer connection can be established with routing information. The default
4679 # is TRUE.
4680 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
4681 # the peerIpAddress is version 4.
4682 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
4683 # peerIpAddress is version 6.
4684 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
4685 # evaluated. The name must correspond to an existing policy that has
4686 # ROUTE_POLICY_TYPE_EXPORT type.
4687 &quot;A String&quot;,
4688 ],
4689 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
4690 # evaluated. The name must correspond to an existing policy that has
4691 # ROUTE_POLICY_TYPE_IMPORT type.
4692 &quot;A String&quot;,
4693 ],
4694 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
4695 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
4696 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
4697 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
4698 &quot;linkedCustomHardware&quot;: &quot;A String&quot;, # The linked custom hardware resource.
4699 # The URI of the custom hardware link attachment
4700 # is where you will establish the BGP session from the Cloud Router.
4701 # This link attachment must reside in the same subnetwork as the associated
4702 # router interface.
4703 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
4704 #
4705 # - MANAGED_BY_USER is the default value and can be managed by you
4706 # or other users
4707 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
4708 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
4709 # PARTNER. Google automatically creates, updates, and deletes this type of
4710 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
4711 # or deleted.
4712 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
4713 # name of one of the entries in the Router.md5_authentication_keys. The
4714 # field must comply with RFC1035.
4715 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
4716 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
4717 # characters long and match the regular expression
4718 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4719 # lowercase letter, and all following characters must be a dash, lowercase
4720 # letter, or digit, except the last character, which cannot be a dash.
4721 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
4722 # a different value.
4723 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
4724 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
4725 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
4726 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
4727 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
4728 # Appliances. The VM instance must be located in zones contained in the
4729 # same region as this Cloud Router.
4730 # The VM instance is the peer side of the BGP session.
4731 },
4732 ],
4733 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4734 # text format.
4735 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4736 # create the resource.
4737 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
4738 # attachments (interconnectAttachments).
4739 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4740 # defined by the server.
4741 &quot;interfaces&quot;: [ # Router interfaces.
4742 # To create a BGP peer that uses a router interface,
4743 # the interface must have one of the following fields specified:
4744 #
4745 # - linkedVpnTunnel
4746 # - linkedInterconnectAttachment
4747 # - subnetwork
4748 #
4749 #
4750 # You can create a router interface without any of these fields specified.
4751 # However, you cannot create a BGP peer that uses that interface.
4752 {
4753 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
4754 #
4755 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
4756 # be a CIDR-formatted string, for example, 169.254.0.1/30.
4757 # Note: Do not truncate the IP address, as it represents the IP address of
4758 # the interface.
4759 # - For Internet Protocol version 6 (IPv6), the value
4760 # must be a unique local address (ULA) range from fdff:1::/64
4761 # with a mask length of 126 or less. This value should be a CIDR-formatted
4762 # string, for example, fdff:1::1/112. Within the router&#x27;s
4763 # VPC, this IPv6 prefix will be reserved exclusively for this connection
4764 # and cannot be used for any other purpose.
4765 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
4766 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
4767 # as the router. Each interface can have one linked resource, which can be
4768 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
4769 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
4770 # router. Each interface can have one linked resource, which can be
4771 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
4772 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
4773 #
4774 # - MANAGED_BY_USER is the default value and can be managed directly
4775 # by users.
4776 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
4777 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
4778 # of type PARTNER. Google automatically creates, updates, and deletes
4779 # this type of interface when the PARTNER InterconnectAttachment is
4780 # created, updated, or deleted.
4781 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
4782 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
4783 # characters long and match the regular expression
4784 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4785 # lowercase letter, and all following characters must be a dash, lowercase
4786 # letter, or digit, except the last character, which cannot be a dash.
4787 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
4788 # BGP sessions to a VM instance acting as a third-party
4789 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
4790 # an SD-WAN VM.
4791 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
4792 # you are creating. The redundantInterface must belong to the same Cloud
4793 # Router as the interface here. To establish the BGP session to a Router
4794 # Appliance VM, you must create two BGP peers. The two BGP peers must be
4795 # attached to two separate interfaces that are redundant with each other.
4796 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
4797 # be 1-63 characters long and match the regular expression
4798 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4799 # lowercase letter, and all following characters must be a dash, lowercase
4800 # letter, or digit, except the last character, which cannot be a dash.
4801 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
4802 # must be in the same region as the Cloud Router.
4803 # When you establish a BGP session to a VM instance using this interface,
4804 # the VM instance must belong to the same subnetwork as the subnetwork
4805 # specified here.
4806 },
4807 ],
4808 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
4809 # routers.
4810 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
4811 {
4812 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
4813 #
4814 # For patch and update calls, it can be skipped to
4815 # copy the value from the previous configuration. This is allowed if the
4816 # key with the same name existed before the operation. Maximum length is 80
4817 # characters. Can only contain printable ASCII characters.
4818 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
4819 #
4820 # Must be unique within a router. Must be referenced by exactly
4821 # one bgpPeer. Must comply withRFC1035.
4822 },
4823 ],
4824 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
4825 # The name must be 1-63 characters long, and comply withRFC1035.
4826 # Specifically, the name must be 1-63 characters long and match the regular
4827 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4828 # character must be a lowercase letter, and all following characters must
4829 # be a dash, lowercase letter, or digit, except the last character, which
4830 # cannot be a dash.
4831 &quot;nats&quot;: [ # A list of NAT services created in this router.
4832 { # Represents a Nat resource. It enables the VMs within the specified
4833 # subnetworks to access Internet without external IP addresses. It specifies
4834 # a list of subnetworks (and the ranges within) that want to use NAT.
4835 # Customers can also provide the external IPs that would be used for NAT. GCP
4836 # would auto-allocate ephemeral IPs if no external IPs are provided.
4837 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
4838 # Must be one of: PREMIUM, STANDARD.
4839 # If not specified, then the current
4840 # project-level default tier is used.
4841 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
4842 # must be valid static external IPs that have been assigned to the NAT.
4843 # These IPs should be used for updating/patching a NAT only.
4844 &quot;A String&quot;,
4845 ],
4846 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
4847 # state. This value is equal to tcp_time_wait_timeout_sec.
4848 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
4849 # 120s. The field is output only.
4850 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
4851 #
4852 #
4853 # If not specified, it is disabled by default.
4854 #
4855 #
4856 # If set to true,
4857 #
4858 # - Dynamic Port Allocation will be enabled on this NAT
4859 # config.
4860 # - enableEndpointIndependentMapping cannot be set to true.
4861 # - If minPorts is set, minPortsPerVm must be set to a
4862 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
4863 # minimum of 32 ports will be allocated to a VM from this NAT
4864 # config.
4865 &quot;enableEndpointIndependentMapping&quot;: True or False,
4866 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
4867 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
4868 &quot;A String&quot;,
4869 ],
4870 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
4871 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
4872 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
4873 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
4874 # logs are exported for all connections handled by this NAT.
4875 # This option can take one of the following values:
4876 #
4877 # - ERRORS_ONLY: Export logs only for connection failures.
4878 # - TRANSLATIONS_ONLY: Export logs only for successful
4879 # connections.
4880 # - ALL: Export logs for all connections, successful and
4881 # unsuccessful.
4882 },
4883 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
4884 # Dynamic Port Allocation is enabled.
4885 #
4886 #
4887 # If Dynamic Port Allocation is not enabled, this field has no effect.
4888 #
4889 #
4890 # If Dynamic Port Allocation is enabled, and this field is set, it must be
4891 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
4892 # is not set.
4893 #
4894 #
4895 # If Dynamic Port Allocation is enabled and this field is not set,
4896 # a maximum of 65536 ports will be allocated to a VM from this NAT
4897 # config.
4898 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
4899 # set, a default number of ports is allocated to a VM. This is rounded
4900 # up to the nearest power of 2. For example, if the value of this field is
4901 # 50, at least 64 ports are allocated to a VM.
4902 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
4903 # The name must be 1-63 characters long and comply withRFC1035.
4904 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
4905 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
4906 # selected for the SubnetworkIpRangeToNat64Option above.
4907 { # Specifies a subnetwork to enable NAT64.
4908 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
4909 },
4910 ],
4911 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
4912 # values:
4913 #
4914 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
4915 # customers. When there are not enough specified Nat IPs, the Nat service
4916 # fails for new VMs.
4917 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
4918 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
4919 # be empty.
4920 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
4921 # addresses must be valid static external IP addresses assigned to the
4922 # project.
4923 &quot;A String&quot;,
4924 ],
4925 &quot;rules&quot;: [ # A list of rules associated with this NAT.
4926 {
4927 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
4928 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
4929 # addresses must be valid static external IP addresses assigned to the
4930 # project.
4931 # This field is used for public NAT.
4932 &quot;A String&quot;,
4933 ],
4934 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
4935 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
4936 # This field is used for private NAT.
4937 &quot;A String&quot;,
4938 ],
4939 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
4940 # must be valid static external IPs that have been assigned to the NAT.
4941 # These IPs should be used for updating/patching a NAT rule only.
4942 # This field is used for public NAT.
4943 &quot;A String&quot;,
4944 ],
4945 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
4946 # drained. This is only supported on patch/update, and these
4947 # subnetworks must have previously been used as active ranges in this
4948 # NAT Rule.
4949 # This field is used for private NAT.
4950 &quot;A String&quot;,
4951 ],
4952 },
4953 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
4954 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
4955 # from a VM is evaluated against. If it evaluates to true, the
4956 # corresponding `action` is enforced.
4957 #
4958 # The following examples are valid match expressions for public NAT:
4959 #
4960 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
4961 # &#x27;2.2.0.0/16&#x27;)`
4962 #
4963 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
4964 #
4965 # The following example is a valid match expression for private NAT:
4966 #
4967 # `nexthop.hub ==
4968 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
4969 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
4970 # must be a positive value between 0 and 65000, and
4971 # must be unique among rules within a NAT.
4972 &quot;sourceWorkloadIdentities&quot;: [ # A list of source workload identities.
4973 &quot;A String&quot;,
4974 ],
4975 },
4976 ],
4977 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
4978 #
4979 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
4980 # Subnetwork are allowed to Nat.
4981 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
4982 # in every Subnetwork are allowed to Nat.
4983 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
4984 # (specified in the field subnetwork below)
4985 #
4986 #
4987 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
4988 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
4989 # should not be any other Router.Nat section in any Router for this network
4990 # in this region.
4991 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
4992 # values:
4993 #
4994 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
4995 # every Subnetwork are allowed to Nat.
4996 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
4997 # (specified in the field nat64_subnetwork below)
4998 #
4999 #
5000 # The default is NAT64_OPTION_UNSPECIFIED.
5001 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
5002 # Router.Nat section in this region can also enable NAT64 for any
5003 # Subnetworks in this network. Other Router.Nat sections can still be
5004 # present to enable NAT44 only.
5005 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
5006 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
5007 # SubnetworkIpRangeToNatOption above.
5008 { # Defines the IP ranges that want to use NAT for a subnetwork.
5009 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
5010 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
5011 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
5012 # is one of the values in source_ip_ranges_to_nat.
5013 &quot;A String&quot;,
5014 ],
5015 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
5016 # options of a single value are valid except
5017 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
5018 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
5019 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
5020 # Default: [ALL_IP_RANGES]
5021 &quot;A String&quot;,
5022 ],
5023 },
5024 ],
5025 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
5026 # if not set.
5027 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
5028 # Defaults to 120s if not set.
5029 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
5030 # not set.
5031 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
5032 # translation. If unspecified, it defaults to PUBLIC.
5033 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
5034 },
5035 ],
5036 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
5037 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
5038 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
5039 # as part of resource payload.
5040 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
5041 # The field is allowed for INSERT
5042 # only. The keys/values to set on the resource should be specified in
5043 # either ID { : } or Namespaced format
5044 # { : }.
5045 # For example the following are valid inputs:
5046 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
5047 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
5048 # Note:
5049 # * Invalid combinations of ID &amp; namespaced format is not supported. For
5050 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
5051 # * Inconsistent format is not supported. For instance:
5052 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
5053 &quot;a_key&quot;: &quot;A String&quot;,
5054 },
5055 },
5056 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
5057 # You must specify this field as part of the HTTP request URL. It is
5058 # not settable as a field in the request body.
5059 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5060 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5061 },
5062 ],
5063 &quot;kind&quot;: &quot;compute#routerList&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
5064 # routers.
5065 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5066 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5067 # the query parameter pageToken in the next list request.
5068 # Subsequent list requests will have their own nextPageToken to
5069 # continue paging through the results.
5070 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5071 &quot;warning&quot;: { # [Output Only] Informational warning message.
5072 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5073 # Engine returns NO_RESULTS_ON_PAGE if there
5074 # are no results in the response.
5075 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5076 # value format. For example:
5077 #
5078 # &quot;data&quot;: [
5079 # {
5080 # &quot;key&quot;: &quot;scope&quot;,
5081 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5082 # }
5083 {
5084 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5085 # returned. For example, for warnings where there are no results in a list
5086 # request for a particular zone, this key might be scope and
5087 # the key value might be the zone name. Other examples might be a key
5088 # indicating a deprecated resource and a suggested replacement, or a
5089 # warning about invalid network settings (for example, if an instance
5090 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5091 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5092 },
5093 ],
5094 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5095 },
5096 }</pre>
5097 </div>
5098
5099 <div class="method">
5100 <code class="details" id="listBgpRoutes">listBgpRoutes(project, region, router, addressFamily=None, destinationPrefix=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peer=None, policyApplied=None, returnPartialSuccess=None, routeType=None, x__xgafv=None)</code>
5101 <pre>Retrieves a list of router bgp routes available to the specified project.
5102
5103 Args:
5104 project: string, Project ID for this request. (required)
5105 region: string, Name of the region for this request. (required)
5106 router: string, Name or id of the resource for this request.
5107 Name should conform to RFC1035. (required)
5108 addressFamily: string, (Required) limit results to this address family (either IPv4 or IPv6)
5109 Allowed values
5110 IPV4 -
5111 IPV6 -
5112 UNSPECIFIED_IP_VERSION -
5113 destinationPrefix: string, Limit results to destinations that are subnets of this CIDR range
5114 filter: string, A filter expression that filters resources listed in the response. Most
5115 Compute resources support two types of filter expressions:
5116 expressions that support regular expressions and expressions that follow
5117 API improvement proposal AIP-160.
5118 These two types of filter expressions cannot be mixed in one request.
5119
5120 If you want to use AIP-160, your expression must specify the field name, an
5121 operator, and the value that you want to use for filtering. The value
5122 must be a string, a number, or a boolean. The operator
5123 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5124
5125 For example, if you are filtering Compute Engine instances, you can
5126 exclude instances named `example-instance` by specifying
5127 `name != example-instance`.
5128
5129 The `:*` comparison can be used to test whether a key has been defined.
5130 For example, to find all objects with `owner` label use:
5131 ```
5132 labels.owner:*
5133 ```
5134
5135 You can also filter nested fields. For example, you could specify
5136 `scheduling.automaticRestart = false` to include instances only
5137 if they are not scheduled for automatic restarts. You can use filtering
5138 on nested fields to filter based onresource labels.
5139
5140 To filter on multiple expressions, provide each separate expression within
5141 parentheses. For example:
5142 ```
5143 (scheduling.automaticRestart = true)
5144 (cpuPlatform = &quot;Intel Skylake&quot;)
5145 ```
5146 By default, each expression is an `AND` expression. However, you
5147 can include `AND` and `OR` expressions explicitly.
5148 For example:
5149 ```
5150 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5151 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5152 (scheduling.automaticRestart = true)
5153 ```
5154
5155 If you want to use a regular expression, use the `eq` (equal) or `ne`
5156 (not equal) operator against a single un-parenthesized expression with or
5157 without quotes or against multiple parenthesized expressions. Examples:
5158
5159 `fieldname eq unquoted literal`
5160 `fieldname eq &#x27;single quoted literal&#x27;`
5161 `fieldname eq &quot;double quoted literal&quot;`
5162 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5163
5164 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5165 The literal value must match the entire field.
5166
5167 For example, to filter for instances that do not end with name &quot;instance&quot;,
5168 you would use `name ne .*instance`.
5169
5170 You cannot combine constraints on multiple fields using regular
5171 expressions.
5172 maxResults: integer, The maximum number of results per page that should be returned.
5173 If the number of available results is larger than `maxResults`,
5174 Compute Engine returns a `nextPageToken` that can be used to get
5175 the next page of results in subsequent list requests. Acceptable values are
5176 `0` to `500`, inclusive. (Default: `500`)
5177 orderBy: string, Sorts list results by a certain order. By default, results
5178 are returned in alphanumerical order based on the resource name.
5179
5180 You can also sort results in descending order based on the creation
5181 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5182 results based on the `creationTimestamp` field in
5183 reverse chronological order (newest result first). Use this to sort
5184 resources like operations so that the newest operation is returned first.
5185
5186 Currently, only sorting by `name` or
5187 `creationTimestamp desc` is supported.
5188 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5189 `nextPageToken` returned by a previous list request to get
5190 the next page of results.
5191 peer: string, (Required) limit results to the BGP peer with the given name.
5192 Name should conform to RFC1035.
5193 policyApplied: boolean, When true, the method returns post-policy routes. Otherwise, it returns
5194 pre-policy routes.
5195 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5196 of failure. The default value is false.
5197
5198 For example, when partial success behavior is enabled, aggregatedList for a
5199 single zone scope either returns all resources in the zone or no resources,
5200 with an error code.
5201 routeType: string, (Required) limit results to this type of route (either LEARNED or
5202 ADVERTISED)
5203 Allowed values
5204 ADVERTISED -
5205 LEARNED -
5206 UNSPECIFIED_ROUTE_TYPE -
5207 x__xgafv: string, V1 error format.
5208 Allowed values
5209 1 - v1 error format
5210 2 - v2 error format
5211
5212 Returns:
5213 An object of the form:
5214
5215 {
5216 &quot;etag&quot;: &quot;A String&quot;,
5217 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5218 # defined by the server.
5219 &quot;kind&quot;: &quot;compute#routersListBgpRoutes&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#routersListBgpRoutes for lists of bgp routes.
5220 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5221 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5222 # the query parameter pageToken in the next list request.
5223 # Subsequent list requests will have their own nextPageToken to
5224 # continue paging through the results.
5225 &quot;result&quot;: [ # [Output Only] A list of bgp routes.
5226 {
5227 &quot;asPaths&quot;: [ # Output only. [Output only] AS-PATH for the route
5228 {
5229 &quot;asns&quot;: [ # Output only. [Output only] ASNs in the path segment. When type is SEQUENCE, these are
5230 # ordered.
5231 42,
5232 ],
5233 &quot;asns32&quot;: [ # Output only. [Output only] ASNs in the path segment. This field is for better
5234 # support of 32 bit ASNs as the other asns field suffers from overflow when
5235 # the ASN is larger. When type is SEQUENCE, these are ordered.
5236 42,
5237 ],
5238 &quot;type&quot;: &quot;A String&quot;, # Output only. [Output only] Type of AS-PATH segment (SEQUENCE or SET)
5239 },
5240 ],
5241 &quot;communities&quot;: [ # Output only. [Output only] BGP communities in human-readable A:B format.
5242 &quot;A String&quot;,
5243 ],
5244 &quot;destination&quot;: { # Network Layer Reachability Information (NLRI) for a route. # Output only. [Output only] Destination IP range for the route, in human-readable CIDR
5245 # format
5246 &quot;pathId&quot;: 42, # If the BGP session supports multiple paths (RFC 7911), the path
5247 # identifier for this route.
5248 &quot;prefix&quot;: &quot;A String&quot;, # Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16.
5249 },
5250 &quot;med&quot;: 42, # Output only. [Output only] BGP multi-exit discriminator
5251 &quot;origin&quot;: &quot;A String&quot;, # Output only. [Output only] BGP origin (EGP, IGP or INCOMPLETE)
5252 },
5253 ],
5254 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5255 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
5256 &quot;A String&quot;,
5257 ],
5258 &quot;warning&quot;: { # [Output Only] Informational warning message.
5259 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5260 # Engine returns NO_RESULTS_ON_PAGE if there
5261 # are no results in the response.
5262 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5263 # value format. For example:
5264 #
5265 # &quot;data&quot;: [
5266 # {
5267 # &quot;key&quot;: &quot;scope&quot;,
5268 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5269 # }
5270 {
5271 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5272 # returned. For example, for warnings where there are no results in a list
5273 # request for a particular zone, this key might be scope and
5274 # the key value might be the zone name. Other examples might be a key
5275 # indicating a deprecated resource and a suggested replacement, or a
5276 # warning about invalid network settings (for example, if an instance
5277 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5278 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5279 },
5280 ],
5281 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5282 },
5283 }</pre>
5284 </div>
5285
5286 <div class="method">
5287 <code class="details" id="listBgpRoutes_next">listBgpRoutes_next()</code>
5288 <pre>Retrieves the next page of results.
5289
5290 Args:
5291 previous_request: The request for the previous page. (required)
5292 previous_response: The response from the request for the previous page. (required)
5293
5294 Returns:
5295 A request object that you can call &#x27;execute()&#x27; on to request the next
5296 page. Returns None if there are no more items in the collection.
5297 </pre>
5298 </div>
5299
5300 <div class="method">
5301 <code class="details" id="listNamedSets">listNamedSets(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5302 <pre>Retrieves a list of router named set subresources available to the
5303 specified project.
5304
5305 Args:
5306 project: string, Project ID for this request. (required)
5307 region: string, Name of the region for this request. (required)
5308 router: string, Name or id of the resource for this request.
5309 Name should conform to RFC1035. (required)
5310 filter: string, A filter expression that filters resources listed in the response. Most
5311 Compute resources support two types of filter expressions:
5312 expressions that support regular expressions and expressions that follow
5313 API improvement proposal AIP-160.
5314 These two types of filter expressions cannot be mixed in one request.
5315
5316 If you want to use AIP-160, your expression must specify the field name, an
5317 operator, and the value that you want to use for filtering. The value
5318 must be a string, a number, or a boolean. The operator
5319 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5320
5321 For example, if you are filtering Compute Engine instances, you can
5322 exclude instances named `example-instance` by specifying
5323 `name != example-instance`.
5324
5325 The `:*` comparison can be used to test whether a key has been defined.
5326 For example, to find all objects with `owner` label use:
5327 ```
5328 labels.owner:*
5329 ```
5330
5331 You can also filter nested fields. For example, you could specify
5332 `scheduling.automaticRestart = false` to include instances only
5333 if they are not scheduled for automatic restarts. You can use filtering
5334 on nested fields to filter based onresource labels.
5335
5336 To filter on multiple expressions, provide each separate expression within
5337 parentheses. For example:
5338 ```
5339 (scheduling.automaticRestart = true)
5340 (cpuPlatform = &quot;Intel Skylake&quot;)
5341 ```
5342 By default, each expression is an `AND` expression. However, you
5343 can include `AND` and `OR` expressions explicitly.
5344 For example:
5345 ```
5346 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5347 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5348 (scheduling.automaticRestart = true)
5349 ```
5350
5351 If you want to use a regular expression, use the `eq` (equal) or `ne`
5352 (not equal) operator against a single un-parenthesized expression with or
5353 without quotes or against multiple parenthesized expressions. Examples:
5354
5355 `fieldname eq unquoted literal`
5356 `fieldname eq &#x27;single quoted literal&#x27;`
5357 `fieldname eq &quot;double quoted literal&quot;`
5358 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5359
5360 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5361 The literal value must match the entire field.
5362
5363 For example, to filter for instances that do not end with name &quot;instance&quot;,
5364 you would use `name ne .*instance`.
5365
5366 You cannot combine constraints on multiple fields using regular
5367 expressions.
5368 maxResults: integer, The maximum number of results per page that should be returned.
5369 If the number of available results is larger than `maxResults`,
5370 Compute Engine returns a `nextPageToken` that can be used to get
5371 the next page of results in subsequent list requests. Acceptable values are
5372 `0` to `500`, inclusive. (Default: `500`)
5373 orderBy: string, Sorts list results by a certain order. By default, results
5374 are returned in alphanumerical order based on the resource name.
5375
5376 You can also sort results in descending order based on the creation
5377 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5378 results based on the `creationTimestamp` field in
5379 reverse chronological order (newest result first). Use this to sort
5380 resources like operations so that the newest operation is returned first.
5381
5382 Currently, only sorting by `name` or
5383 `creationTimestamp desc` is supported.
5384 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5385 `nextPageToken` returned by a previous list request to get
5386 the next page of results.
5387 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5388 of failure. The default value is false.
5389
5390 For example, when partial success behavior is enabled, aggregatedList for a
5391 single zone scope either returns all resources in the zone or no resources,
5392 with an error code.
5393 x__xgafv: string, V1 error format.
5394 Allowed values
5395 1 - v1 error format
5396 2 - v2 error format
5397
5398 Returns:
5399 An object of the form:
5400
5401 {
5402 &quot;etag&quot;: &quot;A String&quot;,
5403 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5404 # defined by the server.
5405 &quot;kind&quot;: &quot;compute#routersListNamedSets&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#routersListNamedSets for lists of named sets.
5406 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5407 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5408 # the query parameter pageToken in the next list request.
5409 # Subsequent list requests will have their own nextPageToken to
5410 # continue paging through the results.
5411 &quot;result&quot;: [ # [Output Only] A list of named sets.
5412 {
5413 &quot;description&quot;: &quot;A String&quot;, # An optional description of named set.
5414 &quot;elements&quot;: [ # CEL expressions that are comparable to constructs of this set&#x27;s type
5415 # (see Policy Language).
5416 { # Represents a textual expression in the Common Expression Language (CEL)
5417 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5418 # are documented at https://github.com/google/cel-spec.
5419 #
5420 # Example (Comparison):
5421 #
5422 # title: &quot;Summary size limit&quot;
5423 # description: &quot;Determines if a summary is less than 100 chars&quot;
5424 # expression: &quot;document.summary.size() &lt; 100&quot;
5425 #
5426 # Example (Equality):
5427 #
5428 # title: &quot;Requestor is owner&quot;
5429 # description: &quot;Determines if requestor is the document owner&quot;
5430 # expression: &quot;document.owner == request.auth.claims.email&quot;
5431 #
5432 # Example (Logic):
5433 #
5434 # title: &quot;Public documents&quot;
5435 # description: &quot;Determine whether the document should be publicly visible&quot;
5436 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5437 #
5438 # Example (Data Manipulation):
5439 #
5440 # title: &quot;Notification string&quot;
5441 # description: &quot;Create a notification string with a timestamp.&quot;
5442 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5443 #
5444 # The exact variables and functions that may be referenced within an expression
5445 # are determined by the service that evaluates it. See the service
5446 # documentation for additional information.
5447 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5448 # describes the expression, e.g. when hovered over it in a UI.
5449 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5450 # syntax.
5451 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5452 # reporting, e.g. a file name and a position in the file.
5453 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5454 # its purpose. This can be used e.g. in UIs which allow to enter the
5455 # expression.
5456 },
5457 ],
5458 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Named Set being applied to this Router, which is
5459 # essentially a hash of the Named Set used for optimistic locking.
5460 # The fingerprint is initially generated by Compute Engine and changes
5461 # after every request to modify or update the Named Set. You must always
5462 # provide an up-to-date fingerprint hash in order to update or change
5463 # labels.
5464 #
5465 # To see the latest fingerprint, make a getNamedSet() request
5466 # to retrieve a Named Set.
5467 &quot;name&quot;: &quot;A String&quot;, # This set&#x27;s name, which must be a resource ID segment and unique within all
5468 # named sets owned by the Router. Name should conform to RFC1035.
5469 &quot;type&quot;: &quot;A String&quot;, # This named set&#x27;s type
5470 },
5471 ],
5472 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5473 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
5474 &quot;A String&quot;,
5475 ],
5476 &quot;warning&quot;: { # [Output Only] Informational warning message.
5477 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5478 # Engine returns NO_RESULTS_ON_PAGE if there
5479 # are no results in the response.
5480 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5481 # value format. For example:
5482 #
5483 # &quot;data&quot;: [
5484 # {
5485 # &quot;key&quot;: &quot;scope&quot;,
5486 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5487 # }
5488 {
5489 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5490 # returned. For example, for warnings where there are no results in a list
5491 # request for a particular zone, this key might be scope and
5492 # the key value might be the zone name. Other examples might be a key
5493 # indicating a deprecated resource and a suggested replacement, or a
5494 # warning about invalid network settings (for example, if an instance
5495 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5496 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5497 },
5498 ],
5499 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5500 },
5501 }</pre>
5502 </div>
5503
5504 <div class="method">
5505 <code class="details" id="listNamedSets_next">listNamedSets_next()</code>
5506 <pre>Retrieves the next page of results.
5507
5508 Args:
5509 previous_request: The request for the previous page. (required)
5510 previous_response: The response from the request for the previous page. (required)
5511
5512 Returns:
5513 A request object that you can call &#x27;execute()&#x27; on to request the next
5514 page. Returns None if there are no more items in the collection.
5515 </pre>
5516 </div>
5517
5518 <div class="method">
5519 <code class="details" id="listRoutePolicies">listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5520 <pre>Retrieves a list of router route policy subresources available to the
5521 specified project.
5522
5523 Args:
5524 project: string, Project ID for this request. (required)
5525 region: string, Name of the region for this request. (required)
5526 router: string, Name or id of the resource for this request.
5527 Name should conform to RFC1035. (required)
5528 filter: string, A filter expression that filters resources listed in the response. Most
5529 Compute resources support two types of filter expressions:
5530 expressions that support regular expressions and expressions that follow
5531 API improvement proposal AIP-160.
5532 These two types of filter expressions cannot be mixed in one request.
5533
5534 If you want to use AIP-160, your expression must specify the field name, an
5535 operator, and the value that you want to use for filtering. The value
5536 must be a string, a number, or a boolean. The operator
5537 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5538
5539 For example, if you are filtering Compute Engine instances, you can
5540 exclude instances named `example-instance` by specifying
5541 `name != example-instance`.
5542
5543 The `:*` comparison can be used to test whether a key has been defined.
5544 For example, to find all objects with `owner` label use:
5545 ```
5546 labels.owner:*
5547 ```
5548
5549 You can also filter nested fields. For example, you could specify
5550 `scheduling.automaticRestart = false` to include instances only
5551 if they are not scheduled for automatic restarts. You can use filtering
5552 on nested fields to filter based onresource labels.
5553
5554 To filter on multiple expressions, provide each separate expression within
5555 parentheses. For example:
5556 ```
5557 (scheduling.automaticRestart = true)
5558 (cpuPlatform = &quot;Intel Skylake&quot;)
5559 ```
5560 By default, each expression is an `AND` expression. However, you
5561 can include `AND` and `OR` expressions explicitly.
5562 For example:
5563 ```
5564 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5565 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5566 (scheduling.automaticRestart = true)
5567 ```
5568
5569 If you want to use a regular expression, use the `eq` (equal) or `ne`
5570 (not equal) operator against a single un-parenthesized expression with or
5571 without quotes or against multiple parenthesized expressions. Examples:
5572
5573 `fieldname eq unquoted literal`
5574 `fieldname eq &#x27;single quoted literal&#x27;`
5575 `fieldname eq &quot;double quoted literal&quot;`
5576 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5577
5578 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5579 The literal value must match the entire field.
5580
5581 For example, to filter for instances that do not end with name &quot;instance&quot;,
5582 you would use `name ne .*instance`.
5583
5584 You cannot combine constraints on multiple fields using regular
5585 expressions.
5586 maxResults: integer, The maximum number of results per page that should be returned.
5587 If the number of available results is larger than `maxResults`,
5588 Compute Engine returns a `nextPageToken` that can be used to get
5589 the next page of results in subsequent list requests. Acceptable values are
5590 `0` to `500`, inclusive. (Default: `500`)
5591 orderBy: string, Sorts list results by a certain order. By default, results
5592 are returned in alphanumerical order based on the resource name.
5593
5594 You can also sort results in descending order based on the creation
5595 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5596 results based on the `creationTimestamp` field in
5597 reverse chronological order (newest result first). Use this to sort
5598 resources like operations so that the newest operation is returned first.
5599
5600 Currently, only sorting by `name` or
5601 `creationTimestamp desc` is supported.
5602 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5603 `nextPageToken` returned by a previous list request to get
5604 the next page of results.
5605 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5606 of failure. The default value is false.
5607
5608 For example, when partial success behavior is enabled, aggregatedList for a
5609 single zone scope either returns all resources in the zone or no resources,
5610 with an error code.
5611 x__xgafv: string, V1 error format.
5612 Allowed values
5613 1 - v1 error format
5614 2 - v2 error format
5615
5616 Returns:
5617 An object of the form:
5618
5619 {
5620 &quot;etag&quot;: &quot;A String&quot;,
5621 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5622 # defined by the server.
5623 &quot;kind&quot;: &quot;compute#routersListRoutePolicies&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#routersListRoutePolicies for lists of route policies.
5624 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5625 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5626 # the query parameter pageToken in the next list request.
5627 # Subsequent list requests will have their own nextPageToken to
5628 # continue paging through the results.
5629 &quot;result&quot;: [ # [Output Only] A list of route policies.
5630 {
5631 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
5632 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
5633 # essentially a hash of the Route Policy used for optimistic locking.
5634 # The fingerprint is initially generated by Compute Engine and changes
5635 # after every request to modify or update Route Policy. You must always
5636 # provide an up-to-date fingerprint hash in order to update or change
5637 # labels.
5638 #
5639 # To see the latest fingerprint, make a getRoutePolicy() request
5640 # to retrieve a Route Policy.
5641 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
5642 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
5643 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
5644 # in order of priority). Order of policies is not retained and might change
5645 # when getting policy later.
5646 {
5647 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
5648 { # Represents a textual expression in the Common Expression Language (CEL)
5649 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5650 # are documented at https://github.com/google/cel-spec.
5651 #
5652 # Example (Comparison):
5653 #
5654 # title: &quot;Summary size limit&quot;
5655 # description: &quot;Determines if a summary is less than 100 chars&quot;
5656 # expression: &quot;document.summary.size() &lt; 100&quot;
5657 #
5658 # Example (Equality):
5659 #
5660 # title: &quot;Requestor is owner&quot;
5661 # description: &quot;Determines if requestor is the document owner&quot;
5662 # expression: &quot;document.owner == request.auth.claims.email&quot;
5663 #
5664 # Example (Logic):
5665 #
5666 # title: &quot;Public documents&quot;
5667 # description: &quot;Determine whether the document should be publicly visible&quot;
5668 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5669 #
5670 # Example (Data Manipulation):
5671 #
5672 # title: &quot;Notification string&quot;
5673 # description: &quot;Create a notification string with a timestamp.&quot;
5674 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5675 #
5676 # The exact variables and functions that may be referenced within an expression
5677 # are determined by the service that evaluates it. See the service
5678 # documentation for additional information.
5679 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5680 # describes the expression, e.g. when hovered over it in a UI.
5681 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5682 # syntax.
5683 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5684 # reporting, e.g. a file name and a position in the file.
5685 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5686 # its purpose. This can be used e.g. in UIs which allow to enter the
5687 # expression.
5688 },
5689 ],
5690 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
5691 # applies. When not set, the term applies to all
5692 # routes.
5693 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5694 # are documented at https://github.com/google/cel-spec.
5695 #
5696 # Example (Comparison):
5697 #
5698 # title: &quot;Summary size limit&quot;
5699 # description: &quot;Determines if a summary is less than 100 chars&quot;
5700 # expression: &quot;document.summary.size() &lt; 100&quot;
5701 #
5702 # Example (Equality):
5703 #
5704 # title: &quot;Requestor is owner&quot;
5705 # description: &quot;Determines if requestor is the document owner&quot;
5706 # expression: &quot;document.owner == request.auth.claims.email&quot;
5707 #
5708 # Example (Logic):
5709 #
5710 # title: &quot;Public documents&quot;
5711 # description: &quot;Determine whether the document should be publicly visible&quot;
5712 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5713 #
5714 # Example (Data Manipulation):
5715 #
5716 # title: &quot;Notification string&quot;
5717 # description: &quot;Create a notification string with a timestamp.&quot;
5718 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5719 #
5720 # The exact variables and functions that may be referenced within an expression
5721 # are determined by the service that evaluates it. See the service
5722 # documentation for additional information.
5723 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5724 # describes the expression, e.g. when hovered over it in a UI.
5725 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5726 # syntax.
5727 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5728 # reporting, e.g. a file name and a position in the file.
5729 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5730 # its purpose. This can be used e.g. in UIs which allow to enter the
5731 # expression.
5732 },
5733 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
5734 # (inclusive) and 2^31 (exclusive), and unique within the list.
5735 },
5736 ],
5737 &quot;type&quot;: &quot;A String&quot;,
5738 },
5739 ],
5740 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5741 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
5742 &quot;A String&quot;,
5743 ],
5744 &quot;warning&quot;: { # [Output Only] Informational warning message.
5745 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5746 # Engine returns NO_RESULTS_ON_PAGE if there
5747 # are no results in the response.
5748 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5749 # value format. For example:
5750 #
5751 # &quot;data&quot;: [
5752 # {
5753 # &quot;key&quot;: &quot;scope&quot;,
5754 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5755 # }
5756 {
5757 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5758 # returned. For example, for warnings where there are no results in a list
5759 # request for a particular zone, this key might be scope and
5760 # the key value might be the zone name. Other examples might be a key
5761 # indicating a deprecated resource and a suggested replacement, or a
5762 # warning about invalid network settings (for example, if an instance
5763 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5764 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5765 },
5766 ],
5767 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5768 },
5769 }</pre>
5770 </div>
5771
5772 <div class="method">
5773 <code class="details" id="listRoutePolicies_next">listRoutePolicies_next()</code>
5774 <pre>Retrieves the next page of results.
5775
5776 Args:
5777 previous_request: The request for the previous page. (required)
5778 previous_response: The response from the request for the previous page. (required)
5779
5780 Returns:
5781 A request object that you can call &#x27;execute()&#x27; on to request the next
5782 page. Returns None if there are no more items in the collection.
5783 </pre>
5784 </div>
5785
5786 <div class="method">
5787 <code class="details" id="list_next">list_next()</code>
5788 <pre>Retrieves the next page of results.
5789
5790 Args:
5791 previous_request: The request for the previous page. (required)
5792 previous_response: The response from the request for the previous page. (required)
5793
5794 Returns:
5795 A request object that you can call &#x27;execute()&#x27; on to request the next
5796 page. Returns None if there are no more items in the collection.
5797 </pre>
5798 </div>
5799
5800 <div class="method">
5801 <code class="details" id="patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
5802 <pre>Patches the specified Router resource with the data included in the
5803 request. This method supportsPATCH
5804 semantics and usesJSON merge
5805 patch format and processing rules.
5806
5807 Args:
5808 project: string, Project ID for this request. (required)
5809 region: string, Name of the region for this request. (required)
5810 router: string, Name of the Router resource to patch. (required)
5811 body: object, The request body.
5812 The object takes the form of:
5813
5814 { # Represents a Cloud Router resource.
5815 #
5816 # For more information about Cloud Router, read theCloud
5817 # Router overview.
5818 &quot;bgp&quot;: { # BGP information specific to this router.
5819 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
5820 # The options are DEFAULT or CUSTOM.
5821 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
5822 # This field can only be populated if advertise_mode is CUSTOM and
5823 # is advertised to all peers of the router.
5824 # These groups will be advertised in addition to any specified prefixes.
5825 # Leave this field blank to advertise no custom groups.
5826 &quot;A String&quot;,
5827 ],
5828 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
5829 # This field can only be populated if advertise_mode is CUSTOM and
5830 # is advertised to all peers of the router.
5831 # These IP ranges will be advertised in addition to any specified groups.
5832 # Leave this field blank to advertise no custom IP ranges.
5833 { # Description-tagged IP ranges for the router to advertise.
5834 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
5835 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
5836 },
5837 ],
5838 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
5839 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
5840 # value will be fixed for this router resource. All VPN tunnels that link
5841 # to this router will have the same local ASN.
5842 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
5843 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
5844 # least /30, even if the BGP sessions are over IPv6. It must not overlap
5845 # with any IPv4 BGP session ranges.
5846 #
5847 #
5848 # Other vendors commonly call this &quot;router ID&quot;.
5849 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
5850 # sent to the peer.
5851 #
5852 #
5853 # Hold time is three times the interval at which keepalive messages are
5854 # sent, and the hold time is the maximum number of seconds allowed to
5855 # elapse between successive keepalive messages that BGP receives from a
5856 # peer.
5857 #
5858 #
5859 # BGP will use the smaller of either the local hold time value or the
5860 # peer&#x27;s hold time value as the hold time for the BGP connection between
5861 # the two peers.
5862 #
5863 #
5864 # If set, this value must be between 20 and 60. The default is 20.
5865 },
5866 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
5867 # establish BGP peering. This information must specify the peer ASN and
5868 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
5869 {
5870 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
5871 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
5872 # which currently supports the following option:
5873 #
5874 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
5875 # excludes any routes learned for subnets that use
5876 # VPC Network Peering.
5877 #
5878 #
5879 # Note that this field can only be populated if advertise_mode is CUSTOM
5880 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
5881 # These groups are advertised in addition to any specified prefixes.
5882 # Leave this field blank to advertise no custom groups.
5883 &quot;A String&quot;,
5884 ],
5885 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
5886 # This field can only be populated if advertise_mode is CUSTOM and
5887 # overrides the list defined for the router (in the &quot;bgp&quot; message).
5888 # These IP ranges are advertised in addition to any specified groups.
5889 # Leave this field blank to advertise no custom IP ranges.
5890 { # Description-tagged IP ranges for the router to advertise.
5891 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
5892 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
5893 },
5894 ],
5895 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
5896 # than one matching route of maximum length, the routes with the lowest
5897 # priority value win.
5898 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
5899 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
5900 # received from the peer router. The actual value is negotiated between
5901 # the two routers and is equal to the greater of this value and the
5902 # transmit interval of the other router.
5903 #
5904 #
5905 # If set, this value must be between 1000 and 30000.
5906 #
5907 #
5908 # The default is 1000.
5909 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
5910 # transmitted to the peer router. The actual value is negotiated between
5911 # the two routers and is equal to the greater of this value and the
5912 # corresponding receive interval of the other router.
5913 #
5914 #
5915 # If set, this value must be between 1000 and 30000.
5916 #
5917 #
5918 # The default is 1000.
5919 &quot;mode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
5920 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
5921 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
5922 # peer router to initiate the BFD session for this BGP peer. If set to
5923 # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.
5924 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
5925 # before BFD declares that a peer is unavailable.
5926 #
5927 #
5928 # If set, the value must be a value between 5 and 16.
5929 #
5930 #
5931 # The default is 5.
5932 &quot;packetMode&quot;: &quot;A String&quot;, # The BFD packet mode for this BGP peer.
5933 # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer.
5934 # In this mode, if the peer router also has BFD echo mode enabled, BFD
5935 # echo packets will be sent to the other router. If the peer router does
5936 # not have BFD echo mode enabled, only control packets will be sent. If
5937 # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If
5938 # this router and the peer router have a multihop connection, this should
5939 # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop
5940 # connections. The default is CONTROL_AND_ECHO.
5941 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
5942 #
5943 #
5944 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
5945 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
5946 # peer router to initiate the BFD session for this BGP peer. If set to
5947 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
5948 &quot;slowTimerInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
5949 # transmitted to and received from the peer router when BFD echo mode is
5950 # enabled on both routers. The actual transmit and receive intervals are
5951 # negotiated between the two routers and are equal to the greater of this
5952 # value and the corresponding interval on the other router.
5953 # If set, this value must be between 1000 and 30000.
5954 # The default is 5000.
5955 },
5956 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
5957 # session.
5958 {
5959 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
5960 # CIDR-formatted prefix. If an IP address is provided without a subnet
5961 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
5962 # range, and, for IPv6, `/128`.
5963 },
5964 ],
5965 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
5966 # value is applied to all custom learned route ranges for the session.
5967 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
5968 # value, Google Cloud assigns a priority of `100` to the ranges.
5969 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
5970 #
5971 #
5972 # If set to FALSE, any active session with the peer is terminated and
5973 # all associated routing information is removed. If set to TRUE, the
5974 # peer connection can be established with routing information. The default
5975 # is TRUE.
5976 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
5977 # the peerIpAddress is version 4.
5978 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
5979 # peerIpAddress is version 6.
5980 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
5981 # evaluated. The name must correspond to an existing policy that has
5982 # ROUTE_POLICY_TYPE_EXPORT type.
5983 &quot;A String&quot;,
5984 ],
5985 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
5986 # evaluated. The name must correspond to an existing policy that has
5987 # ROUTE_POLICY_TYPE_IMPORT type.
5988 &quot;A String&quot;,
5989 ],
5990 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
5991 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
5992 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
5993 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
5994 &quot;linkedCustomHardware&quot;: &quot;A String&quot;, # The linked custom hardware resource.
5995 # The URI of the custom hardware link attachment
5996 # is where you will establish the BGP session from the Cloud Router.
5997 # This link attachment must reside in the same subnetwork as the associated
5998 # router interface.
5999 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
6000 #
6001 # - MANAGED_BY_USER is the default value and can be managed by you
6002 # or other users
6003 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
6004 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
6005 # PARTNER. Google automatically creates, updates, and deletes this type of
6006 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
6007 # or deleted.
6008 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
6009 # name of one of the entries in the Router.md5_authentication_keys. The
6010 # field must comply with RFC1035.
6011 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
6012 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
6013 # characters long and match the regular expression
6014 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
6015 # lowercase letter, and all following characters must be a dash, lowercase
6016 # letter, or digit, except the last character, which cannot be a dash.
6017 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
6018 # a different value.
6019 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
6020 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
6021 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
6022 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
6023 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
6024 # Appliances. The VM instance must be located in zones contained in the
6025 # same region as this Cloud Router.
6026 # The VM instance is the peer side of the BGP session.
6027 },
6028 ],
6029 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
6030 # text format.
6031 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6032 # create the resource.
6033 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
6034 # attachments (interconnectAttachments).
6035 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
6036 # defined by the server.
6037 &quot;interfaces&quot;: [ # Router interfaces.
6038 # To create a BGP peer that uses a router interface,
6039 # the interface must have one of the following fields specified:
6040 #
6041 # - linkedVpnTunnel
6042 # - linkedInterconnectAttachment
6043 # - subnetwork
6044 #
6045 #
6046 # You can create a router interface without any of these fields specified.
6047 # However, you cannot create a BGP peer that uses that interface.
6048 {
6049 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
6050 #
6051 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
6052 # be a CIDR-formatted string, for example, 169.254.0.1/30.
6053 # Note: Do not truncate the IP address, as it represents the IP address of
6054 # the interface.
6055 # - For Internet Protocol version 6 (IPv6), the value
6056 # must be a unique local address (ULA) range from fdff:1::/64
6057 # with a mask length of 126 or less. This value should be a CIDR-formatted
6058 # string, for example, fdff:1::1/112. Within the router&#x27;s
6059 # VPC, this IPv6 prefix will be reserved exclusively for this connection
6060 # and cannot be used for any other purpose.
6061 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
6062 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
6063 # as the router. Each interface can have one linked resource, which can be
6064 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
6065 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
6066 # router. Each interface can have one linked resource, which can be
6067 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
6068 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
6069 #
6070 # - MANAGED_BY_USER is the default value and can be managed directly
6071 # by users.
6072 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
6073 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
6074 # of type PARTNER. Google automatically creates, updates, and deletes
6075 # this type of interface when the PARTNER InterconnectAttachment is
6076 # created, updated, or deleted.
6077 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
6078 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
6079 # characters long and match the regular expression
6080 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
6081 # lowercase letter, and all following characters must be a dash, lowercase
6082 # letter, or digit, except the last character, which cannot be a dash.
6083 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
6084 # BGP sessions to a VM instance acting as a third-party
6085 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
6086 # an SD-WAN VM.
6087 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
6088 # you are creating. The redundantInterface must belong to the same Cloud
6089 # Router as the interface here. To establish the BGP session to a Router
6090 # Appliance VM, you must create two BGP peers. The two BGP peers must be
6091 # attached to two separate interfaces that are redundant with each other.
6092 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
6093 # be 1-63 characters long and match the regular expression
6094 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
6095 # lowercase letter, and all following characters must be a dash, lowercase
6096 # letter, or digit, except the last character, which cannot be a dash.
6097 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
6098 # must be in the same region as the Cloud Router.
6099 # When you establish a BGP session to a VM instance using this interface,
6100 # the VM instance must belong to the same subnetwork as the subnetwork
6101 # specified here.
6102 },
6103 ],
6104 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
6105 # routers.
6106 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
6107 {
6108 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
6109 #
6110 # For patch and update calls, it can be skipped to
6111 # copy the value from the previous configuration. This is allowed if the
6112 # key with the same name existed before the operation. Maximum length is 80
6113 # characters. Can only contain printable ASCII characters.
6114 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
6115 #
6116 # Must be unique within a router. Must be referenced by exactly
6117 # one bgpPeer. Must comply withRFC1035.
6118 },
6119 ],
6120 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
6121 # The name must be 1-63 characters long, and comply withRFC1035.
6122 # Specifically, the name must be 1-63 characters long and match the regular
6123 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
6124 # character must be a lowercase letter, and all following characters must
6125 # be a dash, lowercase letter, or digit, except the last character, which
6126 # cannot be a dash.
6127 &quot;nats&quot;: [ # A list of NAT services created in this router.
6128 { # Represents a Nat resource. It enables the VMs within the specified
6129 # subnetworks to access Internet without external IP addresses. It specifies
6130 # a list of subnetworks (and the ranges within) that want to use NAT.
6131 # Customers can also provide the external IPs that would be used for NAT. GCP
6132 # would auto-allocate ephemeral IPs if no external IPs are provided.
6133 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
6134 # Must be one of: PREMIUM, STANDARD.
6135 # If not specified, then the current
6136 # project-level default tier is used.
6137 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
6138 # must be valid static external IPs that have been assigned to the NAT.
6139 # These IPs should be used for updating/patching a NAT only.
6140 &quot;A String&quot;,
6141 ],
6142 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
6143 # state. This value is equal to tcp_time_wait_timeout_sec.
6144 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
6145 # 120s. The field is output only.
6146 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
6147 #
6148 #
6149 # If not specified, it is disabled by default.
6150 #
6151 #
6152 # If set to true,
6153 #
6154 # - Dynamic Port Allocation will be enabled on this NAT
6155 # config.
6156 # - enableEndpointIndependentMapping cannot be set to true.
6157 # - If minPorts is set, minPortsPerVm must be set to a
6158 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
6159 # minimum of 32 ports will be allocated to a VM from this NAT
6160 # config.
6161 &quot;enableEndpointIndependentMapping&quot;: True or False,
6162 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
6163 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
6164 &quot;A String&quot;,
6165 ],
6166 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
6167 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
6168 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
6169 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
6170 # logs are exported for all connections handled by this NAT.
6171 # This option can take one of the following values:
6172 #
6173 # - ERRORS_ONLY: Export logs only for connection failures.
6174 # - TRANSLATIONS_ONLY: Export logs only for successful
6175 # connections.
6176 # - ALL: Export logs for all connections, successful and
6177 # unsuccessful.
6178 },
6179 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
6180 # Dynamic Port Allocation is enabled.
6181 #
6182 #
6183 # If Dynamic Port Allocation is not enabled, this field has no effect.
6184 #
6185 #
6186 # If Dynamic Port Allocation is enabled, and this field is set, it must be
6187 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
6188 # is not set.
6189 #
6190 #
6191 # If Dynamic Port Allocation is enabled and this field is not set,
6192 # a maximum of 65536 ports will be allocated to a VM from this NAT
6193 # config.
6194 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
6195 # set, a default number of ports is allocated to a VM. This is rounded
6196 # up to the nearest power of 2. For example, if the value of this field is
6197 # 50, at least 64 ports are allocated to a VM.
6198 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
6199 # The name must be 1-63 characters long and comply withRFC1035.
6200 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
6201 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
6202 # selected for the SubnetworkIpRangeToNat64Option above.
6203 { # Specifies a subnetwork to enable NAT64.
6204 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
6205 },
6206 ],
6207 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
6208 # values:
6209 #
6210 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
6211 # customers. When there are not enough specified Nat IPs, the Nat service
6212 # fails for new VMs.
6213 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
6214 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
6215 # be empty.
6216 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
6217 # addresses must be valid static external IP addresses assigned to the
6218 # project.
6219 &quot;A String&quot;,
6220 ],
6221 &quot;rules&quot;: [ # A list of rules associated with this NAT.
6222 {
6223 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
6224 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
6225 # addresses must be valid static external IP addresses assigned to the
6226 # project.
6227 # This field is used for public NAT.
6228 &quot;A String&quot;,
6229 ],
6230 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
6231 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
6232 # This field is used for private NAT.
6233 &quot;A String&quot;,
6234 ],
6235 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
6236 # must be valid static external IPs that have been assigned to the NAT.
6237 # These IPs should be used for updating/patching a NAT rule only.
6238 # This field is used for public NAT.
6239 &quot;A String&quot;,
6240 ],
6241 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
6242 # drained. This is only supported on patch/update, and these
6243 # subnetworks must have previously been used as active ranges in this
6244 # NAT Rule.
6245 # This field is used for private NAT.
6246 &quot;A String&quot;,
6247 ],
6248 },
6249 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
6250 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
6251 # from a VM is evaluated against. If it evaluates to true, the
6252 # corresponding `action` is enforced.
6253 #
6254 # The following examples are valid match expressions for public NAT:
6255 #
6256 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
6257 # &#x27;2.2.0.0/16&#x27;)`
6258 #
6259 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
6260 #
6261 # The following example is a valid match expression for private NAT:
6262 #
6263 # `nexthop.hub ==
6264 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
6265 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
6266 # must be a positive value between 0 and 65000, and
6267 # must be unique among rules within a NAT.
6268 &quot;sourceWorkloadIdentities&quot;: [ # A list of source workload identities.
6269 &quot;A String&quot;,
6270 ],
6271 },
6272 ],
6273 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
6274 #
6275 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
6276 # Subnetwork are allowed to Nat.
6277 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
6278 # in every Subnetwork are allowed to Nat.
6279 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
6280 # (specified in the field subnetwork below)
6281 #
6282 #
6283 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
6284 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
6285 # should not be any other Router.Nat section in any Router for this network
6286 # in this region.
6287 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
6288 # values:
6289 #
6290 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
6291 # every Subnetwork are allowed to Nat.
6292 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
6293 # (specified in the field nat64_subnetwork below)
6294 #
6295 #
6296 # The default is NAT64_OPTION_UNSPECIFIED.
6297 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
6298 # Router.Nat section in this region can also enable NAT64 for any
6299 # Subnetworks in this network. Other Router.Nat sections can still be
6300 # present to enable NAT44 only.
6301 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
6302 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
6303 # SubnetworkIpRangeToNatOption above.
6304 { # Defines the IP ranges that want to use NAT for a subnetwork.
6305 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
6306 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
6307 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
6308 # is one of the values in source_ip_ranges_to_nat.
6309 &quot;A String&quot;,
6310 ],
6311 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
6312 # options of a single value are valid except
6313 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
6314 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
6315 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
6316 # Default: [ALL_IP_RANGES]
6317 &quot;A String&quot;,
6318 ],
6319 },
6320 ],
6321 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
6322 # if not set.
6323 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
6324 # Defaults to 120s if not set.
6325 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
6326 # not set.
6327 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
6328 # translation. If unspecified, it defaults to PUBLIC.
6329 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
6330 },
6331 ],
6332 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
6333 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
6334 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
6335 # as part of resource payload.
6336 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
6337 # The field is allowed for INSERT
6338 # only. The keys/values to set on the resource should be specified in
6339 # either ID { : } or Namespaced format
6340 # { : }.
6341 # For example the following are valid inputs:
6342 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
6343 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
6344 # Note:
6345 # * Invalid combinations of ID &amp; namespaced format is not supported. For
6346 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
6347 # * Inconsistent format is not supported. For instance:
6348 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
6349 &quot;a_key&quot;: &quot;A String&quot;,
6350 },
6351 },
6352 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
6353 # You must specify this field as part of the HTTP request URL. It is
6354 # not settable as a field in the request body.
6355 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6356 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6357 }
6358
6359 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6360 that if you must retry your request, the server will know to ignore the
6361 request if it has already been completed.
6362
6363 For example, consider a situation where you make an initial request and
6364 the request times out. If you make the request again with the same
6365 request ID, the server can check if original operation with the same
6366 request ID was received, and if so, will ignore the second request. This
6367 prevents clients from accidentally creating duplicate commitments.
6368
6369 The request ID must be
6370 a valid UUID with the exception that zero UUID is not supported
6371 (00000000-0000-0000-0000-000000000000).
6372 x__xgafv: string, V1 error format.
6373 Allowed values
6374 1 - v1 error format
6375 2 - v2 error format
6376
6377 Returns:
6378 An object of the form:
6379
6380 { # Represents an Operation resource.
6381 #
6382 # Google Compute Engine has three Operation resources:
6383 #
6384 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6385 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6386 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6387 #
6388 # You can use an operation resource to manage asynchronous API requests.
6389 # For more information, readHandling
6390 # API responses.
6391 #
6392 # Operations can be global, regional or zonal.
6393 #
6394 # - For global operations, use the `globalOperations`
6395 # resource.
6396 # - For regional operations, use the
6397 # `regionOperations` resource.
6398 # - For zonal operations, use
6399 # the `zoneOperations` resource.
6400 #
6401 #
6402 #
6403 # For more information, read
6404 # Global, Regional, and Zonal Resources.
6405 #
6406 # Note that completed Operation resources have a limited
6407 # retention period.
6408 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6409 # Not present otherwise.
6410 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6411 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6412 # set when the operation is created.
6413 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6414 # text format.
6415 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6416 # this field will be populated.
6417 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6418 # operation.
6419 {
6420 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6421 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6422 # details. There is a set of defined message types to use for providing
6423 # details.The syntax depends on the error code. For example,
6424 # QuotaExceededInfo will have details when the error code is
6425 # QUOTA_EXCEEDED.
6426 {
6427 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6428 #
6429 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6430 # is not enabled:
6431 #
6432 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6433 # &quot;domain&quot;: &quot;googleapis.com&quot;
6434 # &quot;metadata&quot;: {
6435 # &quot;resource&quot;: &quot;projects/123&quot;,
6436 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6437 # }
6438 # }
6439 #
6440 # This response indicates that the pubsub.googleapis.com API is not enabled.
6441 #
6442 # Example of an error that is returned when attempting to create a Spanner
6443 # instance in a region that is out of stock:
6444 #
6445 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6446 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6447 # &quot;metadata&quot;: {
6448 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6449 # }
6450 # }
6451 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6452 # is typically the registered service name of the tool or product that
6453 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6454 # generated by some common infrastructure, the error domain must be a
6455 # globally unique value that identifies the infrastructure. For Google API
6456 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6457 &quot;metadatas&quot;: { # Additional structured details about this error.
6458 #
6459 # Keys must match a regular expression of `a-z+` but should
6460 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6461 # length. When identifying the current value of an exceeded limit, the units
6462 # should be contained in the key, not the value. For example, rather than
6463 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6464 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6465 # instances that can be created in a single (batch) request.
6466 &quot;a_key&quot;: &quot;A String&quot;,
6467 },
6468 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6469 # proximate cause of the error. Error reasons are unique within a particular
6470 # domain of errors. This should be at most 63 characters and match a
6471 # regular expression of `A-Z+[A-Z0-9]`, which represents
6472 # UPPER_SNAKE_CASE.
6473 },
6474 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6475 #
6476 # For example, if a quota check failed with an error indicating the calling
6477 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6478 # directly to the right place in the developer console to flip the bit.
6479 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6480 { # Describes a URL link.
6481 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6482 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6483 },
6484 ],
6485 },
6486 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6487 # which can be attached to an RPC error.
6488 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6489 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6490 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6491 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6492 },
6493 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6494 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6495 &quot;a_key&quot;: &quot;A String&quot;,
6496 },
6497 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6498 # type or metric.
6499 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6500 # or metric.
6501 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6502 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6503 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6504 },
6505 },
6506 ],
6507 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6508 # This property is optional.
6509 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6510 },
6511 ],
6512 },
6513 &quot;getVersionOperationMetadata&quot;: {
6514 &quot;inlineSbomInfo&quot;: {
6515 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6516 # appropriate identifiers.
6517 &quot;a_key&quot;: &quot;A String&quot;,
6518 },
6519 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6520 # identifiers.
6521 &quot;a_key&quot;: &quot;A String&quot;,
6522 },
6523 },
6524 },
6525 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6526 # message that was returned, such as `NOT FOUND`.
6527 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6528 # status code that was returned. For example, a `404` means the
6529 # resource was not found.
6530 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6531 # defined by the server.
6532 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6533 # This value is inRFC3339
6534 # text format.
6535 &quot;instancesBulkInsertOperationMetadata&quot;: {
6536 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6537 # Example key: zones/us-central1-a
6538 &quot;a_key&quot;: {
6539 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6540 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6541 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6542 # error.
6543 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6544 # if the flow is rolling forward or rolling back.
6545 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6546 },
6547 },
6548 },
6549 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6550 # Operation resources.
6551 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6552 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6553 # group of operations results from a `bulkInsert` API request.
6554 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6555 # `update`, or `delete`, and so on.
6556 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6557 # There is no requirement that this be linear or support any granularity of
6558 # operations. This should not be used to guess when the operation will be
6559 # complete. This number should monotonically increase as the operation
6560 # progresses.
6561 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6562 # applicable when performing regional operations.
6563 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6564 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6565 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6566 # this field will contain information on all underlying zonal actions and
6567 # their state.
6568 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6569 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6570 # Example key: zones/us-central1-a
6571 &quot;a_key&quot;: {
6572 &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
6573 # populated.
6574 # different programming environments, including REST APIs and RPC APIs. It is
6575 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6576 # three pieces of data: error code, error message, and error details.
6577 #
6578 # You can find out more about this error model and how to work with it in the
6579 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6580 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6581 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6582 # message types for APIs to use.
6583 {
6584 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6585 },
6586 ],
6587 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6588 # user-facing error message should be localized and sent in the
6589 # google.rpc.Status.details field, or localized by the client.
6590 },
6591 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6592 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6593 },
6594 },
6595 },
6596 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6597 # This value is inRFC3339
6598 # text format.
6599 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6600 # following:
6601 # `PENDING`, `RUNNING`, or `DONE`.
6602 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6603 # operation.
6604 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6605 # of the target resource.
6606 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6607 # operations related to creating a snapshot, this points to the disk
6608 # that the snapshot was created from.
6609 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6610 # `[email protected]` or
6611 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6612 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6613 # operation, this field will be populated.
6614 {
6615 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6616 # Engine returns NO_RESULTS_ON_PAGE if there
6617 # are no results in the response.
6618 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6619 # value format. For example:
6620 #
6621 # &quot;data&quot;: [
6622 # {
6623 # &quot;key&quot;: &quot;scope&quot;,
6624 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6625 # }
6626 {
6627 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6628 # returned. For example, for warnings where there are no results in a list
6629 # request for a particular zone, this key might be scope and
6630 # the key value might be the zone name. Other examples might be a key
6631 # indicating a deprecated resource and a suggested replacement, or a
6632 # warning about invalid network settings (for example, if an instance
6633 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6634 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6635 },
6636 ],
6637 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6638 },
6639 ],
6640 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6641 # applicable when performing per-zone operations.
6642 }</pre>
6643 </div>
6644
6645 <div class="method">
6646 <code class="details" id="patchNamedSet">patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
6647 <pre>Patches Named Set
6648
6649 Args:
6650 project: string, Project ID for this request. (required)
6651 region: string, Name of the region for this request. (required)
6652 router: string, Name of the Router resource where Named Set is defined. (required)
6653 body: object, The request body.
6654 The object takes the form of:
6655
6656 {
6657 &quot;description&quot;: &quot;A String&quot;, # An optional description of named set.
6658 &quot;elements&quot;: [ # CEL expressions that are comparable to constructs of this set&#x27;s type
6659 # (see Policy Language).
6660 { # Represents a textual expression in the Common Expression Language (CEL)
6661 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6662 # are documented at https://github.com/google/cel-spec.
6663 #
6664 # Example (Comparison):
6665 #
6666 # title: &quot;Summary size limit&quot;
6667 # description: &quot;Determines if a summary is less than 100 chars&quot;
6668 # expression: &quot;document.summary.size() &lt; 100&quot;
6669 #
6670 # Example (Equality):
6671 #
6672 # title: &quot;Requestor is owner&quot;
6673 # description: &quot;Determines if requestor is the document owner&quot;
6674 # expression: &quot;document.owner == request.auth.claims.email&quot;
6675 #
6676 # Example (Logic):
6677 #
6678 # title: &quot;Public documents&quot;
6679 # description: &quot;Determine whether the document should be publicly visible&quot;
6680 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6681 #
6682 # Example (Data Manipulation):
6683 #
6684 # title: &quot;Notification string&quot;
6685 # description: &quot;Create a notification string with a timestamp.&quot;
6686 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6687 #
6688 # The exact variables and functions that may be referenced within an expression
6689 # are determined by the service that evaluates it. See the service
6690 # documentation for additional information.
6691 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6692 # describes the expression, e.g. when hovered over it in a UI.
6693 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6694 # syntax.
6695 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6696 # reporting, e.g. a file name and a position in the file.
6697 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6698 # its purpose. This can be used e.g. in UIs which allow to enter the
6699 # expression.
6700 },
6701 ],
6702 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Named Set being applied to this Router, which is
6703 # essentially a hash of the Named Set used for optimistic locking.
6704 # The fingerprint is initially generated by Compute Engine and changes
6705 # after every request to modify or update the Named Set. You must always
6706 # provide an up-to-date fingerprint hash in order to update or change
6707 # labels.
6708 #
6709 # To see the latest fingerprint, make a getNamedSet() request
6710 # to retrieve a Named Set.
6711 &quot;name&quot;: &quot;A String&quot;, # This set&#x27;s name, which must be a resource ID segment and unique within all
6712 # named sets owned by the Router. Name should conform to RFC1035.
6713 &quot;type&quot;: &quot;A String&quot;, # This named set&#x27;s type
6714 }
6715
6716 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6717 that if you must retry your request, the server will know to ignore the
6718 request if it has already been completed.
6719
6720 For example, consider a situation where you make an initial request and
6721 the request times out. If you make the request again with the same
6722 request ID, the server can check if original operation with the same
6723 request ID was received, and if so, will ignore the second request. This
6724 prevents clients from accidentally creating duplicate commitments.
6725
6726 The request ID must be
6727 a valid UUID with the exception that zero UUID is not supported
6728 (00000000-0000-0000-0000-000000000000).
6729 x__xgafv: string, V1 error format.
6730 Allowed values
6731 1 - v1 error format
6732 2 - v2 error format
6733
6734 Returns:
6735 An object of the form:
6736
6737 { # Represents an Operation resource.
6738 #
6739 # Google Compute Engine has three Operation resources:
6740 #
6741 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6742 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6743 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6744 #
6745 # You can use an operation resource to manage asynchronous API requests.
6746 # For more information, readHandling
6747 # API responses.
6748 #
6749 # Operations can be global, regional or zonal.
6750 #
6751 # - For global operations, use the `globalOperations`
6752 # resource.
6753 # - For regional operations, use the
6754 # `regionOperations` resource.
6755 # - For zonal operations, use
6756 # the `zoneOperations` resource.
6757 #
6758 #
6759 #
6760 # For more information, read
6761 # Global, Regional, and Zonal Resources.
6762 #
6763 # Note that completed Operation resources have a limited
6764 # retention period.
6765 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6766 # Not present otherwise.
6767 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6768 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6769 # set when the operation is created.
6770 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6771 # text format.
6772 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6773 # this field will be populated.
6774 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6775 # operation.
6776 {
6777 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6778 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6779 # details. There is a set of defined message types to use for providing
6780 # details.The syntax depends on the error code. For example,
6781 # QuotaExceededInfo will have details when the error code is
6782 # QUOTA_EXCEEDED.
6783 {
6784 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6785 #
6786 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6787 # is not enabled:
6788 #
6789 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6790 # &quot;domain&quot;: &quot;googleapis.com&quot;
6791 # &quot;metadata&quot;: {
6792 # &quot;resource&quot;: &quot;projects/123&quot;,
6793 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6794 # }
6795 # }
6796 #
6797 # This response indicates that the pubsub.googleapis.com API is not enabled.
6798 #
6799 # Example of an error that is returned when attempting to create a Spanner
6800 # instance in a region that is out of stock:
6801 #
6802 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6803 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6804 # &quot;metadata&quot;: {
6805 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6806 # }
6807 # }
6808 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6809 # is typically the registered service name of the tool or product that
6810 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6811 # generated by some common infrastructure, the error domain must be a
6812 # globally unique value that identifies the infrastructure. For Google API
6813 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6814 &quot;metadatas&quot;: { # Additional structured details about this error.
6815 #
6816 # Keys must match a regular expression of `a-z+` but should
6817 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6818 # length. When identifying the current value of an exceeded limit, the units
6819 # should be contained in the key, not the value. For example, rather than
6820 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6821 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6822 # instances that can be created in a single (batch) request.
6823 &quot;a_key&quot;: &quot;A String&quot;,
6824 },
6825 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6826 # proximate cause of the error. Error reasons are unique within a particular
6827 # domain of errors. This should be at most 63 characters and match a
6828 # regular expression of `A-Z+[A-Z0-9]`, which represents
6829 # UPPER_SNAKE_CASE.
6830 },
6831 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6832 #
6833 # For example, if a quota check failed with an error indicating the calling
6834 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6835 # directly to the right place in the developer console to flip the bit.
6836 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6837 { # Describes a URL link.
6838 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6839 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6840 },
6841 ],
6842 },
6843 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6844 # which can be attached to an RPC error.
6845 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6846 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6847 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6848 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6849 },
6850 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6851 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6852 &quot;a_key&quot;: &quot;A String&quot;,
6853 },
6854 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6855 # type or metric.
6856 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6857 # or metric.
6858 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6859 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6860 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6861 },
6862 },
6863 ],
6864 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6865 # This property is optional.
6866 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6867 },
6868 ],
6869 },
6870 &quot;getVersionOperationMetadata&quot;: {
6871 &quot;inlineSbomInfo&quot;: {
6872 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6873 # appropriate identifiers.
6874 &quot;a_key&quot;: &quot;A String&quot;,
6875 },
6876 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6877 # identifiers.
6878 &quot;a_key&quot;: &quot;A String&quot;,
6879 },
6880 },
6881 },
6882 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6883 # message that was returned, such as `NOT FOUND`.
6884 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6885 # status code that was returned. For example, a `404` means the
6886 # resource was not found.
6887 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6888 # defined by the server.
6889 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6890 # This value is inRFC3339
6891 # text format.
6892 &quot;instancesBulkInsertOperationMetadata&quot;: {
6893 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6894 # Example key: zones/us-central1-a
6895 &quot;a_key&quot;: {
6896 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6897 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6898 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6899 # error.
6900 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6901 # if the flow is rolling forward or rolling back.
6902 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6903 },
6904 },
6905 },
6906 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6907 # Operation resources.
6908 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6909 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6910 # group of operations results from a `bulkInsert` API request.
6911 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6912 # `update`, or `delete`, and so on.
6913 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6914 # There is no requirement that this be linear or support any granularity of
6915 # operations. This should not be used to guess when the operation will be
6916 # complete. This number should monotonically increase as the operation
6917 # progresses.
6918 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6919 # applicable when performing regional operations.
6920 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6921 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6922 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6923 # this field will contain information on all underlying zonal actions and
6924 # their state.
6925 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6926 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6927 # Example key: zones/us-central1-a
6928 &quot;a_key&quot;: {
6929 &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
6930 # populated.
6931 # different programming environments, including REST APIs and RPC APIs. It is
6932 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6933 # three pieces of data: error code, error message, and error details.
6934 #
6935 # You can find out more about this error model and how to work with it in the
6936 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6937 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6938 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6939 # message types for APIs to use.
6940 {
6941 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6942 },
6943 ],
6944 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6945 # user-facing error message should be localized and sent in the
6946 # google.rpc.Status.details field, or localized by the client.
6947 },
6948 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6949 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6950 },
6951 },
6952 },
6953 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6954 # This value is inRFC3339
6955 # text format.
6956 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6957 # following:
6958 # `PENDING`, `RUNNING`, or `DONE`.
6959 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6960 # operation.
6961 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6962 # of the target resource.
6963 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6964 # operations related to creating a snapshot, this points to the disk
6965 # that the snapshot was created from.
6966 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6967 # `[email protected]` or
6968 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6969 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6970 # operation, this field will be populated.
6971 {
6972 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6973 # Engine returns NO_RESULTS_ON_PAGE if there
6974 # are no results in the response.
6975 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6976 # value format. For example:
6977 #
6978 # &quot;data&quot;: [
6979 # {
6980 # &quot;key&quot;: &quot;scope&quot;,
6981 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6982 # }
6983 {
6984 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6985 # returned. For example, for warnings where there are no results in a list
6986 # request for a particular zone, this key might be scope and
6987 # the key value might be the zone name. Other examples might be a key
6988 # indicating a deprecated resource and a suggested replacement, or a
6989 # warning about invalid network settings (for example, if an instance
6990 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6991 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6992 },
6993 ],
6994 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6995 },
6996 ],
6997 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6998 # applicable when performing per-zone operations.
6999 }</pre>
7000 </div>
7001
7002 <div class="method">
7003 <code class="details" id="patchRoutePolicy">patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
7004 <pre>Patches Route Policy
7005
7006 Args:
7007 project: string, Project ID for this request. (required)
7008 region: string, Name of the region for this request. (required)
7009 router: string, Name of the Router resource where Route Policy is defined. (required)
7010 body: object, The request body.
7011 The object takes the form of:
7012
7013 {
7014 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
7015 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
7016 # essentially a hash of the Route Policy used for optimistic locking.
7017 # The fingerprint is initially generated by Compute Engine and changes
7018 # after every request to modify or update Route Policy. You must always
7019 # provide an up-to-date fingerprint hash in order to update or change
7020 # labels.
7021 #
7022 # To see the latest fingerprint, make a getRoutePolicy() request
7023 # to retrieve a Route Policy.
7024 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
7025 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
7026 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
7027 # in order of priority). Order of policies is not retained and might change
7028 # when getting policy later.
7029 {
7030 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
7031 { # Represents a textual expression in the Common Expression Language (CEL)
7032 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
7033 # are documented at https://github.com/google/cel-spec.
7034 #
7035 # Example (Comparison):
7036 #
7037 # title: &quot;Summary size limit&quot;
7038 # description: &quot;Determines if a summary is less than 100 chars&quot;
7039 # expression: &quot;document.summary.size() &lt; 100&quot;
7040 #
7041 # Example (Equality):
7042 #
7043 # title: &quot;Requestor is owner&quot;
7044 # description: &quot;Determines if requestor is the document owner&quot;
7045 # expression: &quot;document.owner == request.auth.claims.email&quot;
7046 #
7047 # Example (Logic):
7048 #
7049 # title: &quot;Public documents&quot;
7050 # description: &quot;Determine whether the document should be publicly visible&quot;
7051 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
7052 #
7053 # Example (Data Manipulation):
7054 #
7055 # title: &quot;Notification string&quot;
7056 # description: &quot;Create a notification string with a timestamp.&quot;
7057 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
7058 #
7059 # The exact variables and functions that may be referenced within an expression
7060 # are determined by the service that evaluates it. See the service
7061 # documentation for additional information.
7062 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
7063 # describes the expression, e.g. when hovered over it in a UI.
7064 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
7065 # syntax.
7066 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
7067 # reporting, e.g. a file name and a position in the file.
7068 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
7069 # its purpose. This can be used e.g. in UIs which allow to enter the
7070 # expression.
7071 },
7072 ],
7073 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
7074 # applies. When not set, the term applies to all
7075 # routes.
7076 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
7077 # are documented at https://github.com/google/cel-spec.
7078 #
7079 # Example (Comparison):
7080 #
7081 # title: &quot;Summary size limit&quot;
7082 # description: &quot;Determines if a summary is less than 100 chars&quot;
7083 # expression: &quot;document.summary.size() &lt; 100&quot;
7084 #
7085 # Example (Equality):
7086 #
7087 # title: &quot;Requestor is owner&quot;
7088 # description: &quot;Determines if requestor is the document owner&quot;
7089 # expression: &quot;document.owner == request.auth.claims.email&quot;
7090 #
7091 # Example (Logic):
7092 #
7093 # title: &quot;Public documents&quot;
7094 # description: &quot;Determine whether the document should be publicly visible&quot;
7095 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
7096 #
7097 # Example (Data Manipulation):
7098 #
7099 # title: &quot;Notification string&quot;
7100 # description: &quot;Create a notification string with a timestamp.&quot;
7101 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
7102 #
7103 # The exact variables and functions that may be referenced within an expression
7104 # are determined by the service that evaluates it. See the service
7105 # documentation for additional information.
7106 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
7107 # describes the expression, e.g. when hovered over it in a UI.
7108 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
7109 # syntax.
7110 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
7111 # reporting, e.g. a file name and a position in the file.
7112 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
7113 # its purpose. This can be used e.g. in UIs which allow to enter the
7114 # expression.
7115 },
7116 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
7117 # (inclusive) and 2^31 (exclusive), and unique within the list.
7118 },
7119 ],
7120 &quot;type&quot;: &quot;A String&quot;,
7121 }
7122
7123 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7124 that if you must retry your request, the server will know to ignore the
7125 request if it has already been completed.
7126
7127 For example, consider a situation where you make an initial request and
7128 the request times out. If you make the request again with the same
7129 request ID, the server can check if original operation with the same
7130 request ID was received, and if so, will ignore the second request. This
7131 prevents clients from accidentally creating duplicate commitments.
7132
7133 The request ID must be
7134 a valid UUID with the exception that zero UUID is not supported
7135 (00000000-0000-0000-0000-000000000000).
7136 x__xgafv: string, V1 error format.
7137 Allowed values
7138 1 - v1 error format
7139 2 - v2 error format
7140
7141 Returns:
7142 An object of the form:
7143
7144 { # Represents an Operation resource.
7145 #
7146 # Google Compute Engine has three Operation resources:
7147 #
7148 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
7149 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
7150 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
7151 #
7152 # You can use an operation resource to manage asynchronous API requests.
7153 # For more information, readHandling
7154 # API responses.
7155 #
7156 # Operations can be global, regional or zonal.
7157 #
7158 # - For global operations, use the `globalOperations`
7159 # resource.
7160 # - For regional operations, use the
7161 # `regionOperations` resource.
7162 # - For zonal operations, use
7163 # the `zoneOperations` resource.
7164 #
7165 #
7166 #
7167 # For more information, read
7168 # Global, Regional, and Zonal Resources.
7169 #
7170 # Note that completed Operation resources have a limited
7171 # retention period.
7172 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7173 # Not present otherwise.
7174 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7175 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7176 # set when the operation is created.
7177 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7178 # text format.
7179 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7180 # this field will be populated.
7181 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7182 # operation.
7183 {
7184 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7185 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7186 # details. There is a set of defined message types to use for providing
7187 # details.The syntax depends on the error code. For example,
7188 # QuotaExceededInfo will have details when the error code is
7189 # QUOTA_EXCEEDED.
7190 {
7191 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7192 #
7193 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7194 # is not enabled:
7195 #
7196 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7197 # &quot;domain&quot;: &quot;googleapis.com&quot;
7198 # &quot;metadata&quot;: {
7199 # &quot;resource&quot;: &quot;projects/123&quot;,
7200 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7201 # }
7202 # }
7203 #
7204 # This response indicates that the pubsub.googleapis.com API is not enabled.
7205 #
7206 # Example of an error that is returned when attempting to create a Spanner
7207 # instance in a region that is out of stock:
7208 #
7209 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7210 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7211 # &quot;metadata&quot;: {
7212 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7213 # }
7214 # }
7215 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7216 # is typically the registered service name of the tool or product that
7217 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7218 # generated by some common infrastructure, the error domain must be a
7219 # globally unique value that identifies the infrastructure. For Google API
7220 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7221 &quot;metadatas&quot;: { # Additional structured details about this error.
7222 #
7223 # Keys must match a regular expression of `a-z+` but should
7224 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7225 # length. When identifying the current value of an exceeded limit, the units
7226 # should be contained in the key, not the value. For example, rather than
7227 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7228 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7229 # instances that can be created in a single (batch) request.
7230 &quot;a_key&quot;: &quot;A String&quot;,
7231 },
7232 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7233 # proximate cause of the error. Error reasons are unique within a particular
7234 # domain of errors. This should be at most 63 characters and match a
7235 # regular expression of `A-Z+[A-Z0-9]`, which represents
7236 # UPPER_SNAKE_CASE.
7237 },
7238 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7239 #
7240 # For example, if a quota check failed with an error indicating the calling
7241 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7242 # directly to the right place in the developer console to flip the bit.
7243 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7244 { # Describes a URL link.
7245 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7246 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7247 },
7248 ],
7249 },
7250 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7251 # which can be attached to an RPC error.
7252 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7253 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7254 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7255 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7256 },
7257 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7258 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7259 &quot;a_key&quot;: &quot;A String&quot;,
7260 },
7261 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7262 # type or metric.
7263 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7264 # or metric.
7265 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7266 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7267 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7268 },
7269 },
7270 ],
7271 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7272 # This property is optional.
7273 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7274 },
7275 ],
7276 },
7277 &quot;getVersionOperationMetadata&quot;: {
7278 &quot;inlineSbomInfo&quot;: {
7279 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7280 # appropriate identifiers.
7281 &quot;a_key&quot;: &quot;A String&quot;,
7282 },
7283 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7284 # identifiers.
7285 &quot;a_key&quot;: &quot;A String&quot;,
7286 },
7287 },
7288 },
7289 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7290 # message that was returned, such as `NOT FOUND`.
7291 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7292 # status code that was returned. For example, a `404` means the
7293 # resource was not found.
7294 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7295 # defined by the server.
7296 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7297 # This value is inRFC3339
7298 # text format.
7299 &quot;instancesBulkInsertOperationMetadata&quot;: {
7300 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7301 # Example key: zones/us-central1-a
7302 &quot;a_key&quot;: {
7303 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7304 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7305 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7306 # error.
7307 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7308 # if the flow is rolling forward or rolling back.
7309 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7310 },
7311 },
7312 },
7313 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7314 # Operation resources.
7315 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7316 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7317 # group of operations results from a `bulkInsert` API request.
7318 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7319 # `update`, or `delete`, and so on.
7320 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7321 # There is no requirement that this be linear or support any granularity of
7322 # operations. This should not be used to guess when the operation will be
7323 # complete. This number should monotonically increase as the operation
7324 # progresses.
7325 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7326 # applicable when performing regional operations.
7327 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7328 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7329 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7330 # this field will contain information on all underlying zonal actions and
7331 # their state.
7332 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7333 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7334 # Example key: zones/us-central1-a
7335 &quot;a_key&quot;: {
7336 &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
7337 # populated.
7338 # different programming environments, including REST APIs and RPC APIs. It is
7339 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7340 # three pieces of data: error code, error message, and error details.
7341 #
7342 # You can find out more about this error model and how to work with it in the
7343 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7344 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7345 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7346 # message types for APIs to use.
7347 {
7348 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7349 },
7350 ],
7351 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7352 # user-facing error message should be localized and sent in the
7353 # google.rpc.Status.details field, or localized by the client.
7354 },
7355 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7356 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7357 },
7358 },
7359 },
7360 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7361 # This value is inRFC3339
7362 # text format.
7363 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7364 # following:
7365 # `PENDING`, `RUNNING`, or `DONE`.
7366 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7367 # operation.
7368 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7369 # of the target resource.
7370 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7371 # operations related to creating a snapshot, this points to the disk
7372 # that the snapshot was created from.
7373 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7374 # `[email protected]` or
7375 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7376 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7377 # operation, this field will be populated.
7378 {
7379 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7380 # Engine returns NO_RESULTS_ON_PAGE if there
7381 # are no results in the response.
7382 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7383 # value format. For example:
7384 #
7385 # &quot;data&quot;: [
7386 # {
7387 # &quot;key&quot;: &quot;scope&quot;,
7388 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7389 # }
7390 {
7391 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7392 # returned. For example, for warnings where there are no results in a list
7393 # request for a particular zone, this key might be scope and
7394 # the key value might be the zone name. Other examples might be a key
7395 # indicating a deprecated resource and a suggested replacement, or a
7396 # warning about invalid network settings (for example, if an instance
7397 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7398 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7399 },
7400 ],
7401 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7402 },
7403 ],
7404 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7405 # applicable when performing per-zone operations.
7406 }</pre>
7407 </div>
7408
7409 <div class="method">
7410 <code class="details" id="preview">preview(project, region, router, body=None, x__xgafv=None)</code>
7411 <pre>Preview fields auto-generated during router create andupdate operations.
7412 Calling this method does NOT create or update the router.
7413
7414 Args:
7415 project: string, Project ID for this request. (required)
7416 region: string, Name of the region for this request. (required)
7417 router: string, Name of the Router resource to query. (required)
7418 body: object, The request body.
7419 The object takes the form of:
7420
7421 { # Represents a Cloud Router resource.
7422 #
7423 # For more information about Cloud Router, read theCloud
7424 # Router overview.
7425 &quot;bgp&quot;: { # BGP information specific to this router.
7426 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
7427 # The options are DEFAULT or CUSTOM.
7428 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
7429 # This field can only be populated if advertise_mode is CUSTOM and
7430 # is advertised to all peers of the router.
7431 # These groups will be advertised in addition to any specified prefixes.
7432 # Leave this field blank to advertise no custom groups.
7433 &quot;A String&quot;,
7434 ],
7435 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
7436 # This field can only be populated if advertise_mode is CUSTOM and
7437 # is advertised to all peers of the router.
7438 # These IP ranges will be advertised in addition to any specified groups.
7439 # Leave this field blank to advertise no custom IP ranges.
7440 { # Description-tagged IP ranges for the router to advertise.
7441 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
7442 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
7443 },
7444 ],
7445 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
7446 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
7447 # value will be fixed for this router resource. All VPN tunnels that link
7448 # to this router will have the same local ASN.
7449 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
7450 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
7451 # least /30, even if the BGP sessions are over IPv6. It must not overlap
7452 # with any IPv4 BGP session ranges.
7453 #
7454 #
7455 # Other vendors commonly call this &quot;router ID&quot;.
7456 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
7457 # sent to the peer.
7458 #
7459 #
7460 # Hold time is three times the interval at which keepalive messages are
7461 # sent, and the hold time is the maximum number of seconds allowed to
7462 # elapse between successive keepalive messages that BGP receives from a
7463 # peer.
7464 #
7465 #
7466 # BGP will use the smaller of either the local hold time value or the
7467 # peer&#x27;s hold time value as the hold time for the BGP connection between
7468 # the two peers.
7469 #
7470 #
7471 # If set, this value must be between 20 and 60. The default is 20.
7472 },
7473 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
7474 # establish BGP peering. This information must specify the peer ASN and
7475 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
7476 {
7477 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
7478 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
7479 # which currently supports the following option:
7480 #
7481 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
7482 # excludes any routes learned for subnets that use
7483 # VPC Network Peering.
7484 #
7485 #
7486 # Note that this field can only be populated if advertise_mode is CUSTOM
7487 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
7488 # These groups are advertised in addition to any specified prefixes.
7489 # Leave this field blank to advertise no custom groups.
7490 &quot;A String&quot;,
7491 ],
7492 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
7493 # This field can only be populated if advertise_mode is CUSTOM and
7494 # overrides the list defined for the router (in the &quot;bgp&quot; message).
7495 # These IP ranges are advertised in addition to any specified groups.
7496 # Leave this field blank to advertise no custom IP ranges.
7497 { # Description-tagged IP ranges for the router to advertise.
7498 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
7499 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
7500 },
7501 ],
7502 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
7503 # than one matching route of maximum length, the routes with the lowest
7504 # priority value win.
7505 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
7506 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
7507 # received from the peer router. The actual value is negotiated between
7508 # the two routers and is equal to the greater of this value and the
7509 # transmit interval of the other router.
7510 #
7511 #
7512 # If set, this value must be between 1000 and 30000.
7513 #
7514 #
7515 # The default is 1000.
7516 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
7517 # transmitted to the peer router. The actual value is negotiated between
7518 # the two routers and is equal to the greater of this value and the
7519 # corresponding receive interval of the other router.
7520 #
7521 #
7522 # If set, this value must be between 1000 and 30000.
7523 #
7524 #
7525 # The default is 1000.
7526 &quot;mode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
7527 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
7528 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
7529 # peer router to initiate the BFD session for this BGP peer. If set to
7530 # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.
7531 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
7532 # before BFD declares that a peer is unavailable.
7533 #
7534 #
7535 # If set, the value must be a value between 5 and 16.
7536 #
7537 #
7538 # The default is 5.
7539 &quot;packetMode&quot;: &quot;A String&quot;, # The BFD packet mode for this BGP peer.
7540 # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer.
7541 # In this mode, if the peer router also has BFD echo mode enabled, BFD
7542 # echo packets will be sent to the other router. If the peer router does
7543 # not have BFD echo mode enabled, only control packets will be sent. If
7544 # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If
7545 # this router and the peer router have a multihop connection, this should
7546 # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop
7547 # connections. The default is CONTROL_AND_ECHO.
7548 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
7549 #
7550 #
7551 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
7552 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
7553 # peer router to initiate the BFD session for this BGP peer. If set to
7554 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
7555 &quot;slowTimerInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
7556 # transmitted to and received from the peer router when BFD echo mode is
7557 # enabled on both routers. The actual transmit and receive intervals are
7558 # negotiated between the two routers and are equal to the greater of this
7559 # value and the corresponding interval on the other router.
7560 # If set, this value must be between 1000 and 30000.
7561 # The default is 5000.
7562 },
7563 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
7564 # session.
7565 {
7566 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
7567 # CIDR-formatted prefix. If an IP address is provided without a subnet
7568 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
7569 # range, and, for IPv6, `/128`.
7570 },
7571 ],
7572 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
7573 # value is applied to all custom learned route ranges for the session.
7574 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
7575 # value, Google Cloud assigns a priority of `100` to the ranges.
7576 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
7577 #
7578 #
7579 # If set to FALSE, any active session with the peer is terminated and
7580 # all associated routing information is removed. If set to TRUE, the
7581 # peer connection can be established with routing information. The default
7582 # is TRUE.
7583 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
7584 # the peerIpAddress is version 4.
7585 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
7586 # peerIpAddress is version 6.
7587 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
7588 # evaluated. The name must correspond to an existing policy that has
7589 # ROUTE_POLICY_TYPE_EXPORT type.
7590 &quot;A String&quot;,
7591 ],
7592 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
7593 # evaluated. The name must correspond to an existing policy that has
7594 # ROUTE_POLICY_TYPE_IMPORT type.
7595 &quot;A String&quot;,
7596 ],
7597 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
7598 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
7599 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
7600 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
7601 &quot;linkedCustomHardware&quot;: &quot;A String&quot;, # The linked custom hardware resource.
7602 # The URI of the custom hardware link attachment
7603 # is where you will establish the BGP session from the Cloud Router.
7604 # This link attachment must reside in the same subnetwork as the associated
7605 # router interface.
7606 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
7607 #
7608 # - MANAGED_BY_USER is the default value and can be managed by you
7609 # or other users
7610 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
7611 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
7612 # PARTNER. Google automatically creates, updates, and deletes this type of
7613 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
7614 # or deleted.
7615 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
7616 # name of one of the entries in the Router.md5_authentication_keys. The
7617 # field must comply with RFC1035.
7618 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
7619 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
7620 # characters long and match the regular expression
7621 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7622 # lowercase letter, and all following characters must be a dash, lowercase
7623 # letter, or digit, except the last character, which cannot be a dash.
7624 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
7625 # a different value.
7626 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
7627 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
7628 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
7629 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
7630 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
7631 # Appliances. The VM instance must be located in zones contained in the
7632 # same region as this Cloud Router.
7633 # The VM instance is the peer side of the BGP session.
7634 },
7635 ],
7636 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7637 # text format.
7638 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7639 # create the resource.
7640 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
7641 # attachments (interconnectAttachments).
7642 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
7643 # defined by the server.
7644 &quot;interfaces&quot;: [ # Router interfaces.
7645 # To create a BGP peer that uses a router interface,
7646 # the interface must have one of the following fields specified:
7647 #
7648 # - linkedVpnTunnel
7649 # - linkedInterconnectAttachment
7650 # - subnetwork
7651 #
7652 #
7653 # You can create a router interface without any of these fields specified.
7654 # However, you cannot create a BGP peer that uses that interface.
7655 {
7656 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
7657 #
7658 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
7659 # be a CIDR-formatted string, for example, 169.254.0.1/30.
7660 # Note: Do not truncate the IP address, as it represents the IP address of
7661 # the interface.
7662 # - For Internet Protocol version 6 (IPv6), the value
7663 # must be a unique local address (ULA) range from fdff:1::/64
7664 # with a mask length of 126 or less. This value should be a CIDR-formatted
7665 # string, for example, fdff:1::1/112. Within the router&#x27;s
7666 # VPC, this IPv6 prefix will be reserved exclusively for this connection
7667 # and cannot be used for any other purpose.
7668 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
7669 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
7670 # as the router. Each interface can have one linked resource, which can be
7671 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
7672 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
7673 # router. Each interface can have one linked resource, which can be
7674 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
7675 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
7676 #
7677 # - MANAGED_BY_USER is the default value and can be managed directly
7678 # by users.
7679 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
7680 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
7681 # of type PARTNER. Google automatically creates, updates, and deletes
7682 # this type of interface when the PARTNER InterconnectAttachment is
7683 # created, updated, or deleted.
7684 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
7685 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
7686 # characters long and match the regular expression
7687 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7688 # lowercase letter, and all following characters must be a dash, lowercase
7689 # letter, or digit, except the last character, which cannot be a dash.
7690 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
7691 # BGP sessions to a VM instance acting as a third-party
7692 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
7693 # an SD-WAN VM.
7694 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
7695 # you are creating. The redundantInterface must belong to the same Cloud
7696 # Router as the interface here. To establish the BGP session to a Router
7697 # Appliance VM, you must create two BGP peers. The two BGP peers must be
7698 # attached to two separate interfaces that are redundant with each other.
7699 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
7700 # be 1-63 characters long and match the regular expression
7701 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7702 # lowercase letter, and all following characters must be a dash, lowercase
7703 # letter, or digit, except the last character, which cannot be a dash.
7704 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
7705 # must be in the same region as the Cloud Router.
7706 # When you establish a BGP session to a VM instance using this interface,
7707 # the VM instance must belong to the same subnetwork as the subnetwork
7708 # specified here.
7709 },
7710 ],
7711 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
7712 # routers.
7713 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
7714 {
7715 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
7716 #
7717 # For patch and update calls, it can be skipped to
7718 # copy the value from the previous configuration. This is allowed if the
7719 # key with the same name existed before the operation. Maximum length is 80
7720 # characters. Can only contain printable ASCII characters.
7721 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
7722 #
7723 # Must be unique within a router. Must be referenced by exactly
7724 # one bgpPeer. Must comply withRFC1035.
7725 },
7726 ],
7727 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
7728 # The name must be 1-63 characters long, and comply withRFC1035.
7729 # Specifically, the name must be 1-63 characters long and match the regular
7730 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7731 # character must be a lowercase letter, and all following characters must
7732 # be a dash, lowercase letter, or digit, except the last character, which
7733 # cannot be a dash.
7734 &quot;nats&quot;: [ # A list of NAT services created in this router.
7735 { # Represents a Nat resource. It enables the VMs within the specified
7736 # subnetworks to access Internet without external IP addresses. It specifies
7737 # a list of subnetworks (and the ranges within) that want to use NAT.
7738 # Customers can also provide the external IPs that would be used for NAT. GCP
7739 # would auto-allocate ephemeral IPs if no external IPs are provided.
7740 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
7741 # Must be one of: PREMIUM, STANDARD.
7742 # If not specified, then the current
7743 # project-level default tier is used.
7744 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
7745 # must be valid static external IPs that have been assigned to the NAT.
7746 # These IPs should be used for updating/patching a NAT only.
7747 &quot;A String&quot;,
7748 ],
7749 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
7750 # state. This value is equal to tcp_time_wait_timeout_sec.
7751 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
7752 # 120s. The field is output only.
7753 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
7754 #
7755 #
7756 # If not specified, it is disabled by default.
7757 #
7758 #
7759 # If set to true,
7760 #
7761 # - Dynamic Port Allocation will be enabled on this NAT
7762 # config.
7763 # - enableEndpointIndependentMapping cannot be set to true.
7764 # - If minPorts is set, minPortsPerVm must be set to a
7765 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
7766 # minimum of 32 ports will be allocated to a VM from this NAT
7767 # config.
7768 &quot;enableEndpointIndependentMapping&quot;: True or False,
7769 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
7770 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
7771 &quot;A String&quot;,
7772 ],
7773 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
7774 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
7775 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
7776 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
7777 # logs are exported for all connections handled by this NAT.
7778 # This option can take one of the following values:
7779 #
7780 # - ERRORS_ONLY: Export logs only for connection failures.
7781 # - TRANSLATIONS_ONLY: Export logs only for successful
7782 # connections.
7783 # - ALL: Export logs for all connections, successful and
7784 # unsuccessful.
7785 },
7786 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
7787 # Dynamic Port Allocation is enabled.
7788 #
7789 #
7790 # If Dynamic Port Allocation is not enabled, this field has no effect.
7791 #
7792 #
7793 # If Dynamic Port Allocation is enabled, and this field is set, it must be
7794 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
7795 # is not set.
7796 #
7797 #
7798 # If Dynamic Port Allocation is enabled and this field is not set,
7799 # a maximum of 65536 ports will be allocated to a VM from this NAT
7800 # config.
7801 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
7802 # set, a default number of ports is allocated to a VM. This is rounded
7803 # up to the nearest power of 2. For example, if the value of this field is
7804 # 50, at least 64 ports are allocated to a VM.
7805 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
7806 # The name must be 1-63 characters long and comply withRFC1035.
7807 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
7808 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
7809 # selected for the SubnetworkIpRangeToNat64Option above.
7810 { # Specifies a subnetwork to enable NAT64.
7811 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
7812 },
7813 ],
7814 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
7815 # values:
7816 #
7817 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
7818 # customers. When there are not enough specified Nat IPs, the Nat service
7819 # fails for new VMs.
7820 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
7821 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
7822 # be empty.
7823 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
7824 # addresses must be valid static external IP addresses assigned to the
7825 # project.
7826 &quot;A String&quot;,
7827 ],
7828 &quot;rules&quot;: [ # A list of rules associated with this NAT.
7829 {
7830 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
7831 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
7832 # addresses must be valid static external IP addresses assigned to the
7833 # project.
7834 # This field is used for public NAT.
7835 &quot;A String&quot;,
7836 ],
7837 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
7838 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
7839 # This field is used for private NAT.
7840 &quot;A String&quot;,
7841 ],
7842 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
7843 # must be valid static external IPs that have been assigned to the NAT.
7844 # These IPs should be used for updating/patching a NAT rule only.
7845 # This field is used for public NAT.
7846 &quot;A String&quot;,
7847 ],
7848 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
7849 # drained. This is only supported on patch/update, and these
7850 # subnetworks must have previously been used as active ranges in this
7851 # NAT Rule.
7852 # This field is used for private NAT.
7853 &quot;A String&quot;,
7854 ],
7855 },
7856 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
7857 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
7858 # from a VM is evaluated against. If it evaluates to true, the
7859 # corresponding `action` is enforced.
7860 #
7861 # The following examples are valid match expressions for public NAT:
7862 #
7863 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
7864 # &#x27;2.2.0.0/16&#x27;)`
7865 #
7866 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
7867 #
7868 # The following example is a valid match expression for private NAT:
7869 #
7870 # `nexthop.hub ==
7871 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
7872 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
7873 # must be a positive value between 0 and 65000, and
7874 # must be unique among rules within a NAT.
7875 &quot;sourceWorkloadIdentities&quot;: [ # A list of source workload identities.
7876 &quot;A String&quot;,
7877 ],
7878 },
7879 ],
7880 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
7881 #
7882 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
7883 # Subnetwork are allowed to Nat.
7884 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
7885 # in every Subnetwork are allowed to Nat.
7886 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
7887 # (specified in the field subnetwork below)
7888 #
7889 #
7890 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
7891 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
7892 # should not be any other Router.Nat section in any Router for this network
7893 # in this region.
7894 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
7895 # values:
7896 #
7897 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
7898 # every Subnetwork are allowed to Nat.
7899 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
7900 # (specified in the field nat64_subnetwork below)
7901 #
7902 #
7903 # The default is NAT64_OPTION_UNSPECIFIED.
7904 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
7905 # Router.Nat section in this region can also enable NAT64 for any
7906 # Subnetworks in this network. Other Router.Nat sections can still be
7907 # present to enable NAT44 only.
7908 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
7909 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
7910 # SubnetworkIpRangeToNatOption above.
7911 { # Defines the IP ranges that want to use NAT for a subnetwork.
7912 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
7913 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
7914 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
7915 # is one of the values in source_ip_ranges_to_nat.
7916 &quot;A String&quot;,
7917 ],
7918 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
7919 # options of a single value are valid except
7920 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
7921 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
7922 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
7923 # Default: [ALL_IP_RANGES]
7924 &quot;A String&quot;,
7925 ],
7926 },
7927 ],
7928 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
7929 # if not set.
7930 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
7931 # Defaults to 120s if not set.
7932 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
7933 # not set.
7934 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
7935 # translation. If unspecified, it defaults to PUBLIC.
7936 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
7937 },
7938 ],
7939 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
7940 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
7941 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
7942 # as part of resource payload.
7943 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
7944 # The field is allowed for INSERT
7945 # only. The keys/values to set on the resource should be specified in
7946 # either ID { : } or Namespaced format
7947 # { : }.
7948 # For example the following are valid inputs:
7949 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
7950 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
7951 # Note:
7952 # * Invalid combinations of ID &amp; namespaced format is not supported. For
7953 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
7954 # * Inconsistent format is not supported. For instance:
7955 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
7956 &quot;a_key&quot;: &quot;A String&quot;,
7957 },
7958 },
7959 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
7960 # You must specify this field as part of the HTTP request URL. It is
7961 # not settable as a field in the request body.
7962 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7963 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7964 }
7965
7966 x__xgafv: string, V1 error format.
7967 Allowed values
7968 1 - v1 error format
7969 2 - v2 error format
7970
7971 Returns:
7972 An object of the form:
7973
7974 {
7975 &quot;resource&quot;: { # Represents a Cloud Router resource. # Preview of given router.
7976 #
7977 # For more information about Cloud Router, read theCloud
7978 # Router overview.
7979 &quot;bgp&quot;: { # BGP information specific to this router.
7980 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
7981 # The options are DEFAULT or CUSTOM.
7982 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
7983 # This field can only be populated if advertise_mode is CUSTOM and
7984 # is advertised to all peers of the router.
7985 # These groups will be advertised in addition to any specified prefixes.
7986 # Leave this field blank to advertise no custom groups.
7987 &quot;A String&quot;,
7988 ],
7989 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
7990 # This field can only be populated if advertise_mode is CUSTOM and
7991 # is advertised to all peers of the router.
7992 # These IP ranges will be advertised in addition to any specified groups.
7993 # Leave this field blank to advertise no custom IP ranges.
7994 { # Description-tagged IP ranges for the router to advertise.
7995 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
7996 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
7997 },
7998 ],
7999 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
8000 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
8001 # value will be fixed for this router resource. All VPN tunnels that link
8002 # to this router will have the same local ASN.
8003 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
8004 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
8005 # least /30, even if the BGP sessions are over IPv6. It must not overlap
8006 # with any IPv4 BGP session ranges.
8007 #
8008 #
8009 # Other vendors commonly call this &quot;router ID&quot;.
8010 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
8011 # sent to the peer.
8012 #
8013 #
8014 # Hold time is three times the interval at which keepalive messages are
8015 # sent, and the hold time is the maximum number of seconds allowed to
8016 # elapse between successive keepalive messages that BGP receives from a
8017 # peer.
8018 #
8019 #
8020 # BGP will use the smaller of either the local hold time value or the
8021 # peer&#x27;s hold time value as the hold time for the BGP connection between
8022 # the two peers.
8023 #
8024 #
8025 # If set, this value must be between 20 and 60. The default is 20.
8026 },
8027 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
8028 # establish BGP peering. This information must specify the peer ASN and
8029 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
8030 {
8031 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
8032 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
8033 # which currently supports the following option:
8034 #
8035 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
8036 # excludes any routes learned for subnets that use
8037 # VPC Network Peering.
8038 #
8039 #
8040 # Note that this field can only be populated if advertise_mode is CUSTOM
8041 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
8042 # These groups are advertised in addition to any specified prefixes.
8043 # Leave this field blank to advertise no custom groups.
8044 &quot;A String&quot;,
8045 ],
8046 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
8047 # This field can only be populated if advertise_mode is CUSTOM and
8048 # overrides the list defined for the router (in the &quot;bgp&quot; message).
8049 # These IP ranges are advertised in addition to any specified groups.
8050 # Leave this field blank to advertise no custom IP ranges.
8051 { # Description-tagged IP ranges for the router to advertise.
8052 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
8053 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
8054 },
8055 ],
8056 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
8057 # than one matching route of maximum length, the routes with the lowest
8058 # priority value win.
8059 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
8060 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
8061 # received from the peer router. The actual value is negotiated between
8062 # the two routers and is equal to the greater of this value and the
8063 # transmit interval of the other router.
8064 #
8065 #
8066 # If set, this value must be between 1000 and 30000.
8067 #
8068 #
8069 # The default is 1000.
8070 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
8071 # transmitted to the peer router. The actual value is negotiated between
8072 # the two routers and is equal to the greater of this value and the
8073 # corresponding receive interval of the other router.
8074 #
8075 #
8076 # If set, this value must be between 1000 and 30000.
8077 #
8078 #
8079 # The default is 1000.
8080 &quot;mode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
8081 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
8082 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
8083 # peer router to initiate the BFD session for this BGP peer. If set to
8084 # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.
8085 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
8086 # before BFD declares that a peer is unavailable.
8087 #
8088 #
8089 # If set, the value must be a value between 5 and 16.
8090 #
8091 #
8092 # The default is 5.
8093 &quot;packetMode&quot;: &quot;A String&quot;, # The BFD packet mode for this BGP peer.
8094 # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer.
8095 # In this mode, if the peer router also has BFD echo mode enabled, BFD
8096 # echo packets will be sent to the other router. If the peer router does
8097 # not have BFD echo mode enabled, only control packets will be sent. If
8098 # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If
8099 # this router and the peer router have a multihop connection, this should
8100 # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop
8101 # connections. The default is CONTROL_AND_ECHO.
8102 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
8103 #
8104 #
8105 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
8106 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
8107 # peer router to initiate the BFD session for this BGP peer. If set to
8108 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
8109 &quot;slowTimerInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
8110 # transmitted to and received from the peer router when BFD echo mode is
8111 # enabled on both routers. The actual transmit and receive intervals are
8112 # negotiated between the two routers and are equal to the greater of this
8113 # value and the corresponding interval on the other router.
8114 # If set, this value must be between 1000 and 30000.
8115 # The default is 5000.
8116 },
8117 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
8118 # session.
8119 {
8120 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
8121 # CIDR-formatted prefix. If an IP address is provided without a subnet
8122 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
8123 # range, and, for IPv6, `/128`.
8124 },
8125 ],
8126 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
8127 # value is applied to all custom learned route ranges for the session.
8128 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
8129 # value, Google Cloud assigns a priority of `100` to the ranges.
8130 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
8131 #
8132 #
8133 # If set to FALSE, any active session with the peer is terminated and
8134 # all associated routing information is removed. If set to TRUE, the
8135 # peer connection can be established with routing information. The default
8136 # is TRUE.
8137 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
8138 # the peerIpAddress is version 4.
8139 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
8140 # peerIpAddress is version 6.
8141 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
8142 # evaluated. The name must correspond to an existing policy that has
8143 # ROUTE_POLICY_TYPE_EXPORT type.
8144 &quot;A String&quot;,
8145 ],
8146 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
8147 # evaluated. The name must correspond to an existing policy that has
8148 # ROUTE_POLICY_TYPE_IMPORT type.
8149 &quot;A String&quot;,
8150 ],
8151 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
8152 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
8153 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
8154 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
8155 &quot;linkedCustomHardware&quot;: &quot;A String&quot;, # The linked custom hardware resource.
8156 # The URI of the custom hardware link attachment
8157 # is where you will establish the BGP session from the Cloud Router.
8158 # This link attachment must reside in the same subnetwork as the associated
8159 # router interface.
8160 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
8161 #
8162 # - MANAGED_BY_USER is the default value and can be managed by you
8163 # or other users
8164 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
8165 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
8166 # PARTNER. Google automatically creates, updates, and deletes this type of
8167 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
8168 # or deleted.
8169 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
8170 # name of one of the entries in the Router.md5_authentication_keys. The
8171 # field must comply with RFC1035.
8172 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
8173 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
8174 # characters long and match the regular expression
8175 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
8176 # lowercase letter, and all following characters must be a dash, lowercase
8177 # letter, or digit, except the last character, which cannot be a dash.
8178 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
8179 # a different value.
8180 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
8181 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
8182 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
8183 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
8184 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
8185 # Appliances. The VM instance must be located in zones contained in the
8186 # same region as this Cloud Router.
8187 # The VM instance is the peer side of the BGP session.
8188 },
8189 ],
8190 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
8191 # text format.
8192 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8193 # create the resource.
8194 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
8195 # attachments (interconnectAttachments).
8196 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
8197 # defined by the server.
8198 &quot;interfaces&quot;: [ # Router interfaces.
8199 # To create a BGP peer that uses a router interface,
8200 # the interface must have one of the following fields specified:
8201 #
8202 # - linkedVpnTunnel
8203 # - linkedInterconnectAttachment
8204 # - subnetwork
8205 #
8206 #
8207 # You can create a router interface without any of these fields specified.
8208 # However, you cannot create a BGP peer that uses that interface.
8209 {
8210 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
8211 #
8212 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
8213 # be a CIDR-formatted string, for example, 169.254.0.1/30.
8214 # Note: Do not truncate the IP address, as it represents the IP address of
8215 # the interface.
8216 # - For Internet Protocol version 6 (IPv6), the value
8217 # must be a unique local address (ULA) range from fdff:1::/64
8218 # with a mask length of 126 or less. This value should be a CIDR-formatted
8219 # string, for example, fdff:1::1/112. Within the router&#x27;s
8220 # VPC, this IPv6 prefix will be reserved exclusively for this connection
8221 # and cannot be used for any other purpose.
8222 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
8223 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
8224 # as the router. Each interface can have one linked resource, which can be
8225 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
8226 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
8227 # router. Each interface can have one linked resource, which can be
8228 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
8229 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
8230 #
8231 # - MANAGED_BY_USER is the default value and can be managed directly
8232 # by users.
8233 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
8234 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
8235 # of type PARTNER. Google automatically creates, updates, and deletes
8236 # this type of interface when the PARTNER InterconnectAttachment is
8237 # created, updated, or deleted.
8238 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
8239 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
8240 # characters long and match the regular expression
8241 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
8242 # lowercase letter, and all following characters must be a dash, lowercase
8243 # letter, or digit, except the last character, which cannot be a dash.
8244 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
8245 # BGP sessions to a VM instance acting as a third-party
8246 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
8247 # an SD-WAN VM.
8248 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
8249 # you are creating. The redundantInterface must belong to the same Cloud
8250 # Router as the interface here. To establish the BGP session to a Router
8251 # Appliance VM, you must create two BGP peers. The two BGP peers must be
8252 # attached to two separate interfaces that are redundant with each other.
8253 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
8254 # be 1-63 characters long and match the regular expression
8255 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
8256 # lowercase letter, and all following characters must be a dash, lowercase
8257 # letter, or digit, except the last character, which cannot be a dash.
8258 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
8259 # must be in the same region as the Cloud Router.
8260 # When you establish a BGP session to a VM instance using this interface,
8261 # the VM instance must belong to the same subnetwork as the subnetwork
8262 # specified here.
8263 },
8264 ],
8265 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
8266 # routers.
8267 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
8268 {
8269 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
8270 #
8271 # For patch and update calls, it can be skipped to
8272 # copy the value from the previous configuration. This is allowed if the
8273 # key with the same name existed before the operation. Maximum length is 80
8274 # characters. Can only contain printable ASCII characters.
8275 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
8276 #
8277 # Must be unique within a router. Must be referenced by exactly
8278 # one bgpPeer. Must comply withRFC1035.
8279 },
8280 ],
8281 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
8282 # The name must be 1-63 characters long, and comply withRFC1035.
8283 # Specifically, the name must be 1-63 characters long and match the regular
8284 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
8285 # character must be a lowercase letter, and all following characters must
8286 # be a dash, lowercase letter, or digit, except the last character, which
8287 # cannot be a dash.
8288 &quot;nats&quot;: [ # A list of NAT services created in this router.
8289 { # Represents a Nat resource. It enables the VMs within the specified
8290 # subnetworks to access Internet without external IP addresses. It specifies
8291 # a list of subnetworks (and the ranges within) that want to use NAT.
8292 # Customers can also provide the external IPs that would be used for NAT. GCP
8293 # would auto-allocate ephemeral IPs if no external IPs are provided.
8294 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
8295 # Must be one of: PREMIUM, STANDARD.
8296 # If not specified, then the current
8297 # project-level default tier is used.
8298 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
8299 # must be valid static external IPs that have been assigned to the NAT.
8300 # These IPs should be used for updating/patching a NAT only.
8301 &quot;A String&quot;,
8302 ],
8303 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
8304 # state. This value is equal to tcp_time_wait_timeout_sec.
8305 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
8306 # 120s. The field is output only.
8307 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
8308 #
8309 #
8310 # If not specified, it is disabled by default.
8311 #
8312 #
8313 # If set to true,
8314 #
8315 # - Dynamic Port Allocation will be enabled on this NAT
8316 # config.
8317 # - enableEndpointIndependentMapping cannot be set to true.
8318 # - If minPorts is set, minPortsPerVm must be set to a
8319 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
8320 # minimum of 32 ports will be allocated to a VM from this NAT
8321 # config.
8322 &quot;enableEndpointIndependentMapping&quot;: True or False,
8323 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
8324 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
8325 &quot;A String&quot;,
8326 ],
8327 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
8328 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
8329 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
8330 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
8331 # logs are exported for all connections handled by this NAT.
8332 # This option can take one of the following values:
8333 #
8334 # - ERRORS_ONLY: Export logs only for connection failures.
8335 # - TRANSLATIONS_ONLY: Export logs only for successful
8336 # connections.
8337 # - ALL: Export logs for all connections, successful and
8338 # unsuccessful.
8339 },
8340 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
8341 # Dynamic Port Allocation is enabled.
8342 #
8343 #
8344 # If Dynamic Port Allocation is not enabled, this field has no effect.
8345 #
8346 #
8347 # If Dynamic Port Allocation is enabled, and this field is set, it must be
8348 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
8349 # is not set.
8350 #
8351 #
8352 # If Dynamic Port Allocation is enabled and this field is not set,
8353 # a maximum of 65536 ports will be allocated to a VM from this NAT
8354 # config.
8355 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
8356 # set, a default number of ports is allocated to a VM. This is rounded
8357 # up to the nearest power of 2. For example, if the value of this field is
8358 # 50, at least 64 ports are allocated to a VM.
8359 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
8360 # The name must be 1-63 characters long and comply withRFC1035.
8361 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
8362 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
8363 # selected for the SubnetworkIpRangeToNat64Option above.
8364 { # Specifies a subnetwork to enable NAT64.
8365 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
8366 },
8367 ],
8368 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
8369 # values:
8370 #
8371 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
8372 # customers. When there are not enough specified Nat IPs, the Nat service
8373 # fails for new VMs.
8374 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
8375 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
8376 # be empty.
8377 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
8378 # addresses must be valid static external IP addresses assigned to the
8379 # project.
8380 &quot;A String&quot;,
8381 ],
8382 &quot;rules&quot;: [ # A list of rules associated with this NAT.
8383 {
8384 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
8385 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
8386 # addresses must be valid static external IP addresses assigned to the
8387 # project.
8388 # This field is used for public NAT.
8389 &quot;A String&quot;,
8390 ],
8391 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
8392 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
8393 # This field is used for private NAT.
8394 &quot;A String&quot;,
8395 ],
8396 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
8397 # must be valid static external IPs that have been assigned to the NAT.
8398 # These IPs should be used for updating/patching a NAT rule only.
8399 # This field is used for public NAT.
8400 &quot;A String&quot;,
8401 ],
8402 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
8403 # drained. This is only supported on patch/update, and these
8404 # subnetworks must have previously been used as active ranges in this
8405 # NAT Rule.
8406 # This field is used for private NAT.
8407 &quot;A String&quot;,
8408 ],
8409 },
8410 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
8411 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
8412 # from a VM is evaluated against. If it evaluates to true, the
8413 # corresponding `action` is enforced.
8414 #
8415 # The following examples are valid match expressions for public NAT:
8416 #
8417 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
8418 # &#x27;2.2.0.0/16&#x27;)`
8419 #
8420 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
8421 #
8422 # The following example is a valid match expression for private NAT:
8423 #
8424 # `nexthop.hub ==
8425 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
8426 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
8427 # must be a positive value between 0 and 65000, and
8428 # must be unique among rules within a NAT.
8429 &quot;sourceWorkloadIdentities&quot;: [ # A list of source workload identities.
8430 &quot;A String&quot;,
8431 ],
8432 },
8433 ],
8434 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
8435 #
8436 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
8437 # Subnetwork are allowed to Nat.
8438 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
8439 # in every Subnetwork are allowed to Nat.
8440 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
8441 # (specified in the field subnetwork below)
8442 #
8443 #
8444 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
8445 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
8446 # should not be any other Router.Nat section in any Router for this network
8447 # in this region.
8448 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
8449 # values:
8450 #
8451 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
8452 # every Subnetwork are allowed to Nat.
8453 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
8454 # (specified in the field nat64_subnetwork below)
8455 #
8456 #
8457 # The default is NAT64_OPTION_UNSPECIFIED.
8458 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
8459 # Router.Nat section in this region can also enable NAT64 for any
8460 # Subnetworks in this network. Other Router.Nat sections can still be
8461 # present to enable NAT44 only.
8462 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
8463 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
8464 # SubnetworkIpRangeToNatOption above.
8465 { # Defines the IP ranges that want to use NAT for a subnetwork.
8466 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
8467 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
8468 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
8469 # is one of the values in source_ip_ranges_to_nat.
8470 &quot;A String&quot;,
8471 ],
8472 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
8473 # options of a single value are valid except
8474 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
8475 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
8476 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
8477 # Default: [ALL_IP_RANGES]
8478 &quot;A String&quot;,
8479 ],
8480 },
8481 ],
8482 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
8483 # if not set.
8484 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
8485 # Defaults to 120s if not set.
8486 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
8487 # not set.
8488 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
8489 # translation. If unspecified, it defaults to PUBLIC.
8490 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
8491 },
8492 ],
8493 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
8494 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
8495 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
8496 # as part of resource payload.
8497 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
8498 # The field is allowed for INSERT
8499 # only. The keys/values to set on the resource should be specified in
8500 # either ID { : } or Namespaced format
8501 # { : }.
8502 # For example the following are valid inputs:
8503 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
8504 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
8505 # Note:
8506 # * Invalid combinations of ID &amp; namespaced format is not supported. For
8507 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
8508 # * Inconsistent format is not supported. For instance:
8509 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
8510 &quot;a_key&quot;: &quot;A String&quot;,
8511 },
8512 },
8513 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
8514 # You must specify this field as part of the HTTP request URL. It is
8515 # not settable as a field in the request body.
8516 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8517 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
8518 },
8519 }</pre>
8520 </div>
8521
8522 <div class="method">
8523 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
8524 <pre>Returns permissions that a caller has on the specified resource.
8525
8526 Args:
8527 project: string, Project ID for this request. (required)
8528 region: string, The name of the region for this request. (required)
8529 resource: string, Name or id of the resource for this request. (required)
8530 body: object, The request body.
8531 The object takes the form of:
8532
8533 {
8534 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
8535 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
8536 &quot;A String&quot;,
8537 ],
8538 }
8539
8540 x__xgafv: string, V1 error format.
8541 Allowed values
8542 1 - v1 error format
8543 2 - v2 error format
8544
8545 Returns:
8546 An object of the form:
8547
8548 {
8549 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
8550 # allowed.
8551 &quot;A String&quot;,
8552 ],
8553 }</pre>
8554 </div>
8555
8556 <div class="method">
8557 <code class="details" id="update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
8558 <pre>Updates the specified Router resource with the data included in the
8559 request. This method conforms toPUT semantics, which requests that the state of the
8560 target resource be created or replaced with the state defined by the
8561 representation enclosed in the request message payload.
8562
8563 Args:
8564 project: string, Project ID for this request. (required)
8565 region: string, Name of the region for this request. (required)
8566 router: string, Name of the Router resource to update. (required)
8567 body: object, The request body.
8568 The object takes the form of:
8569
8570 { # Represents a Cloud Router resource.
8571 #
8572 # For more information about Cloud Router, read theCloud
8573 # Router overview.
8574 &quot;bgp&quot;: { # BGP information specific to this router.
8575 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
8576 # The options are DEFAULT or CUSTOM.
8577 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
8578 # This field can only be populated if advertise_mode is CUSTOM and
8579 # is advertised to all peers of the router.
8580 # These groups will be advertised in addition to any specified prefixes.
8581 # Leave this field blank to advertise no custom groups.
8582 &quot;A String&quot;,
8583 ],
8584 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
8585 # This field can only be populated if advertise_mode is CUSTOM and
8586 # is advertised to all peers of the router.
8587 # These IP ranges will be advertised in addition to any specified groups.
8588 # Leave this field blank to advertise no custom IP ranges.
8589 { # Description-tagged IP ranges for the router to advertise.
8590 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
8591 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
8592 },
8593 ],
8594 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
8595 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
8596 # value will be fixed for this router resource. All VPN tunnels that link
8597 # to this router will have the same local ASN.
8598 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
8599 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
8600 # least /30, even if the BGP sessions are over IPv6. It must not overlap
8601 # with any IPv4 BGP session ranges.
8602 #
8603 #
8604 # Other vendors commonly call this &quot;router ID&quot;.
8605 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
8606 # sent to the peer.
8607 #
8608 #
8609 # Hold time is three times the interval at which keepalive messages are
8610 # sent, and the hold time is the maximum number of seconds allowed to
8611 # elapse between successive keepalive messages that BGP receives from a
8612 # peer.
8613 #
8614 #
8615 # BGP will use the smaller of either the local hold time value or the
8616 # peer&#x27;s hold time value as the hold time for the BGP connection between
8617 # the two peers.
8618 #
8619 #
8620 # If set, this value must be between 20 and 60. The default is 20.
8621 },
8622 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
8623 # establish BGP peering. This information must specify the peer ASN and
8624 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
8625 {
8626 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
8627 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
8628 # which currently supports the following option:
8629 #
8630 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
8631 # excludes any routes learned for subnets that use
8632 # VPC Network Peering.
8633 #
8634 #
8635 # Note that this field can only be populated if advertise_mode is CUSTOM
8636 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
8637 # These groups are advertised in addition to any specified prefixes.
8638 # Leave this field blank to advertise no custom groups.
8639 &quot;A String&quot;,
8640 ],
8641 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
8642 # This field can only be populated if advertise_mode is CUSTOM and
8643 # overrides the list defined for the router (in the &quot;bgp&quot; message).
8644 # These IP ranges are advertised in addition to any specified groups.
8645 # Leave this field blank to advertise no custom IP ranges.
8646 { # Description-tagged IP ranges for the router to advertise.
8647 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
8648 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
8649 },
8650 ],
8651 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
8652 # than one matching route of maximum length, the routes with the lowest
8653 # priority value win.
8654 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
8655 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
8656 # received from the peer router. The actual value is negotiated between
8657 # the two routers and is equal to the greater of this value and the
8658 # transmit interval of the other router.
8659 #
8660 #
8661 # If set, this value must be between 1000 and 30000.
8662 #
8663 #
8664 # The default is 1000.
8665 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
8666 # transmitted to the peer router. The actual value is negotiated between
8667 # the two routers and is equal to the greater of this value and the
8668 # corresponding receive interval of the other router.
8669 #
8670 #
8671 # If set, this value must be between 1000 and 30000.
8672 #
8673 #
8674 # The default is 1000.
8675 &quot;mode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
8676 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
8677 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
8678 # peer router to initiate the BFD session for this BGP peer. If set to
8679 # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.
8680 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
8681 # before BFD declares that a peer is unavailable.
8682 #
8683 #
8684 # If set, the value must be a value between 5 and 16.
8685 #
8686 #
8687 # The default is 5.
8688 &quot;packetMode&quot;: &quot;A String&quot;, # The BFD packet mode for this BGP peer.
8689 # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer.
8690 # In this mode, if the peer router also has BFD echo mode enabled, BFD
8691 # echo packets will be sent to the other router. If the peer router does
8692 # not have BFD echo mode enabled, only control packets will be sent. If
8693 # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If
8694 # this router and the peer router have a multihop connection, this should
8695 # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop
8696 # connections. The default is CONTROL_AND_ECHO.
8697 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
8698 #
8699 #
8700 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
8701 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
8702 # peer router to initiate the BFD session for this BGP peer. If set to
8703 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
8704 &quot;slowTimerInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
8705 # transmitted to and received from the peer router when BFD echo mode is
8706 # enabled on both routers. The actual transmit and receive intervals are
8707 # negotiated between the two routers and are equal to the greater of this
8708 # value and the corresponding interval on the other router.
8709 # If set, this value must be between 1000 and 30000.
8710 # The default is 5000.
8711 },
8712 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
8713 # session.
8714 {
8715 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
8716 # CIDR-formatted prefix. If an IP address is provided without a subnet
8717 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
8718 # range, and, for IPv6, `/128`.
8719 },
8720 ],
8721 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
8722 # value is applied to all custom learned route ranges for the session.
8723 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
8724 # value, Google Cloud assigns a priority of `100` to the ranges.
8725 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
8726 #
8727 #
8728 # If set to FALSE, any active session with the peer is terminated and
8729 # all associated routing information is removed. If set to TRUE, the
8730 # peer connection can be established with routing information. The default
8731 # is TRUE.
8732 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
8733 # the peerIpAddress is version 4.
8734 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
8735 # peerIpAddress is version 6.
8736 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
8737 # evaluated. The name must correspond to an existing policy that has
8738 # ROUTE_POLICY_TYPE_EXPORT type.
8739 &quot;A String&quot;,
8740 ],
8741 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
8742 # evaluated. The name must correspond to an existing policy that has
8743 # ROUTE_POLICY_TYPE_IMPORT type.
8744 &quot;A String&quot;,
8745 ],
8746 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
8747 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
8748 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
8749 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
8750 &quot;linkedCustomHardware&quot;: &quot;A String&quot;, # The linked custom hardware resource.
8751 # The URI of the custom hardware link attachment
8752 # is where you will establish the BGP session from the Cloud Router.
8753 # This link attachment must reside in the same subnetwork as the associated
8754 # router interface.
8755 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
8756 #
8757 # - MANAGED_BY_USER is the default value and can be managed by you
8758 # or other users
8759 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
8760 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
8761 # PARTNER. Google automatically creates, updates, and deletes this type of
8762 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
8763 # or deleted.
8764 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
8765 # name of one of the entries in the Router.md5_authentication_keys. The
8766 # field must comply with RFC1035.
8767 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
8768 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
8769 # characters long and match the regular expression
8770 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
8771 # lowercase letter, and all following characters must be a dash, lowercase
8772 # letter, or digit, except the last character, which cannot be a dash.
8773 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
8774 # a different value.
8775 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
8776 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
8777 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
8778 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
8779 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
8780 # Appliances. The VM instance must be located in zones contained in the
8781 # same region as this Cloud Router.
8782 # The VM instance is the peer side of the BGP session.
8783 },
8784 ],
8785 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
8786 # text format.
8787 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8788 # create the resource.
8789 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
8790 # attachments (interconnectAttachments).
8791 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
8792 # defined by the server.
8793 &quot;interfaces&quot;: [ # Router interfaces.
8794 # To create a BGP peer that uses a router interface,
8795 # the interface must have one of the following fields specified:
8796 #
8797 # - linkedVpnTunnel
8798 # - linkedInterconnectAttachment
8799 # - subnetwork
8800 #
8801 #
8802 # You can create a router interface without any of these fields specified.
8803 # However, you cannot create a BGP peer that uses that interface.
8804 {
8805 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
8806 #
8807 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
8808 # be a CIDR-formatted string, for example, 169.254.0.1/30.
8809 # Note: Do not truncate the IP address, as it represents the IP address of
8810 # the interface.
8811 # - For Internet Protocol version 6 (IPv6), the value
8812 # must be a unique local address (ULA) range from fdff:1::/64
8813 # with a mask length of 126 or less. This value should be a CIDR-formatted
8814 # string, for example, fdff:1::1/112. Within the router&#x27;s
8815 # VPC, this IPv6 prefix will be reserved exclusively for this connection
8816 # and cannot be used for any other purpose.
8817 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
8818 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
8819 # as the router. Each interface can have one linked resource, which can be
8820 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
8821 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
8822 # router. Each interface can have one linked resource, which can be
8823 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
8824 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
8825 #
8826 # - MANAGED_BY_USER is the default value and can be managed directly
8827 # by users.
8828 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
8829 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
8830 # of type PARTNER. Google automatically creates, updates, and deletes
8831 # this type of interface when the PARTNER InterconnectAttachment is
8832 # created, updated, or deleted.
8833 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
8834 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
8835 # characters long and match the regular expression
8836 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
8837 # lowercase letter, and all following characters must be a dash, lowercase
8838 # letter, or digit, except the last character, which cannot be a dash.
8839 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
8840 # BGP sessions to a VM instance acting as a third-party
8841 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
8842 # an SD-WAN VM.
8843 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
8844 # you are creating. The redundantInterface must belong to the same Cloud
8845 # Router as the interface here. To establish the BGP session to a Router
8846 # Appliance VM, you must create two BGP peers. The two BGP peers must be
8847 # attached to two separate interfaces that are redundant with each other.
8848 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
8849 # be 1-63 characters long and match the regular expression
8850 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
8851 # lowercase letter, and all following characters must be a dash, lowercase
8852 # letter, or digit, except the last character, which cannot be a dash.
8853 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
8854 # must be in the same region as the Cloud Router.
8855 # When you establish a BGP session to a VM instance using this interface,
8856 # the VM instance must belong to the same subnetwork as the subnetwork
8857 # specified here.
8858 },
8859 ],
8860 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
8861 # routers.
8862 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
8863 {
8864 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
8865 #
8866 # For patch and update calls, it can be skipped to
8867 # copy the value from the previous configuration. This is allowed if the
8868 # key with the same name existed before the operation. Maximum length is 80
8869 # characters. Can only contain printable ASCII characters.
8870 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
8871 #
8872 # Must be unique within a router. Must be referenced by exactly
8873 # one bgpPeer. Must comply withRFC1035.
8874 },
8875 ],
8876 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
8877 # The name must be 1-63 characters long, and comply withRFC1035.
8878 # Specifically, the name must be 1-63 characters long and match the regular
8879 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
8880 # character must be a lowercase letter, and all following characters must
8881 # be a dash, lowercase letter, or digit, except the last character, which
8882 # cannot be a dash.
8883 &quot;nats&quot;: [ # A list of NAT services created in this router.
8884 { # Represents a Nat resource. It enables the VMs within the specified
8885 # subnetworks to access Internet without external IP addresses. It specifies
8886 # a list of subnetworks (and the ranges within) that want to use NAT.
8887 # Customers can also provide the external IPs that would be used for NAT. GCP
8888 # would auto-allocate ephemeral IPs if no external IPs are provided.
8889 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
8890 # Must be one of: PREMIUM, STANDARD.
8891 # If not specified, then the current
8892 # project-level default tier is used.
8893 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
8894 # must be valid static external IPs that have been assigned to the NAT.
8895 # These IPs should be used for updating/patching a NAT only.
8896 &quot;A String&quot;,
8897 ],
8898 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
8899 # state. This value is equal to tcp_time_wait_timeout_sec.
8900 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
8901 # 120s. The field is output only.
8902 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
8903 #
8904 #
8905 # If not specified, it is disabled by default.
8906 #
8907 #
8908 # If set to true,
8909 #
8910 # - Dynamic Port Allocation will be enabled on this NAT
8911 # config.
8912 # - enableEndpointIndependentMapping cannot be set to true.
8913 # - If minPorts is set, minPortsPerVm must be set to a
8914 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
8915 # minimum of 32 ports will be allocated to a VM from this NAT
8916 # config.
8917 &quot;enableEndpointIndependentMapping&quot;: True or False,
8918 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
8919 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
8920 &quot;A String&quot;,
8921 ],
8922 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
8923 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
8924 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
8925 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
8926 # logs are exported for all connections handled by this NAT.
8927 # This option can take one of the following values:
8928 #
8929 # - ERRORS_ONLY: Export logs only for connection failures.
8930 # - TRANSLATIONS_ONLY: Export logs only for successful
8931 # connections.
8932 # - ALL: Export logs for all connections, successful and
8933 # unsuccessful.
8934 },
8935 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
8936 # Dynamic Port Allocation is enabled.
8937 #
8938 #
8939 # If Dynamic Port Allocation is not enabled, this field has no effect.
8940 #
8941 #
8942 # If Dynamic Port Allocation is enabled, and this field is set, it must be
8943 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
8944 # is not set.
8945 #
8946 #
8947 # If Dynamic Port Allocation is enabled and this field is not set,
8948 # a maximum of 65536 ports will be allocated to a VM from this NAT
8949 # config.
8950 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
8951 # set, a default number of ports is allocated to a VM. This is rounded
8952 # up to the nearest power of 2. For example, if the value of this field is
8953 # 50, at least 64 ports are allocated to a VM.
8954 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
8955 # The name must be 1-63 characters long and comply withRFC1035.
8956 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
8957 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
8958 # selected for the SubnetworkIpRangeToNat64Option above.
8959 { # Specifies a subnetwork to enable NAT64.
8960 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
8961 },
8962 ],
8963 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
8964 # values:
8965 #
8966 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
8967 # customers. When there are not enough specified Nat IPs, the Nat service
8968 # fails for new VMs.
8969 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
8970 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
8971 # be empty.
8972 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
8973 # addresses must be valid static external IP addresses assigned to the
8974 # project.
8975 &quot;A String&quot;,
8976 ],
8977 &quot;rules&quot;: [ # A list of rules associated with this NAT.
8978 {
8979 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
8980 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
8981 # addresses must be valid static external IP addresses assigned to the
8982 # project.
8983 # This field is used for public NAT.
8984 &quot;A String&quot;,
8985 ],
8986 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
8987 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
8988 # This field is used for private NAT.
8989 &quot;A String&quot;,
8990 ],
8991 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
8992 # must be valid static external IPs that have been assigned to the NAT.
8993 # These IPs should be used for updating/patching a NAT rule only.
8994 # This field is used for public NAT.
8995 &quot;A String&quot;,
8996 ],
8997 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
8998 # drained. This is only supported on patch/update, and these
8999 # subnetworks must have previously been used as active ranges in this
9000 # NAT Rule.
9001 # This field is used for private NAT.
9002 &quot;A String&quot;,
9003 ],
9004 },
9005 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
9006 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
9007 # from a VM is evaluated against. If it evaluates to true, the
9008 # corresponding `action` is enforced.
9009 #
9010 # The following examples are valid match expressions for public NAT:
9011 #
9012 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
9013 # &#x27;2.2.0.0/16&#x27;)`
9014 #
9015 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
9016 #
9017 # The following example is a valid match expression for private NAT:
9018 #
9019 # `nexthop.hub ==
9020 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
9021 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
9022 # must be a positive value between 0 and 65000, and
9023 # must be unique among rules within a NAT.
9024 &quot;sourceWorkloadIdentities&quot;: [ # A list of source workload identities.
9025 &quot;A String&quot;,
9026 ],
9027 },
9028 ],
9029 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
9030 #
9031 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
9032 # Subnetwork are allowed to Nat.
9033 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
9034 # in every Subnetwork are allowed to Nat.
9035 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
9036 # (specified in the field subnetwork below)
9037 #
9038 #
9039 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
9040 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
9041 # should not be any other Router.Nat section in any Router for this network
9042 # in this region.
9043 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
9044 # values:
9045 #
9046 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
9047 # every Subnetwork are allowed to Nat.
9048 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
9049 # (specified in the field nat64_subnetwork below)
9050 #
9051 #
9052 # The default is NAT64_OPTION_UNSPECIFIED.
9053 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
9054 # Router.Nat section in this region can also enable NAT64 for any
9055 # Subnetworks in this network. Other Router.Nat sections can still be
9056 # present to enable NAT44 only.
9057 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
9058 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
9059 # SubnetworkIpRangeToNatOption above.
9060 { # Defines the IP ranges that want to use NAT for a subnetwork.
9061 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
9062 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
9063 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
9064 # is one of the values in source_ip_ranges_to_nat.
9065 &quot;A String&quot;,
9066 ],
9067 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
9068 # options of a single value are valid except
9069 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
9070 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
9071 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
9072 # Default: [ALL_IP_RANGES]
9073 &quot;A String&quot;,
9074 ],
9075 },
9076 ],
9077 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
9078 # if not set.
9079 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
9080 # Defaults to 120s if not set.
9081 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
9082 # not set.
9083 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
9084 # translation. If unspecified, it defaults to PUBLIC.
9085 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
9086 },
9087 ],
9088 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
9089 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
9090 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
9091 # as part of resource payload.
9092 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
9093 # The field is allowed for INSERT
9094 # only. The keys/values to set on the resource should be specified in
9095 # either ID { : } or Namespaced format
9096 # { : }.
9097 # For example the following are valid inputs:
9098 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
9099 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
9100 # Note:
9101 # * Invalid combinations of ID &amp; namespaced format is not supported. For
9102 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
9103 # * Inconsistent format is not supported. For instance:
9104 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
9105 &quot;a_key&quot;: &quot;A String&quot;,
9106 },
9107 },
9108 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
9109 # You must specify this field as part of the HTTP request URL. It is
9110 # not settable as a field in the request body.
9111 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9112 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
9113 }
9114
9115 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9116 that if you must retry your request, the server will know to ignore the
9117 request if it has already been completed.
9118
9119 For example, consider a situation where you make an initial request and
9120 the request times out. If you make the request again with the same
9121 request ID, the server can check if original operation with the same
9122 request ID was received, and if so, will ignore the second request. This
9123 prevents clients from accidentally creating duplicate commitments.
9124
9125 The request ID must be
9126 a valid UUID with the exception that zero UUID is not supported
9127 (00000000-0000-0000-0000-000000000000).
9128 x__xgafv: string, V1 error format.
9129 Allowed values
9130 1 - v1 error format
9131 2 - v2 error format
9132
9133 Returns:
9134 An object of the form:
9135
9136 { # Represents an Operation resource.
9137 #
9138 # Google Compute Engine has three Operation resources:
9139 #
9140 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
9141 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
9142 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
9143 #
9144 # You can use an operation resource to manage asynchronous API requests.
9145 # For more information, readHandling
9146 # API responses.
9147 #
9148 # Operations can be global, regional or zonal.
9149 #
9150 # - For global operations, use the `globalOperations`
9151 # resource.
9152 # - For regional operations, use the
9153 # `regionOperations` resource.
9154 # - For zonal operations, use
9155 # the `zoneOperations` resource.
9156 #
9157 #
9158 #
9159 # For more information, read
9160 # Global, Regional, and Zonal Resources.
9161 #
9162 # Note that completed Operation resources have a limited
9163 # retention period.
9164 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9165 # Not present otherwise.
9166 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9167 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9168 # set when the operation is created.
9169 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9170 # text format.
9171 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9172 # this field will be populated.
9173 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9174 # operation.
9175 {
9176 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9177 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9178 # details. There is a set of defined message types to use for providing
9179 # details.The syntax depends on the error code. For example,
9180 # QuotaExceededInfo will have details when the error code is
9181 # QUOTA_EXCEEDED.
9182 {
9183 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9184 #
9185 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9186 # is not enabled:
9187 #
9188 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9189 # &quot;domain&quot;: &quot;googleapis.com&quot;
9190 # &quot;metadata&quot;: {
9191 # &quot;resource&quot;: &quot;projects/123&quot;,
9192 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9193 # }
9194 # }
9195 #
9196 # This response indicates that the pubsub.googleapis.com API is not enabled.
9197 #
9198 # Example of an error that is returned when attempting to create a Spanner
9199 # instance in a region that is out of stock:
9200 #
9201 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9202 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9203 # &quot;metadata&quot;: {
9204 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9205 # }
9206 # }
9207 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9208 # is typically the registered service name of the tool or product that
9209 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9210 # generated by some common infrastructure, the error domain must be a
9211 # globally unique value that identifies the infrastructure. For Google API
9212 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9213 &quot;metadatas&quot;: { # Additional structured details about this error.
9214 #
9215 # Keys must match a regular expression of `a-z+` but should
9216 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9217 # length. When identifying the current value of an exceeded limit, the units
9218 # should be contained in the key, not the value. For example, rather than
9219 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9220 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9221 # instances that can be created in a single (batch) request.
9222 &quot;a_key&quot;: &quot;A String&quot;,
9223 },
9224 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9225 # proximate cause of the error. Error reasons are unique within a particular
9226 # domain of errors. This should be at most 63 characters and match a
9227 # regular expression of `A-Z+[A-Z0-9]`, which represents
9228 # UPPER_SNAKE_CASE.
9229 },
9230 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9231 #
9232 # For example, if a quota check failed with an error indicating the calling
9233 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9234 # directly to the right place in the developer console to flip the bit.
9235 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9236 { # Describes a URL link.
9237 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9238 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9239 },
9240 ],
9241 },
9242 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9243 # which can be attached to an RPC error.
9244 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9245 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9246 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9247 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9248 },
9249 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9250 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9251 &quot;a_key&quot;: &quot;A String&quot;,
9252 },
9253 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9254 # type or metric.
9255 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9256 # or metric.
9257 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9258 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9259 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9260 },
9261 },
9262 ],
9263 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9264 # This property is optional.
9265 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9266 },
9267 ],
9268 },
9269 &quot;getVersionOperationMetadata&quot;: {
9270 &quot;inlineSbomInfo&quot;: {
9271 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9272 # appropriate identifiers.
9273 &quot;a_key&quot;: &quot;A String&quot;,
9274 },
9275 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9276 # identifiers.
9277 &quot;a_key&quot;: &quot;A String&quot;,
9278 },
9279 },
9280 },
9281 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9282 # message that was returned, such as `NOT FOUND`.
9283 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9284 # status code that was returned. For example, a `404` means the
9285 # resource was not found.
9286 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9287 # defined by the server.
9288 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9289 # This value is inRFC3339
9290 # text format.
9291 &quot;instancesBulkInsertOperationMetadata&quot;: {
9292 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9293 # Example key: zones/us-central1-a
9294 &quot;a_key&quot;: {
9295 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9296 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9297 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9298 # error.
9299 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9300 # if the flow is rolling forward or rolling back.
9301 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9302 },
9303 },
9304 },
9305 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9306 # Operation resources.
9307 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9308 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9309 # group of operations results from a `bulkInsert` API request.
9310 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9311 # `update`, or `delete`, and so on.
9312 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9313 # There is no requirement that this be linear or support any granularity of
9314 # operations. This should not be used to guess when the operation will be
9315 # complete. This number should monotonically increase as the operation
9316 # progresses.
9317 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9318 # applicable when performing regional operations.
9319 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9320 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
9321 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9322 # this field will contain information on all underlying zonal actions and
9323 # their state.
9324 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9325 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9326 # Example key: zones/us-central1-a
9327 &quot;a_key&quot;: {
9328 &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
9329 # populated.
9330 # different programming environments, including REST APIs and RPC APIs. It is
9331 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9332 # three pieces of data: error code, error message, and error details.
9333 #
9334 # You can find out more about this error model and how to work with it in the
9335 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9336 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9337 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9338 # message types for APIs to use.
9339 {
9340 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9341 },
9342 ],
9343 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9344 # user-facing error message should be localized and sent in the
9345 # google.rpc.Status.details field, or localized by the client.
9346 },
9347 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9348 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9349 },
9350 },
9351 },
9352 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9353 # This value is inRFC3339
9354 # text format.
9355 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9356 # following:
9357 # `PENDING`, `RUNNING`, or `DONE`.
9358 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9359 # operation.
9360 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9361 # of the target resource.
9362 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9363 # operations related to creating a snapshot, this points to the disk
9364 # that the snapshot was created from.
9365 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9366 # `[email protected]` or
9367 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9368 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9369 # operation, this field will be populated.
9370 {
9371 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9372 # Engine returns NO_RESULTS_ON_PAGE if there
9373 # are no results in the response.
9374 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9375 # value format. For example:
9376 #
9377 # &quot;data&quot;: [
9378 # {
9379 # &quot;key&quot;: &quot;scope&quot;,
9380 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9381 # }
9382 {
9383 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9384 # returned. For example, for warnings where there are no results in a list
9385 # request for a particular zone, this key might be scope and
9386 # the key value might be the zone name. Other examples might be a key
9387 # indicating a deprecated resource and a suggested replacement, or a
9388 # warning about invalid network settings (for example, if an instance
9389 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9390 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9391 },
9392 ],
9393 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9394 },
9395 ],
9396 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9397 # applicable when performing per-zone operations.
9398 }</pre>
9399 </div>
9400
9401 <div class="method">
9402 <code class="details" id="updateNamedSet">updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
9403 <pre>Updates or creates new Named Set
9404
9405 Args:
9406 project: string, Project ID for this request. (required)
9407 region: string, Name of the region for this request. (required)
9408 router: string, Name of the Router resource where Named Set is defined. (required)
9409 body: object, The request body.
9410 The object takes the form of:
9411
9412 {
9413 &quot;description&quot;: &quot;A String&quot;, # An optional description of named set.
9414 &quot;elements&quot;: [ # CEL expressions that are comparable to constructs of this set&#x27;s type
9415 # (see Policy Language).
9416 { # Represents a textual expression in the Common Expression Language (CEL)
9417 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9418 # are documented at https://github.com/google/cel-spec.
9419 #
9420 # Example (Comparison):
9421 #
9422 # title: &quot;Summary size limit&quot;
9423 # description: &quot;Determines if a summary is less than 100 chars&quot;
9424 # expression: &quot;document.summary.size() &lt; 100&quot;
9425 #
9426 # Example (Equality):
9427 #
9428 # title: &quot;Requestor is owner&quot;
9429 # description: &quot;Determines if requestor is the document owner&quot;
9430 # expression: &quot;document.owner == request.auth.claims.email&quot;
9431 #
9432 # Example (Logic):
9433 #
9434 # title: &quot;Public documents&quot;
9435 # description: &quot;Determine whether the document should be publicly visible&quot;
9436 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9437 #
9438 # Example (Data Manipulation):
9439 #
9440 # title: &quot;Notification string&quot;
9441 # description: &quot;Create a notification string with a timestamp.&quot;
9442 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9443 #
9444 # The exact variables and functions that may be referenced within an expression
9445 # are determined by the service that evaluates it. See the service
9446 # documentation for additional information.
9447 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9448 # describes the expression, e.g. when hovered over it in a UI.
9449 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9450 # syntax.
9451 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9452 # reporting, e.g. a file name and a position in the file.
9453 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9454 # its purpose. This can be used e.g. in UIs which allow to enter the
9455 # expression.
9456 },
9457 ],
9458 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Named Set being applied to this Router, which is
9459 # essentially a hash of the Named Set used for optimistic locking.
9460 # The fingerprint is initially generated by Compute Engine and changes
9461 # after every request to modify or update the Named Set. You must always
9462 # provide an up-to-date fingerprint hash in order to update or change
9463 # labels.
9464 #
9465 # To see the latest fingerprint, make a getNamedSet() request
9466 # to retrieve a Named Set.
9467 &quot;name&quot;: &quot;A String&quot;, # This set&#x27;s name, which must be a resource ID segment and unique within all
9468 # named sets owned by the Router. Name should conform to RFC1035.
9469 &quot;type&quot;: &quot;A String&quot;, # This named set&#x27;s type
9470 }
9471
9472 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9473 that if you must retry your request, the server will know to ignore the
9474 request if it has already been completed.
9475
9476 For example, consider a situation where you make an initial request and
9477 the request times out. If you make the request again with the same
9478 request ID, the server can check if original operation with the same
9479 request ID was received, and if so, will ignore the second request. This
9480 prevents clients from accidentally creating duplicate commitments.
9481
9482 The request ID must be
9483 a valid UUID with the exception that zero UUID is not supported
9484 (00000000-0000-0000-0000-000000000000).
9485 x__xgafv: string, V1 error format.
9486 Allowed values
9487 1 - v1 error format
9488 2 - v2 error format
9489
9490 Returns:
9491 An object of the form:
9492
9493 { # Represents an Operation resource.
9494 #
9495 # Google Compute Engine has three Operation resources:
9496 #
9497 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
9498 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
9499 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
9500 #
9501 # You can use an operation resource to manage asynchronous API requests.
9502 # For more information, readHandling
9503 # API responses.
9504 #
9505 # Operations can be global, regional or zonal.
9506 #
9507 # - For global operations, use the `globalOperations`
9508 # resource.
9509 # - For regional operations, use the
9510 # `regionOperations` resource.
9511 # - For zonal operations, use
9512 # the `zoneOperations` resource.
9513 #
9514 #
9515 #
9516 # For more information, read
9517 # Global, Regional, and Zonal Resources.
9518 #
9519 # Note that completed Operation resources have a limited
9520 # retention period.
9521 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9522 # Not present otherwise.
9523 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9524 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9525 # set when the operation is created.
9526 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9527 # text format.
9528 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9529 # this field will be populated.
9530 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9531 # operation.
9532 {
9533 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9534 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9535 # details. There is a set of defined message types to use for providing
9536 # details.The syntax depends on the error code. For example,
9537 # QuotaExceededInfo will have details when the error code is
9538 # QUOTA_EXCEEDED.
9539 {
9540 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9541 #
9542 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9543 # is not enabled:
9544 #
9545 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9546 # &quot;domain&quot;: &quot;googleapis.com&quot;
9547 # &quot;metadata&quot;: {
9548 # &quot;resource&quot;: &quot;projects/123&quot;,
9549 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9550 # }
9551 # }
9552 #
9553 # This response indicates that the pubsub.googleapis.com API is not enabled.
9554 #
9555 # Example of an error that is returned when attempting to create a Spanner
9556 # instance in a region that is out of stock:
9557 #
9558 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9559 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9560 # &quot;metadata&quot;: {
9561 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9562 # }
9563 # }
9564 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9565 # is typically the registered service name of the tool or product that
9566 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9567 # generated by some common infrastructure, the error domain must be a
9568 # globally unique value that identifies the infrastructure. For Google API
9569 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9570 &quot;metadatas&quot;: { # Additional structured details about this error.
9571 #
9572 # Keys must match a regular expression of `a-z+` but should
9573 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9574 # length. When identifying the current value of an exceeded limit, the units
9575 # should be contained in the key, not the value. For example, rather than
9576 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9577 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9578 # instances that can be created in a single (batch) request.
9579 &quot;a_key&quot;: &quot;A String&quot;,
9580 },
9581 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9582 # proximate cause of the error. Error reasons are unique within a particular
9583 # domain of errors. This should be at most 63 characters and match a
9584 # regular expression of `A-Z+[A-Z0-9]`, which represents
9585 # UPPER_SNAKE_CASE.
9586 },
9587 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9588 #
9589 # For example, if a quota check failed with an error indicating the calling
9590 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9591 # directly to the right place in the developer console to flip the bit.
9592 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9593 { # Describes a URL link.
9594 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9595 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9596 },
9597 ],
9598 },
9599 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9600 # which can be attached to an RPC error.
9601 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9602 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9603 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9604 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9605 },
9606 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9607 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9608 &quot;a_key&quot;: &quot;A String&quot;,
9609 },
9610 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9611 # type or metric.
9612 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9613 # or metric.
9614 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9615 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9616 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9617 },
9618 },
9619 ],
9620 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9621 # This property is optional.
9622 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9623 },
9624 ],
9625 },
9626 &quot;getVersionOperationMetadata&quot;: {
9627 &quot;inlineSbomInfo&quot;: {
9628 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9629 # appropriate identifiers.
9630 &quot;a_key&quot;: &quot;A String&quot;,
9631 },
9632 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9633 # identifiers.
9634 &quot;a_key&quot;: &quot;A String&quot;,
9635 },
9636 },
9637 },
9638 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9639 # message that was returned, such as `NOT FOUND`.
9640 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9641 # status code that was returned. For example, a `404` means the
9642 # resource was not found.
9643 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9644 # defined by the server.
9645 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9646 # This value is inRFC3339
9647 # text format.
9648 &quot;instancesBulkInsertOperationMetadata&quot;: {
9649 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9650 # Example key: zones/us-central1-a
9651 &quot;a_key&quot;: {
9652 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9653 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9654 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9655 # error.
9656 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9657 # if the flow is rolling forward or rolling back.
9658 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9659 },
9660 },
9661 },
9662 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9663 # Operation resources.
9664 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9665 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9666 # group of operations results from a `bulkInsert` API request.
9667 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9668 # `update`, or `delete`, and so on.
9669 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9670 # There is no requirement that this be linear or support any granularity of
9671 # operations. This should not be used to guess when the operation will be
9672 # complete. This number should monotonically increase as the operation
9673 # progresses.
9674 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9675 # applicable when performing regional operations.
9676 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9677 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
9678 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9679 # this field will contain information on all underlying zonal actions and
9680 # their state.
9681 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9682 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9683 # Example key: zones/us-central1-a
9684 &quot;a_key&quot;: {
9685 &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
9686 # populated.
9687 # different programming environments, including REST APIs and RPC APIs. It is
9688 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9689 # three pieces of data: error code, error message, and error details.
9690 #
9691 # You can find out more about this error model and how to work with it in the
9692 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9693 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9694 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9695 # message types for APIs to use.
9696 {
9697 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9698 },
9699 ],
9700 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9701 # user-facing error message should be localized and sent in the
9702 # google.rpc.Status.details field, or localized by the client.
9703 },
9704 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9705 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9706 },
9707 },
9708 },
9709 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9710 # This value is inRFC3339
9711 # text format.
9712 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9713 # following:
9714 # `PENDING`, `RUNNING`, or `DONE`.
9715 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9716 # operation.
9717 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9718 # of the target resource.
9719 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9720 # operations related to creating a snapshot, this points to the disk
9721 # that the snapshot was created from.
9722 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9723 # `[email protected]` or
9724 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9725 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9726 # operation, this field will be populated.
9727 {
9728 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9729 # Engine returns NO_RESULTS_ON_PAGE if there
9730 # are no results in the response.
9731 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9732 # value format. For example:
9733 #
9734 # &quot;data&quot;: [
9735 # {
9736 # &quot;key&quot;: &quot;scope&quot;,
9737 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9738 # }
9739 {
9740 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9741 # returned. For example, for warnings where there are no results in a list
9742 # request for a particular zone, this key might be scope and
9743 # the key value might be the zone name. Other examples might be a key
9744 # indicating a deprecated resource and a suggested replacement, or a
9745 # warning about invalid network settings (for example, if an instance
9746 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9747 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9748 },
9749 ],
9750 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9751 },
9752 ],
9753 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9754 # applicable when performing per-zone operations.
9755 }</pre>
9756 </div>
9757
9758 <div class="method">
9759 <code class="details" id="updateRoutePolicy">updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
9760 <pre>Updates or creates new Route Policy
9761
9762 Args:
9763 project: string, Project ID for this request. (required)
9764 region: string, Name of the region for this request. (required)
9765 router: string, Name of the Router resource where Route Policy is defined. (required)
9766 body: object, The request body.
9767 The object takes the form of:
9768
9769 {
9770 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
9771 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
9772 # essentially a hash of the Route Policy used for optimistic locking.
9773 # The fingerprint is initially generated by Compute Engine and changes
9774 # after every request to modify or update Route Policy. You must always
9775 # provide an up-to-date fingerprint hash in order to update or change
9776 # labels.
9777 #
9778 # To see the latest fingerprint, make a getRoutePolicy() request
9779 # to retrieve a Route Policy.
9780 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
9781 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
9782 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
9783 # in order of priority). Order of policies is not retained and might change
9784 # when getting policy later.
9785 {
9786 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
9787 { # Represents a textual expression in the Common Expression Language (CEL)
9788 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9789 # are documented at https://github.com/google/cel-spec.
9790 #
9791 # Example (Comparison):
9792 #
9793 # title: &quot;Summary size limit&quot;
9794 # description: &quot;Determines if a summary is less than 100 chars&quot;
9795 # expression: &quot;document.summary.size() &lt; 100&quot;
9796 #
9797 # Example (Equality):
9798 #
9799 # title: &quot;Requestor is owner&quot;
9800 # description: &quot;Determines if requestor is the document owner&quot;
9801 # expression: &quot;document.owner == request.auth.claims.email&quot;
9802 #
9803 # Example (Logic):
9804 #
9805 # title: &quot;Public documents&quot;
9806 # description: &quot;Determine whether the document should be publicly visible&quot;
9807 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9808 #
9809 # Example (Data Manipulation):
9810 #
9811 # title: &quot;Notification string&quot;
9812 # description: &quot;Create a notification string with a timestamp.&quot;
9813 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9814 #
9815 # The exact variables and functions that may be referenced within an expression
9816 # are determined by the service that evaluates it. See the service
9817 # documentation for additional information.
9818 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9819 # describes the expression, e.g. when hovered over it in a UI.
9820 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9821 # syntax.
9822 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9823 # reporting, e.g. a file name and a position in the file.
9824 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9825 # its purpose. This can be used e.g. in UIs which allow to enter the
9826 # expression.
9827 },
9828 ],
9829 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
9830 # applies. When not set, the term applies to all
9831 # routes.
9832 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9833 # are documented at https://github.com/google/cel-spec.
9834 #
9835 # Example (Comparison):
9836 #
9837 # title: &quot;Summary size limit&quot;
9838 # description: &quot;Determines if a summary is less than 100 chars&quot;
9839 # expression: &quot;document.summary.size() &lt; 100&quot;
9840 #
9841 # Example (Equality):
9842 #
9843 # title: &quot;Requestor is owner&quot;
9844 # description: &quot;Determines if requestor is the document owner&quot;
9845 # expression: &quot;document.owner == request.auth.claims.email&quot;
9846 #
9847 # Example (Logic):
9848 #
9849 # title: &quot;Public documents&quot;
9850 # description: &quot;Determine whether the document should be publicly visible&quot;
9851 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9852 #
9853 # Example (Data Manipulation):
9854 #
9855 # title: &quot;Notification string&quot;
9856 # description: &quot;Create a notification string with a timestamp.&quot;
9857 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9858 #
9859 # The exact variables and functions that may be referenced within an expression
9860 # are determined by the service that evaluates it. See the service
9861 # documentation for additional information.
9862 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9863 # describes the expression, e.g. when hovered over it in a UI.
9864 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9865 # syntax.
9866 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9867 # reporting, e.g. a file name and a position in the file.
9868 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9869 # its purpose. This can be used e.g. in UIs which allow to enter the
9870 # expression.
9871 },
9872 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
9873 # (inclusive) and 2^31 (exclusive), and unique within the list.
9874 },
9875 ],
9876 &quot;type&quot;: &quot;A String&quot;,
9877 }
9878
9879 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9880 that if you must retry your request, the server will know to ignore the
9881 request if it has already been completed.
9882
9883 For example, consider a situation where you make an initial request and
9884 the request times out. If you make the request again with the same
9885 request ID, the server can check if original operation with the same
9886 request ID was received, and if so, will ignore the second request. This
9887 prevents clients from accidentally creating duplicate commitments.
9888
9889 The request ID must be
9890 a valid UUID with the exception that zero UUID is not supported
9891 (00000000-0000-0000-0000-000000000000).
9892 x__xgafv: string, V1 error format.
9893 Allowed values
9894 1 - v1 error format
9895 2 - v2 error format
9896
9897 Returns:
9898 An object of the form:
9899
9900 { # Represents an Operation resource.
9901 #
9902 # Google Compute Engine has three Operation resources:
9903 #
9904 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
9905 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
9906 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
9907 #
9908 # You can use an operation resource to manage asynchronous API requests.
9909 # For more information, readHandling
9910 # API responses.
9911 #
9912 # Operations can be global, regional or zonal.
9913 #
9914 # - For global operations, use the `globalOperations`
9915 # resource.
9916 # - For regional operations, use the
9917 # `regionOperations` resource.
9918 # - For zonal operations, use
9919 # the `zoneOperations` resource.
9920 #
9921 #
9922 #
9923 # For more information, read
9924 # Global, Regional, and Zonal Resources.
9925 #
9926 # Note that completed Operation resources have a limited
9927 # retention period.
9928 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9929 # Not present otherwise.
9930 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9931 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9932 # set when the operation is created.
9933 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9934 # text format.
9935 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9936 # this field will be populated.
9937 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9938 # operation.
9939 {
9940 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9941 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9942 # details. There is a set of defined message types to use for providing
9943 # details.The syntax depends on the error code. For example,
9944 # QuotaExceededInfo will have details when the error code is
9945 # QUOTA_EXCEEDED.
9946 {
9947 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9948 #
9949 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9950 # is not enabled:
9951 #
9952 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9953 # &quot;domain&quot;: &quot;googleapis.com&quot;
9954 # &quot;metadata&quot;: {
9955 # &quot;resource&quot;: &quot;projects/123&quot;,
9956 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9957 # }
9958 # }
9959 #
9960 # This response indicates that the pubsub.googleapis.com API is not enabled.
9961 #
9962 # Example of an error that is returned when attempting to create a Spanner
9963 # instance in a region that is out of stock:
9964 #
9965 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9966 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9967 # &quot;metadata&quot;: {
9968 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9969 # }
9970 # }
9971 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9972 # is typically the registered service name of the tool or product that
9973 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9974 # generated by some common infrastructure, the error domain must be a
9975 # globally unique value that identifies the infrastructure. For Google API
9976 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9977 &quot;metadatas&quot;: { # Additional structured details about this error.
9978 #
9979 # Keys must match a regular expression of `a-z+` but should
9980 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9981 # length. When identifying the current value of an exceeded limit, the units
9982 # should be contained in the key, not the value. For example, rather than
9983 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9984 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9985 # instances that can be created in a single (batch) request.
9986 &quot;a_key&quot;: &quot;A String&quot;,
9987 },
9988 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9989 # proximate cause of the error. Error reasons are unique within a particular
9990 # domain of errors. This should be at most 63 characters and match a
9991 # regular expression of `A-Z+[A-Z0-9]`, which represents
9992 # UPPER_SNAKE_CASE.
9993 },
9994 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9995 #
9996 # For example, if a quota check failed with an error indicating the calling
9997 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9998 # directly to the right place in the developer console to flip the bit.
9999 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
10000 { # Describes a URL link.
10001 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
10002 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
10003 },
10004 ],
10005 },
10006 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
10007 # which can be attached to an RPC error.
10008 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
10009 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
10010 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
10011 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
10012 },
10013 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
10014 &quot;dimensions&quot;: { # The map holding related quota dimensions.
10015 &quot;a_key&quot;: &quot;A String&quot;,
10016 },
10017 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
10018 # type or metric.
10019 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
10020 # or metric.
10021 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
10022 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
10023 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
10024 },
10025 },
10026 ],
10027 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
10028 # This property is optional.
10029 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
10030 },
10031 ],
10032 },
10033 &quot;getVersionOperationMetadata&quot;: {
10034 &quot;inlineSbomInfo&quot;: {
10035 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
10036 # appropriate identifiers.
10037 &quot;a_key&quot;: &quot;A String&quot;,
10038 },
10039 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
10040 # identifiers.
10041 &quot;a_key&quot;: &quot;A String&quot;,
10042 },
10043 },
10044 },
10045 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
10046 # message that was returned, such as `NOT FOUND`.
10047 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
10048 # status code that was returned. For example, a `404` means the
10049 # resource was not found.
10050 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
10051 # defined by the server.
10052 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
10053 # This value is inRFC3339
10054 # text format.
10055 &quot;instancesBulkInsertOperationMetadata&quot;: {
10056 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
10057 # Example key: zones/us-central1-a
10058 &quot;a_key&quot;: {
10059 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
10060 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
10061 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
10062 # error.
10063 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
10064 # if the flow is rolling forward or rolling back.
10065 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
10066 },
10067 },
10068 },
10069 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
10070 # Operation resources.
10071 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
10072 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
10073 # group of operations results from a `bulkInsert` API request.
10074 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
10075 # `update`, or `delete`, and so on.
10076 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
10077 # There is no requirement that this be linear or support any granularity of
10078 # operations. This should not be used to guess when the operation will be
10079 # complete. This number should monotonically increase as the operation
10080 # progresses.
10081 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
10082 # applicable when performing regional operations.
10083 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10084 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
10085 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
10086 # this field will contain information on all underlying zonal actions and
10087 # their state.
10088 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
10089 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
10090 # Example key: zones/us-central1-a
10091 &quot;a_key&quot;: {
10092 &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
10093 # populated.
10094 # different programming environments, including REST APIs and RPC APIs. It is
10095 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
10096 # three pieces of data: error code, error message, and error details.
10097 #
10098 # You can find out more about this error model and how to work with it in the
10099 # [API Design Guide](https://cloud.google.com/apis/design/errors).
10100 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
10101 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
10102 # message types for APIs to use.
10103 {
10104 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
10105 },
10106 ],
10107 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
10108 # user-facing error message should be localized and sent in the
10109 # google.rpc.Status.details field, or localized by the client.
10110 },
10111 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
10112 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
10113 },
10114 },
10115 },
10116 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
10117 # This value is inRFC3339
10118 # text format.
10119 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
10120 # following:
10121 # `PENDING`, `RUNNING`, or `DONE`.
10122 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
10123 # operation.
10124 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
10125 # of the target resource.
10126 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
10127 # operations related to creating a snapshot, this points to the disk
10128 # that the snapshot was created from.
10129 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
10130 # `[email protected]` or
10131 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
10132 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
10133 # operation, this field will be populated.
10134 {
10135 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
10136 # Engine returns NO_RESULTS_ON_PAGE if there
10137 # are no results in the response.
10138 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
10139 # value format. For example:
10140 #
10141 # &quot;data&quot;: [
10142 # {
10143 # &quot;key&quot;: &quot;scope&quot;,
10144 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
10145 # }
10146 {
10147 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
10148 # returned. For example, for warnings where there are no results in a list
10149 # request for a particular zone, this key might be scope and
10150 # the key value might be the zone name. Other examples might be a key
10151 # indicating a deprecated resource and a suggested replacement, or a
10152 # warning about invalid network settings (for example, if an instance
10153 # attempts to perform IP forwarding but is not enabled for IP forwarding).
10154 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
10155 },
10156 ],
10157 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
10158 },
10159 ],
10160 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
10161 # applicable when performing per-zone operations.
10162 }</pre>
10163 </div>
10164
10165 </body></html>