Debian Codegraph @

docs/dyn/compute_v1.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_v1.html">Compute Engine API</a> . <a href="compute_v1.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="#deleteRoutePolicy">deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes Route Policy</p>
92 <p class="toc_element">
93 <code><a href="#get">get(project, region, router, x__xgafv=None)</a></code></p>
94 <p class="firstline">Returns the specified Router resource.</p>
95 <p class="toc_element">
96 <code><a href="#getNatIpInfo">getNatIpInfo(project, region, router, natName=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Retrieves runtime NAT IP information.</p>
98 <p class="toc_element">
99 <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>
100 <p class="firstline">Retrieves runtime Nat mapping information of VM endpoints.</p>
101 <p class="toc_element">
102 <code><a href="#getNatMappingInfo_next">getNatMappingInfo_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#getRoutePolicy">getRoutePolicy(project, region, router, policy=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Returns specified Route Policy</p>
107 <p class="toc_element">
108 <code><a href="#getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</a></code></p>
109 <p class="firstline">Retrieves runtime information of the specified router.</p>
110 <p class="toc_element">
111 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Creates a Router resource in the specified project and region using</p>
113 <p class="toc_element">
114 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Retrieves a list of Router resources available to the specified project.</p>
116 <p class="toc_element">
117 <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>
118 <p class="firstline">Retrieves a list of router bgp routes available to the specified project.</p>
119 <p class="toc_element">
120 <code><a href="#listBgpRoutes_next">listBgpRoutes_next()</a></code></p>
121 <p class="firstline">Retrieves the next page of results.</p>
122 <p class="toc_element">
123 <code><a href="#listRoutePolicies">listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Retrieves a list of router route policy subresources available to the</p>
125 <p class="toc_element">
126 <code><a href="#listRoutePolicies_next">listRoutePolicies_next()</a></code></p>
127 <p class="firstline">Retrieves the next page of results.</p>
128 <p class="toc_element">
129 <code><a href="#list_next">list_next()</a></code></p>
130 <p class="firstline">Retrieves the next page of results.</p>
131 <p class="toc_element">
132 <code><a href="#patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
133 <p class="firstline">Patches the specified Router resource with the data included in the</p>
134 <p class="toc_element">
135 <code><a href="#patchRoutePolicy">patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Patches Route Policy</p>
137 <p class="toc_element">
138 <code><a href="#preview">preview(project, region, router, body=None, x__xgafv=None)</a></code></p>
139 <p class="firstline">Preview fields auto-generated during router create andupdate operations.</p>
140 <p class="toc_element">
141 <code><a href="#update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
142 <p class="firstline">Updates the specified Router resource with the data included in the</p>
143 <p class="toc_element">
144 <code><a href="#updateRoutePolicy">updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Updates or creates new Route Policy</p>
146 <h3>Method Details</h3>
147 <div class="method">
148 <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>
149 <pre>Retrieves an aggregated list of routers.
150
151 To prevent failure, Google recommends that you set the
152 `returnPartialSuccess` parameter to `true`.
153
154 Args:
155 project: string, Project ID for this request. (required)
156 filter: string, A filter expression that filters resources listed in the response. Most
157 Compute resources support two types of filter expressions:
158 expressions that support regular expressions and expressions that follow
159 API improvement proposal AIP-160.
160 These two types of filter expressions cannot be mixed in one request.
161
162 If you want to use AIP-160, your expression must specify the field name, an
163 operator, and the value that you want to use for filtering. The value
164 must be a string, a number, or a boolean. The operator
165 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
166
167 For example, if you are filtering Compute Engine instances, you can
168 exclude instances named `example-instance` by specifying
169 `name != example-instance`.
170
171 The `:*` comparison can be used to test whether a key has been defined.
172 For example, to find all objects with `owner` label use:
173 ```
174 labels.owner:*
175 ```
176
177 You can also filter nested fields. For example, you could specify
178 `scheduling.automaticRestart = false` to include instances only
179 if they are not scheduled for automatic restarts. You can use filtering
180 on nested fields to filter based onresource labels.
181
182 To filter on multiple expressions, provide each separate expression within
183 parentheses. For example:
184 ```
185 (scheduling.automaticRestart = true)
186 (cpuPlatform = &quot;Intel Skylake&quot;)
187 ```
188 By default, each expression is an `AND` expression. However, you
189 can include `AND` and `OR` expressions explicitly.
190 For example:
191 ```
192 (cpuPlatform = &quot;Intel Skylake&quot;) OR
193 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
194 (scheduling.automaticRestart = true)
195 ```
196
197 If you want to use a regular expression, use the `eq` (equal) or `ne`
198 (not equal) operator against a single un-parenthesized expression with or
199 without quotes or against multiple parenthesized expressions. Examples:
200
201 `fieldname eq unquoted literal`
202 `fieldname eq &#x27;single quoted literal&#x27;`
203 `fieldname eq &quot;double quoted literal&quot;`
204 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
205
206 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
207 The literal value must match the entire field.
208
209 For example, to filter for instances that do not end with name &quot;instance&quot;,
210 you would use `name ne .*instance`.
211
212 You cannot combine constraints on multiple fields using regular
213 expressions.
214 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
215 global) should be included in the response. For new resource types added
216 after this field, the flag has no effect as new resource types will always
217 include every visible scope for each scope type in response. For resource
218 types which predate this field, if this flag is omitted or false, only
219 scopes of the scope types where the resource type is expected to be found
220 will be included.
221 maxResults: integer, The maximum number of results per page that should be returned.
222 If the number of available results is larger than `maxResults`,
223 Compute Engine returns a `nextPageToken` that can be used to get
224 the next page of results in subsequent list requests. Acceptable values are
225 `0` to `500`, inclusive. (Default: `500`)
226 orderBy: string, Sorts list results by a certain order. By default, results
227 are returned in alphanumerical order based on the resource name.
228
229 You can also sort results in descending order based on the creation
230 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
231 results based on the `creationTimestamp` field in
232 reverse chronological order (newest result first). Use this to sort
233 resources like operations so that the newest operation is returned first.
234
235 Currently, only sorting by `name` or
236 `creationTimestamp desc` is supported.
237 pageToken: string, Specifies a page token to use. Set `pageToken` to the
238 `nextPageToken` returned by a previous list request to get
239 the next page of results.
240 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
241 of failure. The default value is false.
242
243 For example, when partial success behavior is enabled, aggregatedList for a
244 single zone scope either returns all resources in the zone or no resources,
245 with an error code.
246 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
247 aggregated list request is invoked for subnetworks list-usable api.
248 x__xgafv: string, V1 error format.
249 Allowed values
250 1 - v1 error format
251 2 - v2 error format
252
253 Returns:
254 An object of the form:
255
256 { # Contains a list of routers.
257 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
258 &quot;items&quot;: { # A list of Router resources.
259 &quot;a_key&quot;: { # Name of the scope containing this set of routers.
260 &quot;routers&quot;: [ # A list of routers contained in this scope.
261 { # Represents a Cloud Router resource.
262 #
263 # For more information about Cloud Router, read theCloud
264 # Router overview.
265 &quot;bgp&quot;: { # BGP information specific to this router.
266 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
267 # The options are DEFAULT or CUSTOM.
268 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
269 # This field can only be populated if advertise_mode is CUSTOM and
270 # is advertised to all peers of the router.
271 # These groups will be advertised in addition to any specified prefixes.
272 # Leave this field blank to advertise no custom groups.
273 &quot;A String&quot;,
274 ],
275 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
276 # This field can only be populated if advertise_mode is CUSTOM and
277 # is advertised to all peers of the router.
278 # These IP ranges will be advertised in addition to any specified groups.
279 # Leave this field blank to advertise no custom IP ranges.
280 { # Description-tagged IP ranges for the router to advertise.
281 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
282 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
283 },
284 ],
285 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
286 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
287 # value will be fixed for this router resource. All VPN tunnels that link
288 # to this router will have the same local ASN.
289 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
290 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
291 # least /30, even if the BGP sessions are over IPv6. It must not overlap
292 # with any IPv4 BGP session ranges.
293 #
294 #
295 # Other vendors commonly call this &quot;router ID&quot;.
296 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
297 # sent to the peer.
298 #
299 #
300 # Hold time is three times the interval at which keepalive messages are
301 # sent, and the hold time is the maximum number of seconds allowed to
302 # elapse between successive keepalive messages that BGP receives from a
303 # peer.
304 #
305 #
306 # BGP will use the smaller of either the local hold time value or the
307 # peer&#x27;s hold time value as the hold time for the BGP connection between
308 # the two peers.
309 #
310 #
311 # If set, this value must be between 20 and 60. The default is 20.
312 },
313 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
314 # establish BGP peering. This information must specify the peer ASN and
315 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
316 {
317 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
318 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
319 # which currently supports the following option:
320 #
321 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
322 # excludes any routes learned for subnets that use
323 # VPC Network Peering.
324 #
325 #
326 # Note that this field can only be populated if advertise_mode is CUSTOM
327 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
328 # These groups are advertised in addition to any specified prefixes.
329 # Leave this field blank to advertise no custom groups.
330 &quot;A String&quot;,
331 ],
332 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
333 # This field can only be populated if advertise_mode is CUSTOM and
334 # overrides the list defined for the router (in the &quot;bgp&quot; message).
335 # These IP ranges are advertised in addition to any specified groups.
336 # Leave this field blank to advertise no custom IP ranges.
337 { # Description-tagged IP ranges for the router to advertise.
338 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
339 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
340 },
341 ],
342 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
343 # than one matching route of maximum length, the routes with the lowest
344 # priority value win.
345 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
346 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
347 # received from the peer router. The actual value is negotiated between
348 # the two routers and is equal to the greater of this value and the
349 # transmit interval of the other router.
350 #
351 #
352 # If set, this value must be between 1000 and 30000.
353 #
354 #
355 # The default is 1000.
356 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
357 # transmitted to the peer router. The actual value is negotiated between
358 # the two routers and is equal to the greater of this value and the
359 # corresponding receive interval of the other router.
360 #
361 #
362 # If set, this value must be between 1000 and 30000.
363 #
364 #
365 # The default is 1000.
366 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
367 # before BFD declares that a peer is unavailable.
368 #
369 #
370 # If set, the value must be a value between 5 and 16.
371 #
372 #
373 # The default is 5.
374 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
375 #
376 #
377 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
378 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
379 # peer router to initiate the BFD session for this BGP peer. If set to
380 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
381 },
382 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
383 # session.
384 {
385 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
386 # CIDR-formatted prefix. If an IP address is provided without a subnet
387 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
388 # range, and, for IPv6, `/128`.
389 },
390 ],
391 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
392 # value is applied to all custom learned route ranges for the session.
393 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
394 # value, Google Cloud assigns a priority of `100` to the ranges.
395 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
396 #
397 #
398 # If set to FALSE, any active session with the peer is terminated and
399 # all associated routing information is removed. If set to TRUE, the
400 # peer connection can be established with routing information. The default
401 # is TRUE.
402 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
403 # the peerIpAddress is version 4.
404 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
405 # peerIpAddress is version 6.
406 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
407 # evaluated. The name must correspond to an existing policy that has
408 # ROUTE_POLICY_TYPE_EXPORT type.
409 &quot;A String&quot;,
410 ],
411 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
412 # evaluated. The name must correspond to an existing policy that has
413 # ROUTE_POLICY_TYPE_IMPORT type.
414 &quot;A String&quot;,
415 ],
416 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
417 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
418 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
419 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
420 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
421 #
422 # - MANAGED_BY_USER is the default value and can be managed by you
423 # or other users
424 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
425 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
426 # PARTNER. Google automatically creates, updates, and deletes this type of
427 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
428 # or deleted.
429 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
430 # name of one of the entries in the Router.md5_authentication_keys. The
431 # field must comply with RFC1035.
432 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
433 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
434 # characters long and match the regular expression
435 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
436 # lowercase letter, and all following characters must be a dash, lowercase
437 # letter, or digit, except the last character, which cannot be a dash.
438 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
439 # a different value.
440 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
441 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
442 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
443 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
444 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
445 # Appliances. The VM instance must be located in zones contained in the
446 # same region as this Cloud Router.
447 # The VM instance is the peer side of the BGP session.
448 },
449 ],
450 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
451 # text format.
452 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
453 # create the resource.
454 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
455 # attachments (interconnectAttachments).
456 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
457 # defined by the server.
458 &quot;interfaces&quot;: [ # Router interfaces.
459 # To create a BGP peer that uses a router interface,
460 # the interface must have one of the following fields specified:
461 #
462 # - linkedVpnTunnel
463 # - linkedInterconnectAttachment
464 # - subnetwork
465 #
466 #
467 # You can create a router interface without any of these fields specified.
468 # However, you cannot create a BGP peer that uses that interface.
469 {
470 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
471 #
472 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
473 # be a CIDR-formatted string, for example, 169.254.0.1/30.
474 # Note: Do not truncate the IP address, as it represents the IP address of
475 # the interface.
476 # - For Internet Protocol version 6 (IPv6), the value
477 # must be a unique local address (ULA) range from fdff:1::/64
478 # with a mask length of 126 or less. This value should be a CIDR-formatted
479 # string, for example, fdff:1::1/112. Within the router&#x27;s
480 # VPC, this IPv6 prefix will be reserved exclusively for this connection
481 # and cannot be used for any other purpose.
482 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
483 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
484 # as the router. Each interface can have one linked resource, which can be
485 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
486 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
487 # router. Each interface can have one linked resource, which can be
488 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
489 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
490 #
491 # - MANAGED_BY_USER is the default value and can be managed directly
492 # by users.
493 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
494 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
495 # of type PARTNER. Google automatically creates, updates, and deletes
496 # this type of interface when the PARTNER InterconnectAttachment is
497 # created, updated, or deleted.
498 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
499 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
500 # characters long and match the regular expression
501 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
502 # lowercase letter, and all following characters must be a dash, lowercase
503 # letter, or digit, except the last character, which cannot be a dash.
504 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
505 # BGP sessions to a VM instance acting as a third-party
506 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
507 # an SD-WAN VM.
508 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
509 # you are creating. The redundantInterface must belong to the same Cloud
510 # Router as the interface here. To establish the BGP session to a Router
511 # Appliance VM, you must create two BGP peers. The two BGP peers must be
512 # attached to two separate interfaces that are redundant with each other.
513 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
514 # be 1-63 characters long and match the regular expression
515 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
516 # lowercase letter, and all following characters must be a dash, lowercase
517 # letter, or digit, except the last character, which cannot be a dash.
518 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
519 # must be in the same region as the Cloud Router.
520 # When you establish a BGP session to a VM instance using this interface,
521 # the VM instance must belong to the same subnetwork as the subnetwork
522 # specified here.
523 },
524 ],
525 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
526 # routers.
527 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
528 {
529 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
530 #
531 # For patch and update calls, it can be skipped to
532 # copy the value from the previous configuration. This is allowed if the
533 # key with the same name existed before the operation. Maximum length is 80
534 # characters. Can only contain printable ASCII characters.
535 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
536 #
537 # Must be unique within a router. Must be referenced by exactly
538 # one bgpPeer. Must comply withRFC1035.
539 },
540 ],
541 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
542 # The name must be 1-63 characters long, and comply withRFC1035.
543 # Specifically, the name must be 1-63 characters long and match the regular
544 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
545 # character must be a lowercase letter, and all following characters must
546 # be a dash, lowercase letter, or digit, except the last character, which
547 # cannot be a dash.
548 &quot;nats&quot;: [ # A list of NAT services created in this router.
549 { # Represents a Nat resource. It enables the VMs within the specified
550 # subnetworks to access Internet without external IP addresses. It specifies
551 # a list of subnetworks (and the ranges within) that want to use NAT.
552 # Customers can also provide the external IPs that would be used for NAT. GCP
553 # would auto-allocate ephemeral IPs if no external IPs are provided.
554 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
555 # Must be one of: PREMIUM, STANDARD.
556 # If not specified, then the current
557 # project-level default tier is used.
558 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
559 # must be valid static external IPs that have been assigned to the NAT.
560 # These IPs should be used for updating/patching a NAT only.
561 &quot;A String&quot;,
562 ],
563 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
564 # state. This value is equal to tcp_time_wait_timeout_sec.
565 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
566 # 120s. The field is output only.
567 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
568 #
569 #
570 # If not specified, it is disabled by default.
571 #
572 #
573 # If set to true,
574 #
575 # - Dynamic Port Allocation will be enabled on this NAT
576 # config.
577 # - enableEndpointIndependentMapping cannot be set to true.
578 # - If minPorts is set, minPortsPerVm must be set to a
579 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
580 # minimum of 32 ports will be allocated to a VM from this NAT
581 # config.
582 &quot;enableEndpointIndependentMapping&quot;: True or False,
583 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
584 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
585 &quot;A String&quot;,
586 ],
587 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
588 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
589 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
590 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
591 # logs are exported for all connections handled by this NAT.
592 # This option can take one of the following values:
593 #
594 # - ERRORS_ONLY: Export logs only for connection failures.
595 # - TRANSLATIONS_ONLY: Export logs only for successful
596 # connections.
597 # - ALL: Export logs for all connections, successful and
598 # unsuccessful.
599 },
600 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
601 # Dynamic Port Allocation is enabled.
602 #
603 #
604 # If Dynamic Port Allocation is not enabled, this field has no effect.
605 #
606 #
607 # If Dynamic Port Allocation is enabled, and this field is set, it must be
608 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
609 # is not set.
610 #
611 #
612 # If Dynamic Port Allocation is enabled and this field is not set,
613 # a maximum of 65536 ports will be allocated to a VM from this NAT
614 # config.
615 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
616 # set, a default number of ports is allocated to a VM. This is rounded
617 # up to the nearest power of 2. For example, if the value of this field is
618 # 50, at least 64 ports are allocated to a VM.
619 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
620 # The name must be 1-63 characters long and comply withRFC1035.
621 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
622 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
623 # selected for the SubnetworkIpRangeToNat64Option above.
624 { # Specifies a subnetwork to enable NAT64.
625 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
626 },
627 ],
628 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
629 # values:
630 #
631 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
632 # customers. When there are not enough specified Nat IPs, the Nat service
633 # fails for new VMs.
634 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
635 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
636 # be empty.
637 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
638 # addresses must be valid static external IP addresses assigned to the
639 # project.
640 &quot;A String&quot;,
641 ],
642 &quot;rules&quot;: [ # A list of rules associated with this NAT.
643 {
644 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
645 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
646 # addresses must be valid static external IP addresses assigned to the
647 # project.
648 # This field is used for public NAT.
649 &quot;A String&quot;,
650 ],
651 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
652 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
653 # This field is used for private NAT.
654 &quot;A String&quot;,
655 ],
656 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
657 # must be valid static external IPs that have been assigned to the NAT.
658 # These IPs should be used for updating/patching a NAT rule only.
659 # This field is used for public NAT.
660 &quot;A String&quot;,
661 ],
662 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
663 # drained. This is only supported on patch/update, and these
664 # subnetworks must have previously been used as active ranges in this
665 # NAT Rule.
666 # This field is used for private NAT.
667 &quot;A String&quot;,
668 ],
669 },
670 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
671 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
672 # from a VM is evaluated against. If it evaluates to true, the
673 # corresponding `action` is enforced.
674 #
675 # The following examples are valid match expressions for public NAT:
676 #
677 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
678 # &#x27;2.2.0.0/16&#x27;)`
679 #
680 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
681 #
682 # The following example is a valid match expression for private NAT:
683 #
684 # `nexthop.hub ==
685 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
686 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
687 # must be a positive value between 0 and 65000, and
688 # must be unique among rules within a NAT.
689 },
690 ],
691 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
692 #
693 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
694 # Subnetwork are allowed to Nat.
695 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
696 # in every Subnetwork are allowed to Nat.
697 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
698 # (specified in the field subnetwork below)
699 #
700 #
701 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
702 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
703 # should not be any other Router.Nat section in any Router for this network
704 # in this region.
705 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
706 # values:
707 #
708 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
709 # every Subnetwork are allowed to Nat.
710 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
711 # (specified in the field nat64_subnetwork below)
712 #
713 #
714 # The default is NAT64_OPTION_UNSPECIFIED.
715 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
716 # Router.Nat section in this region can also enable NAT64 for any
717 # Subnetworks in this network. Other Router.Nat sections can still be
718 # present to enable NAT44 only.
719 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
720 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
721 # SubnetworkIpRangeToNatOption above.
722 { # Defines the IP ranges that want to use NAT for a subnetwork.
723 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
724 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
725 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
726 # is one of the values in source_ip_ranges_to_nat.
727 &quot;A String&quot;,
728 ],
729 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
730 # options of a single value are valid except
731 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
732 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
733 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
734 # Default: [ALL_IP_RANGES]
735 &quot;A String&quot;,
736 ],
737 },
738 ],
739 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
740 # if not set.
741 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
742 # Defaults to 120s if not set.
743 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
744 # not set.
745 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
746 # translation. If unspecified, it defaults to PUBLIC.
747 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
748 },
749 ],
750 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
751 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
752 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
753 # as part of resource payload.
754 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
755 # The field is allowed for INSERT
756 # only. The keys/values to set on the resource should be specified in
757 # either ID { : } or Namespaced format
758 # { : }.
759 # For example the following are valid inputs:
760 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
761 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
762 # Note:
763 # * Invalid combinations of ID &amp; namespaced format is not supported. For
764 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
765 # * Inconsistent format is not supported. For instance:
766 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
767 &quot;a_key&quot;: &quot;A String&quot;,
768 },
769 },
770 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
771 # You must specify this field as part of the HTTP request URL. It is
772 # not settable as a field in the request body.
773 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
774 },
775 ],
776 &quot;warning&quot;: { # Informational warning which replaces the list of routers when
777 # the list is empty.
778 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
779 # Engine returns NO_RESULTS_ON_PAGE if there
780 # are no results in the response.
781 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
782 # value format. For example:
783 #
784 # &quot;data&quot;: [
785 # {
786 # &quot;key&quot;: &quot;scope&quot;,
787 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
788 # }
789 {
790 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
791 # returned. For example, for warnings where there are no results in a list
792 # request for a particular zone, this key might be scope and
793 # the key value might be the zone name. Other examples might be a key
794 # indicating a deprecated resource and a suggested replacement, or a
795 # warning about invalid network settings (for example, if an instance
796 # attempts to perform IP forwarding but is not enabled for IP forwarding).
797 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
798 },
799 ],
800 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
801 },
802 },
803 },
804 &quot;kind&quot;: &quot;compute#routerAggregatedList&quot;, # Output only. Type of resource.
805 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
806 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
807 # the query parameter pageToken in the next list request.
808 # Subsequent list requests will have their own nextPageToken to
809 # continue paging through the results.
810 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
811 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
812 &quot;A String&quot;,
813 ],
814 &quot;warning&quot;: { # [Output Only] Informational warning message.
815 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
816 # Engine returns NO_RESULTS_ON_PAGE if there
817 # are no results in the response.
818 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
819 # value format. For example:
820 #
821 # &quot;data&quot;: [
822 # {
823 # &quot;key&quot;: &quot;scope&quot;,
824 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
825 # }
826 {
827 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
828 # returned. For example, for warnings where there are no results in a list
829 # request for a particular zone, this key might be scope and
830 # the key value might be the zone name. Other examples might be a key
831 # indicating a deprecated resource and a suggested replacement, or a
832 # warning about invalid network settings (for example, if an instance
833 # attempts to perform IP forwarding but is not enabled for IP forwarding).
834 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
835 },
836 ],
837 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
838 },
839 }</pre>
840 </div>
841
842 <div class="method">
843 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
844 <pre>Retrieves the next page of results.
845
846 Args:
847 previous_request: The request for the previous page. (required)
848 previous_response: The response from the request for the previous page. (required)
849
850 Returns:
851 A request object that you can call &#x27;execute()&#x27; on to request the next
852 page. Returns None if there are no more items in the collection.
853 </pre>
854 </div>
855
856 <div class="method">
857 <code class="details" id="close">close()</code>
858 <pre>Close httplib2 connections.</pre>
859 </div>
860
861 <div class="method">
862 <code class="details" id="delete">delete(project, region, router, requestId=None, x__xgafv=None)</code>
863 <pre>Deletes the specified Router resource.
864
865 Args:
866 project: string, Project ID for this request. (required)
867 region: string, Name of the region for this request. (required)
868 router: string, Name of the Router resource to delete. (required)
869 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
870 that if you must retry your request, the server will know to ignore the
871 request if it has already been completed.
872
873 For example, consider a situation where you make an initial request and
874 the request times out. If you make the request again with the same
875 request ID, the server can check if original operation with the same
876 request ID was received, and if so, will ignore the second request. This
877 prevents clients from accidentally creating duplicate commitments.
878
879 The request ID must be
880 a valid UUID with the exception that zero UUID is not supported
881 (00000000-0000-0000-0000-000000000000).
882 x__xgafv: string, V1 error format.
883 Allowed values
884 1 - v1 error format
885 2 - v2 error format
886
887 Returns:
888 An object of the form:
889
890 { # Represents an Operation resource.
891 #
892 # Google Compute Engine has three Operation resources:
893 #
894 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
895 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
896 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
897 #
898 # You can use an operation resource to manage asynchronous API requests.
899 # For more information, readHandling
900 # API responses.
901 #
902 # Operations can be global, regional or zonal.
903 #
904 # - For global operations, use the `globalOperations`
905 # resource.
906 # - For regional operations, use the
907 # `regionOperations` resource.
908 # - For zonal operations, use
909 # the `zoneOperations` resource.
910 #
911 #
912 #
913 # For more information, read
914 # Global, Regional, and Zonal Resources.
915 #
916 # Note that completed Operation resources have a limited
917 # retention period.
918 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
919 # Not present otherwise.
920 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
921 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
922 # set when the operation is created.
923 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
924 # text format.
925 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
926 # this field will be populated.
927 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
928 # operation.
929 {
930 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
931 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
932 # details. There is a set of defined message types to use for providing
933 # details.The syntax depends on the error code. For example,
934 # QuotaExceededInfo will have details when the error code is
935 # QUOTA_EXCEEDED.
936 {
937 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
938 #
939 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
940 # is not enabled:
941 #
942 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
943 # &quot;domain&quot;: &quot;googleapis.com&quot;
944 # &quot;metadata&quot;: {
945 # &quot;resource&quot;: &quot;projects/123&quot;,
946 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
947 # }
948 # }
949 #
950 # This response indicates that the pubsub.googleapis.com API is not enabled.
951 #
952 # Example of an error that is returned when attempting to create a Spanner
953 # instance in a region that is out of stock:
954 #
955 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
956 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
957 # &quot;metadata&quot;: {
958 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
959 # }
960 # }
961 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
962 # is typically the registered service name of the tool or product that
963 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
964 # generated by some common infrastructure, the error domain must be a
965 # globally unique value that identifies the infrastructure. For Google API
966 # infrastructure, the error domain is &quot;googleapis.com&quot;.
967 &quot;metadatas&quot;: { # Additional structured details about this error.
968 #
969 # Keys must match a regular expression of `a-z+` but should
970 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
971 # length. When identifying the current value of an exceeded limit, the units
972 # should be contained in the key, not the value. For example, rather than
973 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
974 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
975 # instances that can be created in a single (batch) request.
976 &quot;a_key&quot;: &quot;A String&quot;,
977 },
978 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
979 # proximate cause of the error. Error reasons are unique within a particular
980 # domain of errors. This should be at most 63 characters and match a
981 # regular expression of `A-Z+[A-Z0-9]`, which represents
982 # UPPER_SNAKE_CASE.
983 },
984 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
985 #
986 # For example, if a quota check failed with an error indicating the calling
987 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
988 # directly to the right place in the developer console to flip the bit.
989 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
990 { # Describes a URL link.
991 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
992 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
993 },
994 ],
995 },
996 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
997 # which can be attached to an RPC error.
998 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
999 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1000 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1001 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1002 },
1003 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1004 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1005 &quot;a_key&quot;: &quot;A String&quot;,
1006 },
1007 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1008 # type or metric.
1009 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1010 # or metric.
1011 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1012 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1013 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1014 },
1015 },
1016 ],
1017 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1018 # This property is optional.
1019 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1020 },
1021 ],
1022 },
1023 &quot;getVersionOperationMetadata&quot;: {
1024 &quot;inlineSbomInfo&quot;: {
1025 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1026 # appropriate identifiers.
1027 &quot;a_key&quot;: &quot;A String&quot;,
1028 },
1029 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1030 # identifiers.
1031 &quot;a_key&quot;: &quot;A String&quot;,
1032 },
1033 },
1034 },
1035 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1036 # message that was returned, such as `NOT FOUND`.
1037 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1038 # status code that was returned. For example, a `404` means the
1039 # resource was not found.
1040 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1041 # defined by the server.
1042 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1043 # This value is inRFC3339
1044 # text format.
1045 &quot;instancesBulkInsertOperationMetadata&quot;: {
1046 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1047 # Example key: zones/us-central1-a
1048 &quot;a_key&quot;: {
1049 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1050 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1051 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1052 # error.
1053 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1054 # if the flow is rolling forward or rolling back.
1055 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1056 },
1057 },
1058 },
1059 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1060 # Operation resources.
1061 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1062 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1063 # group of operations results from a `bulkInsert` API request.
1064 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1065 # `update`, or `delete`, and so on.
1066 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1067 # There is no requirement that this be linear or support any granularity of
1068 # operations. This should not be used to guess when the operation will be
1069 # complete. This number should monotonically increase as the operation
1070 # progresses.
1071 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1072 # applicable when performing regional operations.
1073 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1074 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1075 # this field will contain information on all underlying zonal actions and
1076 # their state.
1077 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1078 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1079 # Example key: zones/us-central1-a
1080 &quot;a_key&quot;: {
1081 &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
1082 # populated.
1083 # different programming environments, including REST APIs and RPC APIs. It is
1084 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1085 # three pieces of data: error code, error message, and error details.
1086 #
1087 # You can find out more about this error model and how to work with it in the
1088 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1089 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1090 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1091 # message types for APIs to use.
1092 {
1093 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1094 },
1095 ],
1096 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1097 # user-facing error message should be localized and sent in the
1098 # google.rpc.Status.details field, or localized by the client.
1099 },
1100 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1101 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1102 },
1103 },
1104 },
1105 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1106 # This value is inRFC3339
1107 # text format.
1108 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1109 # following:
1110 # `PENDING`, `RUNNING`, or `DONE`.
1111 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1112 # operation.
1113 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1114 # of the target resource.
1115 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1116 # operations related to creating a snapshot, this points to the disk
1117 # that the snapshot was created from.
1118 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1119 # `[email protected]` or
1120 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1121 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1122 # operation, this field will be populated.
1123 {
1124 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1125 # Engine returns NO_RESULTS_ON_PAGE if there
1126 # are no results in the response.
1127 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1128 # value format. For example:
1129 #
1130 # &quot;data&quot;: [
1131 # {
1132 # &quot;key&quot;: &quot;scope&quot;,
1133 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1134 # }
1135 {
1136 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1137 # returned. For example, for warnings where there are no results in a list
1138 # request for a particular zone, this key might be scope and
1139 # the key value might be the zone name. Other examples might be a key
1140 # indicating a deprecated resource and a suggested replacement, or a
1141 # warning about invalid network settings (for example, if an instance
1142 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1143 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1144 },
1145 ],
1146 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1147 },
1148 ],
1149 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1150 # applicable when performing per-zone operations.
1151 }</pre>
1152 </div>
1153
1154 <div class="method">
1155 <code class="details" id="deleteRoutePolicy">deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)</code>
1156 <pre>Deletes Route Policy
1157
1158 Args:
1159 project: string, Project ID for this request. (required)
1160 region: string, Name of the region for this request. (required)
1161 router: string, Name of the Router resource where Route Policy is defined. (required)
1162 policy: string, The Policy name for this request. Name must conform to RFC1035
1163 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1164 that if you must retry your request, the server will know to ignore the
1165 request if it has already been completed.
1166
1167 For example, consider a situation where you make an initial request and
1168 the request times out. If you make the request again with the same
1169 request ID, the server can check if original operation with the same
1170 request ID was received, and if so, will ignore the second request. This
1171 prevents clients from accidentally creating duplicate commitments.
1172
1173 The request ID must be
1174 a valid UUID with the exception that zero UUID is not supported
1175 (00000000-0000-0000-0000-000000000000).
1176 x__xgafv: string, V1 error format.
1177 Allowed values
1178 1 - v1 error format
1179 2 - v2 error format
1180
1181 Returns:
1182 An object of the form:
1183
1184 { # Represents an Operation resource.
1185 #
1186 # Google Compute Engine has three Operation resources:
1187 #
1188 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1189 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1190 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1191 #
1192 # You can use an operation resource to manage asynchronous API requests.
1193 # For more information, readHandling
1194 # API responses.
1195 #
1196 # Operations can be global, regional or zonal.
1197 #
1198 # - For global operations, use the `globalOperations`
1199 # resource.
1200 # - For regional operations, use the
1201 # `regionOperations` resource.
1202 # - For zonal operations, use
1203 # the `zoneOperations` resource.
1204 #
1205 #
1206 #
1207 # For more information, read
1208 # Global, Regional, and Zonal Resources.
1209 #
1210 # Note that completed Operation resources have a limited
1211 # retention period.
1212 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1213 # Not present otherwise.
1214 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1215 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1216 # set when the operation is created.
1217 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1218 # text format.
1219 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1220 # this field will be populated.
1221 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1222 # operation.
1223 {
1224 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1225 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1226 # details. There is a set of defined message types to use for providing
1227 # details.The syntax depends on the error code. For example,
1228 # QuotaExceededInfo will have details when the error code is
1229 # QUOTA_EXCEEDED.
1230 {
1231 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1232 #
1233 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1234 # is not enabled:
1235 #
1236 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1237 # &quot;domain&quot;: &quot;googleapis.com&quot;
1238 # &quot;metadata&quot;: {
1239 # &quot;resource&quot;: &quot;projects/123&quot;,
1240 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1241 # }
1242 # }
1243 #
1244 # This response indicates that the pubsub.googleapis.com API is not enabled.
1245 #
1246 # Example of an error that is returned when attempting to create a Spanner
1247 # instance in a region that is out of stock:
1248 #
1249 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1250 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1251 # &quot;metadata&quot;: {
1252 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1253 # }
1254 # }
1255 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1256 # is typically the registered service name of the tool or product that
1257 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1258 # generated by some common infrastructure, the error domain must be a
1259 # globally unique value that identifies the infrastructure. For Google API
1260 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1261 &quot;metadatas&quot;: { # Additional structured details about this error.
1262 #
1263 # Keys must match a regular expression of `a-z+` but should
1264 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1265 # length. When identifying the current value of an exceeded limit, the units
1266 # should be contained in the key, not the value. For example, rather than
1267 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1268 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1269 # instances that can be created in a single (batch) request.
1270 &quot;a_key&quot;: &quot;A String&quot;,
1271 },
1272 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1273 # proximate cause of the error. Error reasons are unique within a particular
1274 # domain of errors. This should be at most 63 characters and match a
1275 # regular expression of `A-Z+[A-Z0-9]`, which represents
1276 # UPPER_SNAKE_CASE.
1277 },
1278 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1279 #
1280 # For example, if a quota check failed with an error indicating the calling
1281 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1282 # directly to the right place in the developer console to flip the bit.
1283 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1284 { # Describes a URL link.
1285 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1286 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1287 },
1288 ],
1289 },
1290 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1291 # which can be attached to an RPC error.
1292 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1293 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1294 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1295 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1296 },
1297 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1298 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1299 &quot;a_key&quot;: &quot;A String&quot;,
1300 },
1301 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1302 # type or metric.
1303 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1304 # or metric.
1305 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1306 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1307 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1308 },
1309 },
1310 ],
1311 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1312 # This property is optional.
1313 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1314 },
1315 ],
1316 },
1317 &quot;getVersionOperationMetadata&quot;: {
1318 &quot;inlineSbomInfo&quot;: {
1319 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1320 # appropriate identifiers.
1321 &quot;a_key&quot;: &quot;A String&quot;,
1322 },
1323 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1324 # identifiers.
1325 &quot;a_key&quot;: &quot;A String&quot;,
1326 },
1327 },
1328 },
1329 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1330 # message that was returned, such as `NOT FOUND`.
1331 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1332 # status code that was returned. For example, a `404` means the
1333 # resource was not found.
1334 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1335 # defined by the server.
1336 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1337 # This value is inRFC3339
1338 # text format.
1339 &quot;instancesBulkInsertOperationMetadata&quot;: {
1340 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1341 # Example key: zones/us-central1-a
1342 &quot;a_key&quot;: {
1343 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1344 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1345 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1346 # error.
1347 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1348 # if the flow is rolling forward or rolling back.
1349 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1350 },
1351 },
1352 },
1353 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1354 # Operation resources.
1355 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1356 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1357 # group of operations results from a `bulkInsert` API request.
1358 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1359 # `update`, or `delete`, and so on.
1360 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1361 # There is no requirement that this be linear or support any granularity of
1362 # operations. This should not be used to guess when the operation will be
1363 # complete. This number should monotonically increase as the operation
1364 # progresses.
1365 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1366 # applicable when performing regional operations.
1367 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1368 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1369 # this field will contain information on all underlying zonal actions and
1370 # their state.
1371 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1372 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1373 # Example key: zones/us-central1-a
1374 &quot;a_key&quot;: {
1375 &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
1376 # populated.
1377 # different programming environments, including REST APIs and RPC APIs. It is
1378 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1379 # three pieces of data: error code, error message, and error details.
1380 #
1381 # You can find out more about this error model and how to work with it in the
1382 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1383 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1384 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1385 # message types for APIs to use.
1386 {
1387 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1388 },
1389 ],
1390 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1391 # user-facing error message should be localized and sent in the
1392 # google.rpc.Status.details field, or localized by the client.
1393 },
1394 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1395 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1396 },
1397 },
1398 },
1399 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1400 # This value is inRFC3339
1401 # text format.
1402 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1403 # following:
1404 # `PENDING`, `RUNNING`, or `DONE`.
1405 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1406 # operation.
1407 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1408 # of the target resource.
1409 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1410 # operations related to creating a snapshot, this points to the disk
1411 # that the snapshot was created from.
1412 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1413 # `[email protected]` or
1414 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1415 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1416 # operation, this field will be populated.
1417 {
1418 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1419 # Engine returns NO_RESULTS_ON_PAGE if there
1420 # are no results in the response.
1421 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1422 # value format. For example:
1423 #
1424 # &quot;data&quot;: [
1425 # {
1426 # &quot;key&quot;: &quot;scope&quot;,
1427 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1428 # }
1429 {
1430 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1431 # returned. For example, for warnings where there are no results in a list
1432 # request for a particular zone, this key might be scope and
1433 # the key value might be the zone name. Other examples might be a key
1434 # indicating a deprecated resource and a suggested replacement, or a
1435 # warning about invalid network settings (for example, if an instance
1436 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1437 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1438 },
1439 ],
1440 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1441 },
1442 ],
1443 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1444 # applicable when performing per-zone operations.
1445 }</pre>
1446 </div>
1447
1448 <div class="method">
1449 <code class="details" id="get">get(project, region, router, x__xgafv=None)</code>
1450 <pre>Returns the specified Router resource.
1451
1452 Args:
1453 project: string, Project ID for this request. (required)
1454 region: string, Name of the region for this request. (required)
1455 router: string, Name of the Router resource to return. (required)
1456 x__xgafv: string, V1 error format.
1457 Allowed values
1458 1 - v1 error format
1459 2 - v2 error format
1460
1461 Returns:
1462 An object of the form:
1463
1464 { # Represents a Cloud Router resource.
1465 #
1466 # For more information about Cloud Router, read theCloud
1467 # Router overview.
1468 &quot;bgp&quot;: { # BGP information specific to this router.
1469 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
1470 # The options are DEFAULT or CUSTOM.
1471 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
1472 # This field can only be populated if advertise_mode is CUSTOM and
1473 # is advertised to all peers of the router.
1474 # These groups will be advertised in addition to any specified prefixes.
1475 # Leave this field blank to advertise no custom groups.
1476 &quot;A String&quot;,
1477 ],
1478 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
1479 # This field can only be populated if advertise_mode is CUSTOM and
1480 # is advertised to all peers of the router.
1481 # These IP ranges will be advertised in addition to any specified groups.
1482 # Leave this field blank to advertise no custom IP ranges.
1483 { # Description-tagged IP ranges for the router to advertise.
1484 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
1485 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
1486 },
1487 ],
1488 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
1489 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
1490 # value will be fixed for this router resource. All VPN tunnels that link
1491 # to this router will have the same local ASN.
1492 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
1493 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
1494 # least /30, even if the BGP sessions are over IPv6. It must not overlap
1495 # with any IPv4 BGP session ranges.
1496 #
1497 #
1498 # Other vendors commonly call this &quot;router ID&quot;.
1499 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
1500 # sent to the peer.
1501 #
1502 #
1503 # Hold time is three times the interval at which keepalive messages are
1504 # sent, and the hold time is the maximum number of seconds allowed to
1505 # elapse between successive keepalive messages that BGP receives from a
1506 # peer.
1507 #
1508 #
1509 # BGP will use the smaller of either the local hold time value or the
1510 # peer&#x27;s hold time value as the hold time for the BGP connection between
1511 # the two peers.
1512 #
1513 #
1514 # If set, this value must be between 20 and 60. The default is 20.
1515 },
1516 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
1517 # establish BGP peering. This information must specify the peer ASN and
1518 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
1519 {
1520 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
1521 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
1522 # which currently supports the following option:
1523 #
1524 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
1525 # excludes any routes learned for subnets that use
1526 # VPC Network Peering.
1527 #
1528 #
1529 # Note that this field can only be populated if advertise_mode is CUSTOM
1530 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
1531 # These groups are advertised in addition to any specified prefixes.
1532 # Leave this field blank to advertise no custom groups.
1533 &quot;A String&quot;,
1534 ],
1535 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
1536 # This field can only be populated if advertise_mode is CUSTOM and
1537 # overrides the list defined for the router (in the &quot;bgp&quot; message).
1538 # These IP ranges are advertised in addition to any specified groups.
1539 # Leave this field blank to advertise no custom IP ranges.
1540 { # Description-tagged IP ranges for the router to advertise.
1541 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
1542 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
1543 },
1544 ],
1545 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
1546 # than one matching route of maximum length, the routes with the lowest
1547 # priority value win.
1548 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
1549 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
1550 # received from the peer router. The actual value is negotiated between
1551 # the two routers and is equal to the greater of this value and the
1552 # transmit interval of the other router.
1553 #
1554 #
1555 # If set, this value must be between 1000 and 30000.
1556 #
1557 #
1558 # The default is 1000.
1559 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
1560 # transmitted to the peer router. The actual value is negotiated between
1561 # the two routers and is equal to the greater of this value and the
1562 # corresponding receive interval of the other router.
1563 #
1564 #
1565 # If set, this value must be between 1000 and 30000.
1566 #
1567 #
1568 # The default is 1000.
1569 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
1570 # before BFD declares that a peer is unavailable.
1571 #
1572 #
1573 # If set, the value must be a value between 5 and 16.
1574 #
1575 #
1576 # The default is 5.
1577 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
1578 #
1579 #
1580 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
1581 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
1582 # peer router to initiate the BFD session for this BGP peer. If set to
1583 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
1584 },
1585 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
1586 # session.
1587 {
1588 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
1589 # CIDR-formatted prefix. If an IP address is provided without a subnet
1590 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
1591 # range, and, for IPv6, `/128`.
1592 },
1593 ],
1594 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
1595 # value is applied to all custom learned route ranges for the session.
1596 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
1597 # value, Google Cloud assigns a priority of `100` to the ranges.
1598 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
1599 #
1600 #
1601 # If set to FALSE, any active session with the peer is terminated and
1602 # all associated routing information is removed. If set to TRUE, the
1603 # peer connection can be established with routing information. The default
1604 # is TRUE.
1605 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
1606 # the peerIpAddress is version 4.
1607 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
1608 # peerIpAddress is version 6.
1609 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
1610 # evaluated. The name must correspond to an existing policy that has
1611 # ROUTE_POLICY_TYPE_EXPORT type.
1612 &quot;A String&quot;,
1613 ],
1614 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
1615 # evaluated. The name must correspond to an existing policy that has
1616 # ROUTE_POLICY_TYPE_IMPORT type.
1617 &quot;A String&quot;,
1618 ],
1619 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
1620 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
1621 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
1622 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
1623 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
1624 #
1625 # - MANAGED_BY_USER is the default value and can be managed by you
1626 # or other users
1627 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
1628 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
1629 # PARTNER. Google automatically creates, updates, and deletes this type of
1630 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
1631 # or deleted.
1632 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
1633 # name of one of the entries in the Router.md5_authentication_keys. The
1634 # field must comply with RFC1035.
1635 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
1636 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
1637 # characters long and match the regular expression
1638 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
1639 # lowercase letter, and all following characters must be a dash, lowercase
1640 # letter, or digit, except the last character, which cannot be a dash.
1641 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
1642 # a different value.
1643 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
1644 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
1645 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
1646 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
1647 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
1648 # Appliances. The VM instance must be located in zones contained in the
1649 # same region as this Cloud Router.
1650 # The VM instance is the peer side of the BGP session.
1651 },
1652 ],
1653 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1654 # text format.
1655 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1656 # create the resource.
1657 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
1658 # attachments (interconnectAttachments).
1659 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1660 # defined by the server.
1661 &quot;interfaces&quot;: [ # Router interfaces.
1662 # To create a BGP peer that uses a router interface,
1663 # the interface must have one of the following fields specified:
1664 #
1665 # - linkedVpnTunnel
1666 # - linkedInterconnectAttachment
1667 # - subnetwork
1668 #
1669 #
1670 # You can create a router interface without any of these fields specified.
1671 # However, you cannot create a BGP peer that uses that interface.
1672 {
1673 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
1674 #
1675 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
1676 # be a CIDR-formatted string, for example, 169.254.0.1/30.
1677 # Note: Do not truncate the IP address, as it represents the IP address of
1678 # the interface.
1679 # - For Internet Protocol version 6 (IPv6), the value
1680 # must be a unique local address (ULA) range from fdff:1::/64
1681 # with a mask length of 126 or less. This value should be a CIDR-formatted
1682 # string, for example, fdff:1::1/112. Within the router&#x27;s
1683 # VPC, this IPv6 prefix will be reserved exclusively for this connection
1684 # and cannot be used for any other purpose.
1685 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
1686 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
1687 # as the router. Each interface can have one linked resource, which can be
1688 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
1689 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
1690 # router. Each interface can have one linked resource, which can be
1691 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
1692 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
1693 #
1694 # - MANAGED_BY_USER is the default value and can be managed directly
1695 # by users.
1696 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
1697 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
1698 # of type PARTNER. Google automatically creates, updates, and deletes
1699 # this type of interface when the PARTNER InterconnectAttachment is
1700 # created, updated, or deleted.
1701 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
1702 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
1703 # characters long and match the regular expression
1704 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
1705 # lowercase letter, and all following characters must be a dash, lowercase
1706 # letter, or digit, except the last character, which cannot be a dash.
1707 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
1708 # BGP sessions to a VM instance acting as a third-party
1709 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
1710 # an SD-WAN VM.
1711 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
1712 # you are creating. The redundantInterface must belong to the same Cloud
1713 # Router as the interface here. To establish the BGP session to a Router
1714 # Appliance VM, you must create two BGP peers. The two BGP peers must be
1715 # attached to two separate interfaces that are redundant with each other.
1716 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
1717 # be 1-63 characters long and match the regular expression
1718 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
1719 # lowercase letter, and all following characters must be a dash, lowercase
1720 # letter, or digit, except the last character, which cannot be a dash.
1721 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
1722 # must be in the same region as the Cloud Router.
1723 # When you establish a BGP session to a VM instance using this interface,
1724 # the VM instance must belong to the same subnetwork as the subnetwork
1725 # specified here.
1726 },
1727 ],
1728 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
1729 # routers.
1730 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
1731 {
1732 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
1733 #
1734 # For patch and update calls, it can be skipped to
1735 # copy the value from the previous configuration. This is allowed if the
1736 # key with the same name existed before the operation. Maximum length is 80
1737 # characters. Can only contain printable ASCII characters.
1738 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
1739 #
1740 # Must be unique within a router. Must be referenced by exactly
1741 # one bgpPeer. Must comply withRFC1035.
1742 },
1743 ],
1744 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1745 # The name must be 1-63 characters long, and comply withRFC1035.
1746 # Specifically, the name must be 1-63 characters long and match the regular
1747 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1748 # character must be a lowercase letter, and all following characters must
1749 # be a dash, lowercase letter, or digit, except the last character, which
1750 # cannot be a dash.
1751 &quot;nats&quot;: [ # A list of NAT services created in this router.
1752 { # Represents a Nat resource. It enables the VMs within the specified
1753 # subnetworks to access Internet without external IP addresses. It specifies
1754 # a list of subnetworks (and the ranges within) that want to use NAT.
1755 # Customers can also provide the external IPs that would be used for NAT. GCP
1756 # would auto-allocate ephemeral IPs if no external IPs are provided.
1757 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
1758 # Must be one of: PREMIUM, STANDARD.
1759 # If not specified, then the current
1760 # project-level default tier is used.
1761 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
1762 # must be valid static external IPs that have been assigned to the NAT.
1763 # These IPs should be used for updating/patching a NAT only.
1764 &quot;A String&quot;,
1765 ],
1766 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
1767 # state. This value is equal to tcp_time_wait_timeout_sec.
1768 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
1769 # 120s. The field is output only.
1770 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
1771 #
1772 #
1773 # If not specified, it is disabled by default.
1774 #
1775 #
1776 # If set to true,
1777 #
1778 # - Dynamic Port Allocation will be enabled on this NAT
1779 # config.
1780 # - enableEndpointIndependentMapping cannot be set to true.
1781 # - If minPorts is set, minPortsPerVm must be set to a
1782 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
1783 # minimum of 32 ports will be allocated to a VM from this NAT
1784 # config.
1785 &quot;enableEndpointIndependentMapping&quot;: True or False,
1786 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
1787 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
1788 &quot;A String&quot;,
1789 ],
1790 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
1791 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
1792 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
1793 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
1794 # logs are exported for all connections handled by this NAT.
1795 # This option can take one of the following values:
1796 #
1797 # - ERRORS_ONLY: Export logs only for connection failures.
1798 # - TRANSLATIONS_ONLY: Export logs only for successful
1799 # connections.
1800 # - ALL: Export logs for all connections, successful and
1801 # unsuccessful.
1802 },
1803 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
1804 # Dynamic Port Allocation is enabled.
1805 #
1806 #
1807 # If Dynamic Port Allocation is not enabled, this field has no effect.
1808 #
1809 #
1810 # If Dynamic Port Allocation is enabled, and this field is set, it must be
1811 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
1812 # is not set.
1813 #
1814 #
1815 # If Dynamic Port Allocation is enabled and this field is not set,
1816 # a maximum of 65536 ports will be allocated to a VM from this NAT
1817 # config.
1818 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
1819 # set, a default number of ports is allocated to a VM. This is rounded
1820 # up to the nearest power of 2. For example, if the value of this field is
1821 # 50, at least 64 ports are allocated to a VM.
1822 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
1823 # The name must be 1-63 characters long and comply withRFC1035.
1824 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
1825 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
1826 # selected for the SubnetworkIpRangeToNat64Option above.
1827 { # Specifies a subnetwork to enable NAT64.
1828 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
1829 },
1830 ],
1831 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
1832 # values:
1833 #
1834 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
1835 # customers. When there are not enough specified Nat IPs, the Nat service
1836 # fails for new VMs.
1837 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
1838 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
1839 # be empty.
1840 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
1841 # addresses must be valid static external IP addresses assigned to the
1842 # project.
1843 &quot;A String&quot;,
1844 ],
1845 &quot;rules&quot;: [ # A list of rules associated with this NAT.
1846 {
1847 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
1848 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
1849 # addresses must be valid static external IP addresses assigned to the
1850 # project.
1851 # This field is used for public NAT.
1852 &quot;A String&quot;,
1853 ],
1854 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
1855 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
1856 # This field is used for private NAT.
1857 &quot;A String&quot;,
1858 ],
1859 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
1860 # must be valid static external IPs that have been assigned to the NAT.
1861 # These IPs should be used for updating/patching a NAT rule only.
1862 # This field is used for public NAT.
1863 &quot;A String&quot;,
1864 ],
1865 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
1866 # drained. This is only supported on patch/update, and these
1867 # subnetworks must have previously been used as active ranges in this
1868 # NAT Rule.
1869 # This field is used for private NAT.
1870 &quot;A String&quot;,
1871 ],
1872 },
1873 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
1874 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
1875 # from a VM is evaluated against. If it evaluates to true, the
1876 # corresponding `action` is enforced.
1877 #
1878 # The following examples are valid match expressions for public NAT:
1879 #
1880 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
1881 # &#x27;2.2.0.0/16&#x27;)`
1882 #
1883 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
1884 #
1885 # The following example is a valid match expression for private NAT:
1886 #
1887 # `nexthop.hub ==
1888 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
1889 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
1890 # must be a positive value between 0 and 65000, and
1891 # must be unique among rules within a NAT.
1892 },
1893 ],
1894 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
1895 #
1896 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
1897 # Subnetwork are allowed to Nat.
1898 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
1899 # in every Subnetwork are allowed to Nat.
1900 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
1901 # (specified in the field subnetwork below)
1902 #
1903 #
1904 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
1905 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
1906 # should not be any other Router.Nat section in any Router for this network
1907 # in this region.
1908 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
1909 # values:
1910 #
1911 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
1912 # every Subnetwork are allowed to Nat.
1913 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
1914 # (specified in the field nat64_subnetwork below)
1915 #
1916 #
1917 # The default is NAT64_OPTION_UNSPECIFIED.
1918 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
1919 # Router.Nat section in this region can also enable NAT64 for any
1920 # Subnetworks in this network. Other Router.Nat sections can still be
1921 # present to enable NAT44 only.
1922 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
1923 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
1924 # SubnetworkIpRangeToNatOption above.
1925 { # Defines the IP ranges that want to use NAT for a subnetwork.
1926 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
1927 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
1928 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
1929 # is one of the values in source_ip_ranges_to_nat.
1930 &quot;A String&quot;,
1931 ],
1932 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
1933 # options of a single value are valid except
1934 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
1935 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
1936 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
1937 # Default: [ALL_IP_RANGES]
1938 &quot;A String&quot;,
1939 ],
1940 },
1941 ],
1942 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
1943 # if not set.
1944 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
1945 # Defaults to 120s if not set.
1946 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
1947 # not set.
1948 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
1949 # translation. If unspecified, it defaults to PUBLIC.
1950 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
1951 },
1952 ],
1953 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
1954 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
1955 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1956 # as part of resource payload.
1957 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1958 # The field is allowed for INSERT
1959 # only. The keys/values to set on the resource should be specified in
1960 # either ID { : } or Namespaced format
1961 # { : }.
1962 # For example the following are valid inputs:
1963 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1964 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1965 # Note:
1966 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1967 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1968 # * Inconsistent format is not supported. For instance:
1969 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
1970 &quot;a_key&quot;: &quot;A String&quot;,
1971 },
1972 },
1973 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
1974 # You must specify this field as part of the HTTP request URL. It is
1975 # not settable as a field in the request body.
1976 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1977 }</pre>
1978 </div>
1979
1980 <div class="method">
1981 <code class="details" id="getNatIpInfo">getNatIpInfo(project, region, router, natName=None, x__xgafv=None)</code>
1982 <pre>Retrieves runtime NAT IP information.
1983
1984 Args:
1985 project: string, Project ID for this request. (required)
1986 region: string, Name of the region for this request. (required)
1987 router: string, Name of the Router resource to query for Nat IP information. The name
1988 should conform to RFC1035. (required)
1989 natName: string, Name of the nat service to filter the NAT IP information.
1990 If it is omitted, all nats for this router will be returned.
1991 Name should conform to RFC1035.
1992 x__xgafv: string, V1 error format.
1993 Allowed values
1994 1 - v1 error format
1995 2 - v2 error format
1996
1997 Returns:
1998 An object of the form:
1999
2000 {
2001 &quot;result&quot;: [ # [Output Only] A list of NAT IP information.
2002 { # Contains NAT IP information of a NAT config (i.e. usage status, mode).
2003 &quot;natIpInfoMappings&quot;: [ # Output only. A list of all NAT IPs assigned to this NAT config.
2004 { # Contains information of a NAT IP.
2005 &quot;mode&quot;: &quot;A String&quot;, # Output only. Specifies whether NAT IP is auto or manual.
2006 &quot;natIp&quot;: &quot;A String&quot;, # Output only. NAT IP address. For example: 203.0.113.11.
2007 &quot;usage&quot;: &quot;A String&quot;, # Output only. Specifies whether NAT IP is currently serving at least one endpoint or
2008 # not.
2009 },
2010 ],
2011 &quot;natName&quot;: &quot;A String&quot;, # Output only. Name of the NAT config which the NAT IP belongs to.
2012 },
2013 ],
2014 }</pre>
2015 </div>
2016
2017 <div class="method">
2018 <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>
2019 <pre>Retrieves runtime Nat mapping information of VM endpoints.
2020
2021 Args:
2022 project: string, Project ID for this request. (required)
2023 region: string, Name of the region for this request. (required)
2024 router: string, Name of the Router resource to query for Nat Mapping information of
2025 VM endpoints. (required)
2026 filter: string, A filter expression that filters resources listed in the response. Most
2027 Compute resources support two types of filter expressions:
2028 expressions that support regular expressions and expressions that follow
2029 API improvement proposal AIP-160.
2030 These two types of filter expressions cannot be mixed in one request.
2031
2032 If you want to use AIP-160, your expression must specify the field name, an
2033 operator, and the value that you want to use for filtering. The value
2034 must be a string, a number, or a boolean. The operator
2035 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2036
2037 For example, if you are filtering Compute Engine instances, you can
2038 exclude instances named `example-instance` by specifying
2039 `name != example-instance`.
2040
2041 The `:*` comparison can be used to test whether a key has been defined.
2042 For example, to find all objects with `owner` label use:
2043 ```
2044 labels.owner:*
2045 ```
2046
2047 You can also filter nested fields. For example, you could specify
2048 `scheduling.automaticRestart = false` to include instances only
2049 if they are not scheduled for automatic restarts. You can use filtering
2050 on nested fields to filter based onresource labels.
2051
2052 To filter on multiple expressions, provide each separate expression within
2053 parentheses. For example:
2054 ```
2055 (scheduling.automaticRestart = true)
2056 (cpuPlatform = &quot;Intel Skylake&quot;)
2057 ```
2058 By default, each expression is an `AND` expression. However, you
2059 can include `AND` and `OR` expressions explicitly.
2060 For example:
2061 ```
2062 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2063 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2064 (scheduling.automaticRestart = true)
2065 ```
2066
2067 If you want to use a regular expression, use the `eq` (equal) or `ne`
2068 (not equal) operator against a single un-parenthesized expression with or
2069 without quotes or against multiple parenthesized expressions. Examples:
2070
2071 `fieldname eq unquoted literal`
2072 `fieldname eq &#x27;single quoted literal&#x27;`
2073 `fieldname eq &quot;double quoted literal&quot;`
2074 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2075
2076 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2077 The literal value must match the entire field.
2078
2079 For example, to filter for instances that do not end with name &quot;instance&quot;,
2080 you would use `name ne .*instance`.
2081
2082 You cannot combine constraints on multiple fields using regular
2083 expressions.
2084 maxResults: integer, The maximum number of results per page that should be returned.
2085 If the number of available results is larger than `maxResults`,
2086 Compute Engine returns a `nextPageToken` that can be used to get
2087 the next page of results in subsequent list requests. Acceptable values are
2088 `0` to `500`, inclusive. (Default: `500`)
2089 natName: string, Name of the nat service to filter the Nat Mapping information.
2090 If it is omitted, all nats for this router will be returned.
2091 Name should conform to RFC1035.
2092 orderBy: string, Sorts list results by a certain order. By default, results
2093 are returned in alphanumerical order based on the resource name.
2094
2095 You can also sort results in descending order based on the creation
2096 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2097 results based on the `creationTimestamp` field in
2098 reverse chronological order (newest result first). Use this to sort
2099 resources like operations so that the newest operation is returned first.
2100
2101 Currently, only sorting by `name` or
2102 `creationTimestamp desc` is supported.
2103 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2104 `nextPageToken` returned by a previous list request to get
2105 the next page of results.
2106 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2107 of failure. The default value is false.
2108
2109 For example, when partial success behavior is enabled, aggregatedList for a
2110 single zone scope either returns all resources in the zone or no resources,
2111 with an error code.
2112 x__xgafv: string, V1 error format.
2113 Allowed values
2114 1 - v1 error format
2115 2 - v2 error format
2116
2117 Returns:
2118 An object of the form:
2119
2120 { # Contains a list of VmEndpointNatMappings.
2121 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2122 # defined by the server.
2123 &quot;kind&quot;: &quot;compute#vmEndpointNatMappingsList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#vmEndpointNatMappingsList for lists of Nat mappings of
2124 # VM endpoints.
2125 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2126 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2127 # the query parameter pageToken in the next list request.
2128 # Subsequent list requests will have their own nextPageToken to
2129 # continue paging through the results.
2130 &quot;result&quot;: [ # [Output Only] A list of Nat mapping information of VM endpoints.
2131 { # Contain information of Nat mapping for a VM endpoint (i.e., NIC).
2132 &quot;instanceName&quot;: &quot;A String&quot;, # Output only. Name of the VM instance which the endpoint belongs to
2133 &quot;interfaceNatMappings&quot;: [
2134 { # Contain information of Nat mapping for an interface of this endpoint.
2135 &quot;drainNatIpPortRanges&quot;: [ # Output only. List of all drain IP:port-range mappings assigned to this interface.
2136 # These ranges are inclusive, that is, both the first and the last
2137 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2138 # &quot;1.1.1.1:2234-2234&quot;].
2139 &quot;A String&quot;,
2140 ],
2141 &quot;natIpPortRanges&quot;: [ # Output only. A list of all IP:port-range mappings assigned to this interface.
2142 # These ranges are inclusive, that is, both the first and the last
2143 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2144 # &quot;1.1.1.1:2234-2234&quot;].
2145 &quot;A String&quot;,
2146 ],
2147 &quot;numTotalDrainNatPorts&quot;: 42, # Output only. Total number of drain ports across all NAT IPs allocated to this
2148 # interface. It equals to the aggregated port number in the field
2149 # drain_nat_ip_port_ranges.
2150 &quot;numTotalNatPorts&quot;: 42, # Output only. Total number of ports across all NAT IPs allocated to this interface.
2151 # It equals to the aggregated port number in the field nat_ip_port_ranges.
2152 &quot;ruleMappings&quot;: [ # Output only. Information about mappings provided by rules in this NAT.
2153 { # Contains information of NAT Mappings provided by a NAT Rule.
2154 &quot;drainNatIpPortRanges&quot;: [ # Output only. List of all drain IP:port-range mappings assigned to this interface
2155 # by this rule.
2156 # These ranges are inclusive, that is, both the first and the last
2157 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2158 # &quot;1.1.1.1:2234-2234&quot;].
2159 &quot;A String&quot;,
2160 ],
2161 &quot;natIpPortRanges&quot;: [ # Output only. A list of all IP:port-range mappings assigned to this interface by this
2162 # rule.
2163 # These ranges are inclusive, that is, both the first and the last
2164 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2165 # &quot;1.1.1.1:2234-2234&quot;].
2166 &quot;A String&quot;,
2167 ],
2168 &quot;numTotalDrainNatPorts&quot;: 42, # Output only. Total number of drain ports across all NAT IPs allocated to this
2169 # interface by this rule.
2170 # It equals the aggregated port number in the field
2171 # drain_nat_ip_port_ranges.
2172 &quot;numTotalNatPorts&quot;: 42, # Output only. Total number of ports across all NAT IPs allocated to this interface
2173 # by this rule.
2174 # It equals the aggregated port number in the field nat_ip_port_ranges.
2175 &quot;ruleNumber&quot;: 42, # Output only. Rule number of the NAT Rule.
2176 },
2177 ],
2178 &quot;sourceAliasIpRange&quot;: &quot;A String&quot;, # Output only. Alias IP range for this interface endpoint.
2179 # It will be a private (RFC 1918) IP range.
2180 # Examples: &quot;10.33.4.55/32&quot;, or &quot;192.168.5.0/24&quot;.
2181 &quot;sourceVirtualIp&quot;: &quot;A String&quot;, # Output only. Primary IP of the VM for this NIC.
2182 },
2183 ],
2184 },
2185 ],
2186 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2187 &quot;warning&quot;: { # [Output Only] Informational warning message.
2188 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2189 # Engine returns NO_RESULTS_ON_PAGE if there
2190 # are no results in the response.
2191 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2192 # value format. For example:
2193 #
2194 # &quot;data&quot;: [
2195 # {
2196 # &quot;key&quot;: &quot;scope&quot;,
2197 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2198 # }
2199 {
2200 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2201 # returned. For example, for warnings where there are no results in a list
2202 # request for a particular zone, this key might be scope and
2203 # the key value might be the zone name. Other examples might be a key
2204 # indicating a deprecated resource and a suggested replacement, or a
2205 # warning about invalid network settings (for example, if an instance
2206 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2207 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2208 },
2209 ],
2210 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2211 },
2212 }</pre>
2213 </div>
2214
2215 <div class="method">
2216 <code class="details" id="getNatMappingInfo_next">getNatMappingInfo_next()</code>
2217 <pre>Retrieves the next page of results.
2218
2219 Args:
2220 previous_request: The request for the previous page. (required)
2221 previous_response: The response from the request for the previous page. (required)
2222
2223 Returns:
2224 A request object that you can call &#x27;execute()&#x27; on to request the next
2225 page. Returns None if there are no more items in the collection.
2226 </pre>
2227 </div>
2228
2229 <div class="method">
2230 <code class="details" id="getRoutePolicy">getRoutePolicy(project, region, router, policy=None, x__xgafv=None)</code>
2231 <pre>Returns specified Route Policy
2232
2233 Args:
2234 project: string, Project ID for this request. (required)
2235 region: string, Name of the region for this request. (required)
2236 router: string, Name of the Router resource to query for the route policy. The name should
2237 conform to RFC1035. (required)
2238 policy: string, The Policy name for this request. Name must conform to RFC1035
2239 x__xgafv: string, V1 error format.
2240 Allowed values
2241 1 - v1 error format
2242 2 - v2 error format
2243
2244 Returns:
2245 An object of the form:
2246
2247 {
2248 &quot;resource&quot;: {
2249 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
2250 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
2251 # essentially a hash of the Route Policy used for optimistic locking.
2252 # The fingerprint is initially generated by Compute Engine and changes
2253 # after every request to modify or update Route Policy. You must always
2254 # provide an up-to-date fingerprint hash in order to update or change
2255 # labels.
2256 #
2257 # To see the latest fingerprint, make a getRoutePolicy() request
2258 # to retrieve a Route Policy.
2259 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
2260 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
2261 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
2262 # in order of priority). Order of policies is not retained and might change
2263 # when getting policy later.
2264 {
2265 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
2266 { # Represents a textual expression in the Common Expression Language (CEL)
2267 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2268 # are documented at https://github.com/google/cel-spec.
2269 #
2270 # Example (Comparison):
2271 #
2272 # title: &quot;Summary size limit&quot;
2273 # description: &quot;Determines if a summary is less than 100 chars&quot;
2274 # expression: &quot;document.summary.size() &lt; 100&quot;
2275 #
2276 # Example (Equality):
2277 #
2278 # title: &quot;Requestor is owner&quot;
2279 # description: &quot;Determines if requestor is the document owner&quot;
2280 # expression: &quot;document.owner == request.auth.claims.email&quot;
2281 #
2282 # Example (Logic):
2283 #
2284 # title: &quot;Public documents&quot;
2285 # description: &quot;Determine whether the document should be publicly visible&quot;
2286 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2287 #
2288 # Example (Data Manipulation):
2289 #
2290 # title: &quot;Notification string&quot;
2291 # description: &quot;Create a notification string with a timestamp.&quot;
2292 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2293 #
2294 # The exact variables and functions that may be referenced within an expression
2295 # are determined by the service that evaluates it. See the service
2296 # documentation for additional information.
2297 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2298 # describes the expression, e.g. when hovered over it in a UI.
2299 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2300 # syntax.
2301 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2302 # reporting, e.g. a file name and a position in the file.
2303 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2304 # its purpose. This can be used e.g. in UIs which allow to enter the
2305 # expression.
2306 },
2307 ],
2308 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
2309 # applies. When not set, the term applies to all
2310 # routes.
2311 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2312 # are documented at https://github.com/google/cel-spec.
2313 #
2314 # Example (Comparison):
2315 #
2316 # title: &quot;Summary size limit&quot;
2317 # description: &quot;Determines if a summary is less than 100 chars&quot;
2318 # expression: &quot;document.summary.size() &lt; 100&quot;
2319 #
2320 # Example (Equality):
2321 #
2322 # title: &quot;Requestor is owner&quot;
2323 # description: &quot;Determines if requestor is the document owner&quot;
2324 # expression: &quot;document.owner == request.auth.claims.email&quot;
2325 #
2326 # Example (Logic):
2327 #
2328 # title: &quot;Public documents&quot;
2329 # description: &quot;Determine whether the document should be publicly visible&quot;
2330 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2331 #
2332 # Example (Data Manipulation):
2333 #
2334 # title: &quot;Notification string&quot;
2335 # description: &quot;Create a notification string with a timestamp.&quot;
2336 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2337 #
2338 # The exact variables and functions that may be referenced within an expression
2339 # are determined by the service that evaluates it. See the service
2340 # documentation for additional information.
2341 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2342 # describes the expression, e.g. when hovered over it in a UI.
2343 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2344 # syntax.
2345 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2346 # reporting, e.g. a file name and a position in the file.
2347 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2348 # its purpose. This can be used e.g. in UIs which allow to enter the
2349 # expression.
2350 },
2351 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
2352 # (inclusive) and 2^31 (exclusive), and unique within the list.
2353 },
2354 ],
2355 &quot;type&quot;: &quot;A String&quot;,
2356 },
2357 }</pre>
2358 </div>
2359
2360 <div class="method">
2361 <code class="details" id="getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</code>
2362 <pre>Retrieves runtime information of the specified router.
2363
2364 Args:
2365 project: string, Project ID for this request. (required)
2366 region: string, Name of the region for this request. (required)
2367 router: string, Name of the Router resource to query. (required)
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;kind&quot;: &quot;compute#routerStatusResponse&quot;, # Output only. Type of resource.
2378 &quot;result&quot;: {
2379 &quot;bestRoutes&quot;: [ # A list of the best dynamic routes for this Cloud Router&#x27;s Virtual Private
2380 # Cloud (VPC) network in the same region as this Cloud Router.
2381 #
2382 # Lists all of the best routes per prefix that are programmed into this
2383 # region&#x27;s VPC data plane.
2384 #
2385 # When global dynamic routing mode is turned on in the VPC network, this list
2386 # can include cross-region dynamic routes from Cloud Routers in other
2387 # regions.
2388 { # Represents a Route resource.
2389 #
2390 # A route defines a path from VM instances in the VPC network to a specific
2391 # destination. This destination can be inside or outside the VPC network.
2392 # For more information, read theRoutes overview.
2393 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
2394 {
2395 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
2396 42,
2397 ],
2398 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
2399 # values:
2400 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
2401 # in has traversed
2402 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
2403 # systems that the route has traversed
2404 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
2405 # ordered set of Member Autonomous Systems in the local confederation that
2406 # the route has traversed
2407 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
2408 # Member Autonomous Systems in the local confederation that the route has
2409 # traversed
2410 },
2411 ],
2412 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2413 # text format.
2414 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
2415 # create the resource.
2416 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
2417 # IPv4 and IPv6 are supported.
2418 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
2419 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
2420 # compressed format.
2421 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2422 # defined by the server.
2423 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
2424 # Route resources.
2425 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2426 # The name must be 1-63 characters long, and comply withRFC1035.
2427 # Specifically, the name must be 1-63 characters long and match the regular
2428 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
2429 # lowercase letter, and all following characters (except for the last
2430 # character) must be a dash, lowercase letter, or digit. The last character
2431 # must be a lowercase letter or digit.
2432 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
2433 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
2434 # You can only specify the internet gateway using a full or
2435 # partial valid URL: projects/project/global/gateways/default-internet-gateway
2436 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
2437 # that will handle matching packets.
2438 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
2439 # packets or the IP address of the forwarding Rule.
2440 # For example, the following are all valid URLs:
2441 #
2442 #
2443 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2444 # - regions/region/forwardingRules/forwardingRule
2445 #
2446 #
2447 # If an IP address is provided, must specify an IPv4 address in dot-decimal
2448 # notation or an IPv6 address in RFC 4291 format. For example, the following
2449 # are all valid IP addresses:
2450 #
2451 #
2452 # - 10.128.0.56
2453 # - 2001:db8::2d9:51:0:0
2454 # - 2001:db8:0:0:2d9:51:0:0
2455 #
2456 #
2457 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
2458 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
2459 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
2460 # this as a full or partial URL.
2461 # For example:
2462 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
2463 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
2464 # calculates based on factors such as network performance, distance, and
2465 # available bandwidth between regions.
2466 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
2467 # for the route.
2468 # This field will only be populated for dynamic routes generated by
2469 # Cloud Router with a linked interconnectAttachment or the static route
2470 # generated by each L2 Interconnect Attachment.
2471 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
2472 # Both IPv6 address and IPv4 addresses are supported.
2473 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
2474 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
2475 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
2476 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
2477 # IPv4-mapped IPv6 address.
2478 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
2479 # the desirability of a particular route in a network.
2480 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
2481 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
2482 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
2483 # or INCOMPLETE.
2484 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
2485 # which should conform to RFC1035.
2486 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
2487 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2488 # as part of resource payload.
2489 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2490 # Tag keys and values have the same definition as resource
2491 # manager tags. The field is allowed for INSERT
2492 # only. The keys/values to set on the resource should be specified in
2493 # either ID { : } or Namespaced format
2494 # { : }.
2495 # For example the following are valid inputs:
2496 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2497 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2498 # Note:
2499 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2500 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2501 &quot;a_key&quot;: &quot;A String&quot;,
2502 },
2503 },
2504 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
2505 # where there is more than one matching route of equal prefix length. In
2506 # cases where multiple routes have equal prefix length, the one with the
2507 # lowest-numbered priority value wins. The default value is `1000`. The
2508 # priority value must be from `0` to `65535`, inclusive.
2509 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
2510 # dynamic routes learned by Cloud Routers. It is also applicable to routes
2511 # undergoing migration.
2512 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
2513 # values:
2514 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
2515 # another Cloud Router and will readvertise to one of its BGP peers
2516 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
2517 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
2518 # - &#x27;STATIC&#x27; for a static route
2519 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
2520 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
2521 &quot;A String&quot;,
2522 ],
2523 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
2524 # route, this field will be populated with warning messages.
2525 {
2526 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2527 # Engine returns NO_RESULTS_ON_PAGE if there
2528 # are no results in the response.
2529 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2530 # value format. For example:
2531 #
2532 # &quot;data&quot;: [
2533 # {
2534 # &quot;key&quot;: &quot;scope&quot;,
2535 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2536 # }
2537 {
2538 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2539 # returned. For example, for warnings where there are no results in a list
2540 # request for a particular zone, this key might be scope and
2541 # the key value might be the zone name. Other examples might be a key
2542 # indicating a deprecated resource and a suggested replacement, or a
2543 # warning about invalid network settings (for example, if an instance
2544 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2545 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2546 },
2547 ],
2548 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2549 },
2550 ],
2551 },
2552 ],
2553 &quot;bestRoutesForRouter&quot;: [ # A list of the best BGP routes learned by this Cloud Router.
2554 #
2555 # It is possible that routes listed might not be programmed into the data
2556 # plane, if the Google Cloud control plane finds a more optimal route for a
2557 # prefix than a route learned by this Cloud Router.
2558 { # Represents a Route resource.
2559 #
2560 # A route defines a path from VM instances in the VPC network to a specific
2561 # destination. This destination can be inside or outside the VPC network.
2562 # For more information, read theRoutes overview.
2563 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
2564 {
2565 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
2566 42,
2567 ],
2568 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
2569 # values:
2570 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
2571 # in has traversed
2572 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
2573 # systems that the route has traversed
2574 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
2575 # ordered set of Member Autonomous Systems in the local confederation that
2576 # the route has traversed
2577 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
2578 # Member Autonomous Systems in the local confederation that the route has
2579 # traversed
2580 },
2581 ],
2582 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2583 # text format.
2584 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
2585 # create the resource.
2586 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
2587 # IPv4 and IPv6 are supported.
2588 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
2589 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
2590 # compressed format.
2591 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2592 # defined by the server.
2593 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
2594 # Route resources.
2595 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2596 # The name must be 1-63 characters long, and comply withRFC1035.
2597 # Specifically, the name must be 1-63 characters long and match the regular
2598 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
2599 # lowercase letter, and all following characters (except for the last
2600 # character) must be a dash, lowercase letter, or digit. The last character
2601 # must be a lowercase letter or digit.
2602 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
2603 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
2604 # You can only specify the internet gateway using a full or
2605 # partial valid URL: projects/project/global/gateways/default-internet-gateway
2606 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
2607 # that will handle matching packets.
2608 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
2609 # packets or the IP address of the forwarding Rule.
2610 # For example, the following are all valid URLs:
2611 #
2612 #
2613 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2614 # - regions/region/forwardingRules/forwardingRule
2615 #
2616 #
2617 # If an IP address is provided, must specify an IPv4 address in dot-decimal
2618 # notation or an IPv6 address in RFC 4291 format. For example, the following
2619 # are all valid IP addresses:
2620 #
2621 #
2622 # - 10.128.0.56
2623 # - 2001:db8::2d9:51:0:0
2624 # - 2001:db8:0:0:2d9:51:0:0
2625 #
2626 #
2627 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
2628 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
2629 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
2630 # this as a full or partial URL.
2631 # For example:
2632 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
2633 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
2634 # calculates based on factors such as network performance, distance, and
2635 # available bandwidth between regions.
2636 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
2637 # for the route.
2638 # This field will only be populated for dynamic routes generated by
2639 # Cloud Router with a linked interconnectAttachment or the static route
2640 # generated by each L2 Interconnect Attachment.
2641 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
2642 # Both IPv6 address and IPv4 addresses are supported.
2643 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
2644 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
2645 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
2646 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
2647 # IPv4-mapped IPv6 address.
2648 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
2649 # the desirability of a particular route in a network.
2650 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
2651 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
2652 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
2653 # or INCOMPLETE.
2654 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
2655 # which should conform to RFC1035.
2656 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
2657 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2658 # as part of resource payload.
2659 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2660 # Tag keys and values have the same definition as resource
2661 # manager tags. The field is allowed for INSERT
2662 # only. The keys/values to set on the resource should be specified in
2663 # either ID { : } or Namespaced format
2664 # { : }.
2665 # For example the following are valid inputs:
2666 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2667 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2668 # Note:
2669 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2670 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2671 &quot;a_key&quot;: &quot;A String&quot;,
2672 },
2673 },
2674 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
2675 # where there is more than one matching route of equal prefix length. In
2676 # cases where multiple routes have equal prefix length, the one with the
2677 # lowest-numbered priority value wins. The default value is `1000`. The
2678 # priority value must be from `0` to `65535`, inclusive.
2679 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
2680 # dynamic routes learned by Cloud Routers. It is also applicable to routes
2681 # undergoing migration.
2682 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
2683 # values:
2684 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
2685 # another Cloud Router and will readvertise to one of its BGP peers
2686 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
2687 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
2688 # - &#x27;STATIC&#x27; for a static route
2689 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
2690 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
2691 &quot;A String&quot;,
2692 ],
2693 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
2694 # route, this field will be populated with warning messages.
2695 {
2696 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2697 # Engine returns NO_RESULTS_ON_PAGE if there
2698 # are no results in the response.
2699 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2700 # value format. For example:
2701 #
2702 # &quot;data&quot;: [
2703 # {
2704 # &quot;key&quot;: &quot;scope&quot;,
2705 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2706 # }
2707 {
2708 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2709 # returned. For example, for warnings where there are no results in a list
2710 # request for a particular zone, this key might be scope and
2711 # the key value might be the zone name. Other examples might be a key
2712 # indicating a deprecated resource and a suggested replacement, or a
2713 # warning about invalid network settings (for example, if an instance
2714 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2715 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2716 },
2717 ],
2718 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2719 },
2720 ],
2721 },
2722 ],
2723 &quot;bgpPeerStatus&quot;: [
2724 {
2725 &quot;advertisedRoutes&quot;: [ # Routes that were advertised to the remote BGP peer
2726 { # Represents a Route resource.
2727 #
2728 # A route defines a path from VM instances in the VPC network to a specific
2729 # destination. This destination can be inside or outside the VPC network.
2730 # For more information, read theRoutes overview.
2731 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
2732 {
2733 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
2734 42,
2735 ],
2736 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
2737 # values:
2738 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
2739 # in has traversed
2740 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
2741 # systems that the route has traversed
2742 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
2743 # ordered set of Member Autonomous Systems in the local confederation that
2744 # the route has traversed
2745 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
2746 # Member Autonomous Systems in the local confederation that the route has
2747 # traversed
2748 },
2749 ],
2750 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2751 # text format.
2752 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
2753 # create the resource.
2754 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
2755 # IPv4 and IPv6 are supported.
2756 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
2757 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
2758 # compressed format.
2759 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2760 # defined by the server.
2761 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
2762 # Route resources.
2763 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2764 # The name must be 1-63 characters long, and comply withRFC1035.
2765 # Specifically, the name must be 1-63 characters long and match the regular
2766 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
2767 # lowercase letter, and all following characters (except for the last
2768 # character) must be a dash, lowercase letter, or digit. The last character
2769 # must be a lowercase letter or digit.
2770 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
2771 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
2772 # You can only specify the internet gateway using a full or
2773 # partial valid URL: projects/project/global/gateways/default-internet-gateway
2774 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
2775 # that will handle matching packets.
2776 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
2777 # packets or the IP address of the forwarding Rule.
2778 # For example, the following are all valid URLs:
2779 #
2780 #
2781 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2782 # - regions/region/forwardingRules/forwardingRule
2783 #
2784 #
2785 # If an IP address is provided, must specify an IPv4 address in dot-decimal
2786 # notation or an IPv6 address in RFC 4291 format. For example, the following
2787 # are all valid IP addresses:
2788 #
2789 #
2790 # - 10.128.0.56
2791 # - 2001:db8::2d9:51:0:0
2792 # - 2001:db8:0:0:2d9:51:0:0
2793 #
2794 #
2795 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
2796 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
2797 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
2798 # this as a full or partial URL.
2799 # For example:
2800 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
2801 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
2802 # calculates based on factors such as network performance, distance, and
2803 # available bandwidth between regions.
2804 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
2805 # for the route.
2806 # This field will only be populated for dynamic routes generated by
2807 # Cloud Router with a linked interconnectAttachment or the static route
2808 # generated by each L2 Interconnect Attachment.
2809 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
2810 # Both IPv6 address and IPv4 addresses are supported.
2811 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
2812 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
2813 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
2814 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
2815 # IPv4-mapped IPv6 address.
2816 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
2817 # the desirability of a particular route in a network.
2818 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
2819 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
2820 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
2821 # or INCOMPLETE.
2822 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
2823 # which should conform to RFC1035.
2824 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
2825 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2826 # as part of resource payload.
2827 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2828 # Tag keys and values have the same definition as resource
2829 # manager tags. The field is allowed for INSERT
2830 # only. The keys/values to set on the resource should be specified in
2831 # either ID { : } or Namespaced format
2832 # { : }.
2833 # For example the following are valid inputs:
2834 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2835 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2836 # Note:
2837 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2838 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2839 &quot;a_key&quot;: &quot;A String&quot;,
2840 },
2841 },
2842 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
2843 # where there is more than one matching route of equal prefix length. In
2844 # cases where multiple routes have equal prefix length, the one with the
2845 # lowest-numbered priority value wins. The default value is `1000`. The
2846 # priority value must be from `0` to `65535`, inclusive.
2847 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
2848 # dynamic routes learned by Cloud Routers. It is also applicable to routes
2849 # undergoing migration.
2850 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
2851 # values:
2852 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
2853 # another Cloud Router and will readvertise to one of its BGP peers
2854 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
2855 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
2856 # - &#x27;STATIC&#x27; for a static route
2857 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
2858 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
2859 &quot;A String&quot;,
2860 ],
2861 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
2862 # route, this field will be populated with warning messages.
2863 {
2864 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2865 # Engine returns NO_RESULTS_ON_PAGE if there
2866 # are no results in the response.
2867 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2868 # value format. For example:
2869 #
2870 # &quot;data&quot;: [
2871 # {
2872 # &quot;key&quot;: &quot;scope&quot;,
2873 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2874 # }
2875 {
2876 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2877 # returned. For example, for warnings where there are no results in a list
2878 # request for a particular zone, this key might be scope and
2879 # the key value might be the zone name. Other examples might be a key
2880 # indicating a deprecated resource and a suggested replacement, or a
2881 # warning about invalid network settings (for example, if an instance
2882 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2883 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2884 },
2885 ],
2886 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2887 },
2888 ],
2889 },
2890 ],
2891 &quot;bfdStatus&quot;: { # Next free: 15
2892 &quot;bfdSessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
2893 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
2894 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
2895 # peer router to initiate the BFD session for this BGP peer. If set to
2896 # DISABLED, BFD is disabled for this BGP peer.
2897 &quot;configUpdateTimestampMicros&quot;: &quot;A String&quot;, # Unix timestamp of the most recent config update.
2898 &quot;controlPacketCounts&quot;: { # Control packet counts for the current BFD session.
2899 &quot;numRx&quot;: 42, # Number of packets received since the beginning of the current BFD
2900 # session.
2901 &quot;numRxRejected&quot;: 42, # Number of packets received that were rejected because of errors since the
2902 # beginning of the current BFD session.
2903 &quot;numRxSuccessful&quot;: 42, # Number of packets received that were successfully processed since the
2904 # beginning of the current BFD session.
2905 &quot;numTx&quot;: 42, # Number of packets transmitted since the beginning of the current BFD
2906 # session.
2907 },
2908 &quot;controlPacketIntervals&quot;: [ # Inter-packet time interval statistics for control packets.
2909 { # Next free: 7
2910 &quot;avgMs&quot;: &quot;A String&quot;, # Average observed inter-packet interval in milliseconds.
2911 &quot;duration&quot;: &quot;A String&quot;, # From how long ago in the past these intervals were observed.
2912 &quot;maxMs&quot;: &quot;A String&quot;, # Maximum observed inter-packet interval in milliseconds.
2913 &quot;minMs&quot;: &quot;A String&quot;, # Minimum observed inter-packet interval in milliseconds.
2914 &quot;numIntervals&quot;: &quot;A String&quot;, # Number of inter-packet intervals from which these statistics were derived.
2915 &quot;type&quot;: &quot;A String&quot;, # The type of packets for which inter-packet intervals were computed.
2916 },
2917 ],
2918 &quot;localDiagnostic&quot;: &quot;A String&quot;, # The diagnostic code specifies the local system&#x27;s reason for the last change
2919 # in session state. This allows remote systems to determine the reason that
2920 # the previous session failed, for example. These diagnostic codes are
2921 # specified in section 4.1 ofRFC5880
2922 &quot;localState&quot;: &quot;A String&quot;, # The current BFD session state as seen by the transmitting system. These
2923 # states are specified in section 4.1 ofRFC5880
2924 &quot;negotiatedLocalControlTxIntervalMs&quot;: 42, # Negotiated transmit interval for control packets.
2925 &quot;rxPacket&quot;: { # The most recent Rx control packet for this BFD session.
2926 &quot;authenticationPresent&quot;: True or False, # The Authentication Present bit of the BFD packet. This is specified in
2927 # section 4.1 ofRFC5880
2928 &quot;controlPlaneIndependent&quot;: True or False, # The Control Plane Independent bit of the BFD packet. This is specified in
2929 # section 4.1 ofRFC5880
2930 &quot;demand&quot;: True or False, # The demand bit of the BFD packet. This is specified in section 4.1 ofRFC5880
2931 &quot;diagnostic&quot;: &quot;A String&quot;, # The diagnostic code specifies the local system&#x27;s reason for the last change
2932 # in session state. This allows remote systems to determine the reason that
2933 # the previous session failed, for example. These diagnostic codes are
2934 # specified in section 4.1 ofRFC5880
2935 &quot;final&quot;: True or False, # The Final bit of the BFD packet. This is specified in section 4.1 ofRFC5880
2936 &quot;length&quot;: 42, # The length of the BFD Control packet in bytes. This is specified in section
2937 # 4.1 ofRFC5880
2938 &quot;minEchoRxIntervalMs&quot;: 42, # The Required Min Echo RX Interval value in the BFD packet. This is
2939 # specified in section 4.1 ofRFC5880
2940 &quot;minRxIntervalMs&quot;: 42, # The Required Min RX Interval value in the BFD packet. This is specified in
2941 # section 4.1 ofRFC5880
2942 &quot;minTxIntervalMs&quot;: 42, # The Desired Min TX Interval value in the BFD packet. This is specified in
2943 # section 4.1 ofRFC5880
2944 &quot;multiplier&quot;: 42, # The detection time multiplier of the BFD packet. This is specified in
2945 # section 4.1 ofRFC5880
2946 &quot;multipoint&quot;: True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 ofRFC5880
2947 &quot;myDiscriminator&quot;: 42, # The My Discriminator value in the BFD packet. This is specified in section
2948 # 4.1 ofRFC5880
2949 &quot;poll&quot;: True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 ofRFC5880
2950 &quot;state&quot;: &quot;A String&quot;, # The current BFD session state as seen by the transmitting system. These
2951 # states are specified in section 4.1 ofRFC5880
2952 &quot;version&quot;: 42, # The version number of the BFD protocol, as specified in section 4.1 ofRFC5880.
2953 &quot;yourDiscriminator&quot;: 42, # The Your Discriminator value in the BFD packet. This is specified in
2954 # section 4.1 ofRFC5880
2955 },
2956 &quot;txPacket&quot;: { # The most recent Tx control packet for this BFD session.
2957 &quot;authenticationPresent&quot;: True or False, # The Authentication Present bit of the BFD packet. This is specified in
2958 # section 4.1 ofRFC5880
2959 &quot;controlPlaneIndependent&quot;: True or False, # The Control Plane Independent bit of the BFD packet. This is specified in
2960 # section 4.1 ofRFC5880
2961 &quot;demand&quot;: True or False, # The demand bit of the BFD packet. This is specified in section 4.1 ofRFC5880
2962 &quot;diagnostic&quot;: &quot;A String&quot;, # The diagnostic code specifies the local system&#x27;s reason for the last change
2963 # in session state. This allows remote systems to determine the reason that
2964 # the previous session failed, for example. These diagnostic codes are
2965 # specified in section 4.1 ofRFC5880
2966 &quot;final&quot;: True or False, # The Final bit of the BFD packet. This is specified in section 4.1 ofRFC5880
2967 &quot;length&quot;: 42, # The length of the BFD Control packet in bytes. This is specified in section
2968 # 4.1 ofRFC5880
2969 &quot;minEchoRxIntervalMs&quot;: 42, # The Required Min Echo RX Interval value in the BFD packet. This is
2970 # specified in section 4.1 ofRFC5880
2971 &quot;minRxIntervalMs&quot;: 42, # The Required Min RX Interval value in the BFD packet. This is specified in
2972 # section 4.1 ofRFC5880
2973 &quot;minTxIntervalMs&quot;: 42, # The Desired Min TX Interval value in the BFD packet. This is specified in
2974 # section 4.1 ofRFC5880
2975 &quot;multiplier&quot;: 42, # The detection time multiplier of the BFD packet. This is specified in
2976 # section 4.1 ofRFC5880
2977 &quot;multipoint&quot;: True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 ofRFC5880
2978 &quot;myDiscriminator&quot;: 42, # The My Discriminator value in the BFD packet. This is specified in section
2979 # 4.1 ofRFC5880
2980 &quot;poll&quot;: True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 ofRFC5880
2981 &quot;state&quot;: &quot;A String&quot;, # The current BFD session state as seen by the transmitting system. These
2982 # states are specified in section 4.1 ofRFC5880
2983 &quot;version&quot;: 42, # The version number of the BFD protocol, as specified in section 4.1 ofRFC5880.
2984 &quot;yourDiscriminator&quot;: 42, # The Your Discriminator value in the BFD packet. This is specified in
2985 # section 4.1 ofRFC5880
2986 },
2987 &quot;uptimeMs&quot;: &quot;A String&quot;, # Session uptime in milliseconds. Value will be 0 if session is not up.
2988 },
2989 &quot;enableIpv4&quot;: True or False, # Output only. Enable IPv4 traffic over BGP Peer.
2990 # It is enabled by default if the peerIpAddress is version 4.
2991 &quot;enableIpv6&quot;: True or False, # Output only. Enable IPv6 traffic over BGP Peer.
2992 # It is enabled by default if the peerIpAddress is version 6.
2993 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. IP address of the local BGP interface.
2994 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv4 address of the local BGP interface.
2995 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv6 address of the local BGP interface.
2996 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # Output only. URL of the VPN tunnel that this BGP peer controls.
2997 &quot;md5AuthEnabled&quot;: True or False, # Informs whether MD5 authentication is enabled on this BGP peer.
2998 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of this BGP peer. Unique within the Routers resource.
2999 &quot;numLearnedRoutes&quot;: 42, # Output only. Number of routes learned from the remote BGP Peer.
3000 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. IP address of the remote BGP interface.
3001 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv4 address of the remote BGP interface.
3002 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv6 address of the remote BGP interface.
3003 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # Output only. [Output only] URI of the VM instance that is used as third-party router
3004 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
3005 # Appliances.
3006 # The VM instance is the peer side of the BGP session.
3007 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the BGP session. For a list of possible values for this
3008 # field, seeBGP session states.
3009 &quot;status&quot;: &quot;A String&quot;, # Output only. Status of the BGP peer: {UP, DOWN}
3010 &quot;statusReason&quot;: &quot;A String&quot;, # Indicates why particular status was returned.
3011 &quot;uptime&quot;: &quot;A String&quot;, # Output only. Time this session has been up.
3012 # Format:
3013 # 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
3014 &quot;uptimeSeconds&quot;: &quot;A String&quot;, # Output only. Time this session has been up, in seconds.
3015 # Format:
3016 # 145
3017 },
3018 ],
3019 &quot;natStatus&quot;: [
3020 { # Status of a NAT contained in this router.
3021 &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;]
3022 &quot;A String&quot;,
3023 ],
3024 &quot;drainAutoAllocatedNatIps&quot;: [ # Output only. A list of IPs auto-allocated for NAT that are in drain mode.
3025 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3026 &quot;A String&quot;,
3027 ],
3028 &quot;drainUserAllocatedNatIps&quot;: [ # Output only. A list of IPs user-allocated for NAT that are in drain mode.
3029 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3030 &quot;A String&quot;,
3031 ],
3032 &quot;minExtraNatIpsNeeded&quot;: 42, # Output only. The number of extra IPs to allocate. This will be greater than 0 only if
3033 # user-specified IPs are NOT enough to allow all configured VMs to use NAT.
3034 # This value is meaningful only when auto-allocation of NAT IPs is *not*
3035 # used.
3036 &quot;name&quot;: &quot;A String&quot;, # Output only. Unique name of this NAT.
3037 &quot;numVmEndpointsWithNatMappings&quot;: 42, # Output only. Number of VM endpoints (i.e., Nics) that can use NAT.
3038 &quot;ruleStatus&quot;: [ # Status of rules in this NAT.
3039 { # Status of a NAT Rule contained in this NAT.
3040 &quot;activeNatIps&quot;: [ # Output only. A list of active IPs for NAT.
3041 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3042 &quot;A String&quot;,
3043 ],
3044 &quot;drainNatIps&quot;: [ # Output only. A list of IPs for NAT that are in drain mode.
3045 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3046 &quot;A String&quot;,
3047 ],
3048 &quot;minExtraIpsNeeded&quot;: 42, # Output only. The number of extra IPs to allocate. This will be greater than 0 only
3049 # if the existing IPs in this NAT Rule are NOT enough to allow all
3050 # configured VMs to use NAT.
3051 &quot;numVmEndpointsWithNatMappings&quot;: 42, # Output only. Number of VM endpoints (i.e., NICs) that have NAT Mappings from this
3052 # NAT Rule.
3053 &quot;ruleNumber&quot;: 42, # Output only. Rule number of the rule.
3054 },
3055 ],
3056 &quot;userAllocatedNatIpResources&quot;: [ # Output only. A list of fully qualified URLs of reserved IP address resources.
3057 &quot;A String&quot;,
3058 ],
3059 &quot;userAllocatedNatIps&quot;: [ # Output only. A list of IPs user-allocated for NAT.
3060 # They will be raw IP strings like &quot;179.12.26.133&quot;.
3061 &quot;A String&quot;,
3062 ],
3063 },
3064 ],
3065 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
3066 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
3067 },
3068 }</pre>
3069 </div>
3070
3071 <div class="method">
3072 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
3073 <pre>Creates a Router resource in the specified project and region using
3074 the data included in the request.
3075
3076 Args:
3077 project: string, Project ID for this request. (required)
3078 region: string, Name of the region for this request. (required)
3079 body: object, The request body.
3080 The object takes the form of:
3081
3082 { # Represents a Cloud Router resource.
3083 #
3084 # For more information about Cloud Router, read theCloud
3085 # Router overview.
3086 &quot;bgp&quot;: { # BGP information specific to this router.
3087 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
3088 # The options are DEFAULT or CUSTOM.
3089 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
3090 # This field can only be populated if advertise_mode is CUSTOM and
3091 # is advertised to all peers of the router.
3092 # These groups will be advertised in addition to any specified prefixes.
3093 # Leave this field blank to advertise no custom groups.
3094 &quot;A String&quot;,
3095 ],
3096 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
3097 # This field can only be populated if advertise_mode is CUSTOM and
3098 # is advertised to all peers of the router.
3099 # These IP ranges will be advertised in addition to any specified groups.
3100 # Leave this field blank to advertise no custom IP ranges.
3101 { # Description-tagged IP ranges for the router to advertise.
3102 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
3103 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
3104 },
3105 ],
3106 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
3107 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
3108 # value will be fixed for this router resource. All VPN tunnels that link
3109 # to this router will have the same local ASN.
3110 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
3111 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
3112 # least /30, even if the BGP sessions are over IPv6. It must not overlap
3113 # with any IPv4 BGP session ranges.
3114 #
3115 #
3116 # Other vendors commonly call this &quot;router ID&quot;.
3117 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
3118 # sent to the peer.
3119 #
3120 #
3121 # Hold time is three times the interval at which keepalive messages are
3122 # sent, and the hold time is the maximum number of seconds allowed to
3123 # elapse between successive keepalive messages that BGP receives from a
3124 # peer.
3125 #
3126 #
3127 # BGP will use the smaller of either the local hold time value or the
3128 # peer&#x27;s hold time value as the hold time for the BGP connection between
3129 # the two peers.
3130 #
3131 #
3132 # If set, this value must be between 20 and 60. The default is 20.
3133 },
3134 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
3135 # establish BGP peering. This information must specify the peer ASN and
3136 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
3137 {
3138 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
3139 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
3140 # which currently supports the following option:
3141 #
3142 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
3143 # excludes any routes learned for subnets that use
3144 # VPC Network Peering.
3145 #
3146 #
3147 # Note that this field can only be populated if advertise_mode is CUSTOM
3148 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
3149 # These groups are advertised in addition to any specified prefixes.
3150 # Leave this field blank to advertise no custom groups.
3151 &quot;A String&quot;,
3152 ],
3153 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
3154 # This field can only be populated if advertise_mode is CUSTOM and
3155 # overrides the list defined for the router (in the &quot;bgp&quot; message).
3156 # These IP ranges are advertised in addition to any specified groups.
3157 # Leave this field blank to advertise no custom IP ranges.
3158 { # Description-tagged IP ranges for the router to advertise.
3159 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
3160 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
3161 },
3162 ],
3163 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
3164 # than one matching route of maximum length, the routes with the lowest
3165 # priority value win.
3166 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
3167 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
3168 # received from the peer router. The actual value is negotiated between
3169 # the two routers and is equal to the greater of this value and the
3170 # transmit interval of the other router.
3171 #
3172 #
3173 # If set, this value must be between 1000 and 30000.
3174 #
3175 #
3176 # The default is 1000.
3177 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
3178 # transmitted to the peer router. The actual value is negotiated between
3179 # the two routers and is equal to the greater of this value and the
3180 # corresponding receive interval of the other router.
3181 #
3182 #
3183 # If set, this value must be between 1000 and 30000.
3184 #
3185 #
3186 # The default is 1000.
3187 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
3188 # before BFD declares that a peer is unavailable.
3189 #
3190 #
3191 # If set, the value must be a value between 5 and 16.
3192 #
3193 #
3194 # The default is 5.
3195 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
3196 #
3197 #
3198 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
3199 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
3200 # peer router to initiate the BFD session for this BGP peer. If set to
3201 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
3202 },
3203 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
3204 # session.
3205 {
3206 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
3207 # CIDR-formatted prefix. If an IP address is provided without a subnet
3208 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
3209 # range, and, for IPv6, `/128`.
3210 },
3211 ],
3212 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
3213 # value is applied to all custom learned route ranges for the session.
3214 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
3215 # value, Google Cloud assigns a priority of `100` to the ranges.
3216 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
3217 #
3218 #
3219 # If set to FALSE, any active session with the peer is terminated and
3220 # all associated routing information is removed. If set to TRUE, the
3221 # peer connection can be established with routing information. The default
3222 # is TRUE.
3223 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
3224 # the peerIpAddress is version 4.
3225 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
3226 # peerIpAddress is version 6.
3227 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
3228 # evaluated. The name must correspond to an existing policy that has
3229 # ROUTE_POLICY_TYPE_EXPORT type.
3230 &quot;A String&quot;,
3231 ],
3232 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
3233 # evaluated. The name must correspond to an existing policy that has
3234 # ROUTE_POLICY_TYPE_IMPORT type.
3235 &quot;A String&quot;,
3236 ],
3237 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
3238 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
3239 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
3240 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
3241 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
3242 #
3243 # - MANAGED_BY_USER is the default value and can be managed by you
3244 # or other users
3245 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
3246 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
3247 # PARTNER. Google automatically creates, updates, and deletes this type of
3248 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
3249 # or deleted.
3250 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
3251 # name of one of the entries in the Router.md5_authentication_keys. The
3252 # field must comply with RFC1035.
3253 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
3254 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
3255 # characters long and match the regular expression
3256 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
3257 # lowercase letter, and all following characters must be a dash, lowercase
3258 # letter, or digit, except the last character, which cannot be a dash.
3259 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
3260 # a different value.
3261 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
3262 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
3263 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
3264 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
3265 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
3266 # Appliances. The VM instance must be located in zones contained in the
3267 # same region as this Cloud Router.
3268 # The VM instance is the peer side of the BGP session.
3269 },
3270 ],
3271 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3272 # text format.
3273 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3274 # create the resource.
3275 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
3276 # attachments (interconnectAttachments).
3277 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
3278 # defined by the server.
3279 &quot;interfaces&quot;: [ # Router interfaces.
3280 # To create a BGP peer that uses a router interface,
3281 # the interface must have one of the following fields specified:
3282 #
3283 # - linkedVpnTunnel
3284 # - linkedInterconnectAttachment
3285 # - subnetwork
3286 #
3287 #
3288 # You can create a router interface without any of these fields specified.
3289 # However, you cannot create a BGP peer that uses that interface.
3290 {
3291 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
3292 #
3293 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
3294 # be a CIDR-formatted string, for example, 169.254.0.1/30.
3295 # Note: Do not truncate the IP address, as it represents the IP address of
3296 # the interface.
3297 # - For Internet Protocol version 6 (IPv6), the value
3298 # must be a unique local address (ULA) range from fdff:1::/64
3299 # with a mask length of 126 or less. This value should be a CIDR-formatted
3300 # string, for example, fdff:1::1/112. Within the router&#x27;s
3301 # VPC, this IPv6 prefix will be reserved exclusively for this connection
3302 # and cannot be used for any other purpose.
3303 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
3304 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
3305 # as the router. Each interface can have one linked resource, which can be
3306 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
3307 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
3308 # router. Each interface can have one linked resource, which can be
3309 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
3310 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
3311 #
3312 # - MANAGED_BY_USER is the default value and can be managed directly
3313 # by users.
3314 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
3315 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
3316 # of type PARTNER. Google automatically creates, updates, and deletes
3317 # this type of interface when the PARTNER InterconnectAttachment is
3318 # created, updated, or deleted.
3319 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
3320 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
3321 # characters long and match the regular expression
3322 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
3323 # lowercase letter, and all following characters must be a dash, lowercase
3324 # letter, or digit, except the last character, which cannot be a dash.
3325 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
3326 # BGP sessions to a VM instance acting as a third-party
3327 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
3328 # an SD-WAN VM.
3329 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
3330 # you are creating. The redundantInterface must belong to the same Cloud
3331 # Router as the interface here. To establish the BGP session to a Router
3332 # Appliance VM, you must create two BGP peers. The two BGP peers must be
3333 # attached to two separate interfaces that are redundant with each other.
3334 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
3335 # be 1-63 characters long and match the regular expression
3336 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
3337 # lowercase letter, and all following characters must be a dash, lowercase
3338 # letter, or digit, except the last character, which cannot be a dash.
3339 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
3340 # must be in the same region as the Cloud Router.
3341 # When you establish a BGP session to a VM instance using this interface,
3342 # the VM instance must belong to the same subnetwork as the subnetwork
3343 # specified here.
3344 },
3345 ],
3346 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
3347 # routers.
3348 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
3349 {
3350 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
3351 #
3352 # For patch and update calls, it can be skipped to
3353 # copy the value from the previous configuration. This is allowed if the
3354 # key with the same name existed before the operation. Maximum length is 80
3355 # characters. Can only contain printable ASCII characters.
3356 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
3357 #
3358 # Must be unique within a router. Must be referenced by exactly
3359 # one bgpPeer. Must comply withRFC1035.
3360 },
3361 ],
3362 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3363 # The name must be 1-63 characters long, and comply withRFC1035.
3364 # Specifically, the name must be 1-63 characters long and match the regular
3365 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3366 # character must be a lowercase letter, and all following characters must
3367 # be a dash, lowercase letter, or digit, except the last character, which
3368 # cannot be a dash.
3369 &quot;nats&quot;: [ # A list of NAT services created in this router.
3370 { # Represents a Nat resource. It enables the VMs within the specified
3371 # subnetworks to access Internet without external IP addresses. It specifies
3372 # a list of subnetworks (and the ranges within) that want to use NAT.
3373 # Customers can also provide the external IPs that would be used for NAT. GCP
3374 # would auto-allocate ephemeral IPs if no external IPs are provided.
3375 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
3376 # Must be one of: PREMIUM, STANDARD.
3377 # If not specified, then the current
3378 # project-level default tier is used.
3379 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
3380 # must be valid static external IPs that have been assigned to the NAT.
3381 # These IPs should be used for updating/patching a NAT only.
3382 &quot;A String&quot;,
3383 ],
3384 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
3385 # state. This value is equal to tcp_time_wait_timeout_sec.
3386 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
3387 # 120s. The field is output only.
3388 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
3389 #
3390 #
3391 # If not specified, it is disabled by default.
3392 #
3393 #
3394 # If set to true,
3395 #
3396 # - Dynamic Port Allocation will be enabled on this NAT
3397 # config.
3398 # - enableEndpointIndependentMapping cannot be set to true.
3399 # - If minPorts is set, minPortsPerVm must be set to a
3400 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
3401 # minimum of 32 ports will be allocated to a VM from this NAT
3402 # config.
3403 &quot;enableEndpointIndependentMapping&quot;: True or False,
3404 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
3405 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
3406 &quot;A String&quot;,
3407 ],
3408 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
3409 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
3410 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
3411 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
3412 # logs are exported for all connections handled by this NAT.
3413 # This option can take one of the following values:
3414 #
3415 # - ERRORS_ONLY: Export logs only for connection failures.
3416 # - TRANSLATIONS_ONLY: Export logs only for successful
3417 # connections.
3418 # - ALL: Export logs for all connections, successful and
3419 # unsuccessful.
3420 },
3421 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
3422 # Dynamic Port Allocation is enabled.
3423 #
3424 #
3425 # If Dynamic Port Allocation is not enabled, this field has no effect.
3426 #
3427 #
3428 # If Dynamic Port Allocation is enabled, and this field is set, it must be
3429 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
3430 # is not set.
3431 #
3432 #
3433 # If Dynamic Port Allocation is enabled and this field is not set,
3434 # a maximum of 65536 ports will be allocated to a VM from this NAT
3435 # config.
3436 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
3437 # set, a default number of ports is allocated to a VM. This is rounded
3438 # up to the nearest power of 2. For example, if the value of this field is
3439 # 50, at least 64 ports are allocated to a VM.
3440 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
3441 # The name must be 1-63 characters long and comply withRFC1035.
3442 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
3443 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
3444 # selected for the SubnetworkIpRangeToNat64Option above.
3445 { # Specifies a subnetwork to enable NAT64.
3446 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
3447 },
3448 ],
3449 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
3450 # values:
3451 #
3452 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
3453 # customers. When there are not enough specified Nat IPs, the Nat service
3454 # fails for new VMs.
3455 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
3456 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
3457 # be empty.
3458 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
3459 # addresses must be valid static external IP addresses assigned to the
3460 # project.
3461 &quot;A String&quot;,
3462 ],
3463 &quot;rules&quot;: [ # A list of rules associated with this NAT.
3464 {
3465 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
3466 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
3467 # addresses must be valid static external IP addresses assigned to the
3468 # project.
3469 # This field is used for public NAT.
3470 &quot;A String&quot;,
3471 ],
3472 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
3473 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
3474 # This field is used for private NAT.
3475 &quot;A String&quot;,
3476 ],
3477 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
3478 # must be valid static external IPs that have been assigned to the NAT.
3479 # These IPs should be used for updating/patching a NAT rule only.
3480 # This field is used for public NAT.
3481 &quot;A String&quot;,
3482 ],
3483 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
3484 # drained. This is only supported on patch/update, and these
3485 # subnetworks must have previously been used as active ranges in this
3486 # NAT Rule.
3487 # This field is used for private NAT.
3488 &quot;A String&quot;,
3489 ],
3490 },
3491 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
3492 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
3493 # from a VM is evaluated against. If it evaluates to true, the
3494 # corresponding `action` is enforced.
3495 #
3496 # The following examples are valid match expressions for public NAT:
3497 #
3498 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
3499 # &#x27;2.2.0.0/16&#x27;)`
3500 #
3501 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
3502 #
3503 # The following example is a valid match expression for private NAT:
3504 #
3505 # `nexthop.hub ==
3506 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
3507 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
3508 # must be a positive value between 0 and 65000, and
3509 # must be unique among rules within a NAT.
3510 },
3511 ],
3512 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
3513 #
3514 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
3515 # Subnetwork are allowed to Nat.
3516 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
3517 # in every Subnetwork are allowed to Nat.
3518 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
3519 # (specified in the field subnetwork below)
3520 #
3521 #
3522 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
3523 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
3524 # should not be any other Router.Nat section in any Router for this network
3525 # in this region.
3526 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
3527 # values:
3528 #
3529 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
3530 # every Subnetwork are allowed to Nat.
3531 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
3532 # (specified in the field nat64_subnetwork below)
3533 #
3534 #
3535 # The default is NAT64_OPTION_UNSPECIFIED.
3536 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
3537 # Router.Nat section in this region can also enable NAT64 for any
3538 # Subnetworks in this network. Other Router.Nat sections can still be
3539 # present to enable NAT44 only.
3540 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
3541 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
3542 # SubnetworkIpRangeToNatOption above.
3543 { # Defines the IP ranges that want to use NAT for a subnetwork.
3544 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
3545 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
3546 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
3547 # is one of the values in source_ip_ranges_to_nat.
3548 &quot;A String&quot;,
3549 ],
3550 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
3551 # options of a single value are valid except
3552 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
3553 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
3554 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
3555 # Default: [ALL_IP_RANGES]
3556 &quot;A String&quot;,
3557 ],
3558 },
3559 ],
3560 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
3561 # if not set.
3562 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
3563 # Defaults to 120s if not set.
3564 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
3565 # not set.
3566 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
3567 # translation. If unspecified, it defaults to PUBLIC.
3568 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
3569 },
3570 ],
3571 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
3572 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
3573 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3574 # as part of resource payload.
3575 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3576 # The field is allowed for INSERT
3577 # only. The keys/values to set on the resource should be specified in
3578 # either ID { : } or Namespaced format
3579 # { : }.
3580 # For example the following are valid inputs:
3581 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3582 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3583 # Note:
3584 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3585 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3586 # * Inconsistent format is not supported. For instance:
3587 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
3588 &quot;a_key&quot;: &quot;A String&quot;,
3589 },
3590 },
3591 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
3592 # You must specify this field as part of the HTTP request URL. It is
3593 # not settable as a field in the request body.
3594 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3595 }
3596
3597 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3598 that if you must retry your request, the server will know to ignore the
3599 request if it has already been completed.
3600
3601 For example, consider a situation where you make an initial request and
3602 the request times out. If you make the request again with the same
3603 request ID, the server can check if original operation with the same
3604 request ID was received, and if so, will ignore the second request. This
3605 prevents clients from accidentally creating duplicate commitments.
3606
3607 The request ID must be
3608 a valid UUID with the exception that zero UUID is not supported
3609 (00000000-0000-0000-0000-000000000000).
3610 x__xgafv: string, V1 error format.
3611 Allowed values
3612 1 - v1 error format
3613 2 - v2 error format
3614
3615 Returns:
3616 An object of the form:
3617
3618 { # Represents an Operation resource.
3619 #
3620 # Google Compute Engine has three Operation resources:
3621 #
3622 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3623 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3624 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3625 #
3626 # You can use an operation resource to manage asynchronous API requests.
3627 # For more information, readHandling
3628 # API responses.
3629 #
3630 # Operations can be global, regional or zonal.
3631 #
3632 # - For global operations, use the `globalOperations`
3633 # resource.
3634 # - For regional operations, use the
3635 # `regionOperations` resource.
3636 # - For zonal operations, use
3637 # the `zoneOperations` resource.
3638 #
3639 #
3640 #
3641 # For more information, read
3642 # Global, Regional, and Zonal Resources.
3643 #
3644 # Note that completed Operation resources have a limited
3645 # retention period.
3646 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3647 # Not present otherwise.
3648 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3649 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3650 # set when the operation is created.
3651 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3652 # text format.
3653 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3654 # this field will be populated.
3655 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3656 # operation.
3657 {
3658 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3659 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3660 # details. There is a set of defined message types to use for providing
3661 # details.The syntax depends on the error code. For example,
3662 # QuotaExceededInfo will have details when the error code is
3663 # QUOTA_EXCEEDED.
3664 {
3665 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3666 #
3667 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3668 # is not enabled:
3669 #
3670 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3671 # &quot;domain&quot;: &quot;googleapis.com&quot;
3672 # &quot;metadata&quot;: {
3673 # &quot;resource&quot;: &quot;projects/123&quot;,
3674 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3675 # }
3676 # }
3677 #
3678 # This response indicates that the pubsub.googleapis.com API is not enabled.
3679 #
3680 # Example of an error that is returned when attempting to create a Spanner
3681 # instance in a region that is out of stock:
3682 #
3683 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3684 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3685 # &quot;metadata&quot;: {
3686 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3687 # }
3688 # }
3689 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3690 # is typically the registered service name of the tool or product that
3691 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3692 # generated by some common infrastructure, the error domain must be a
3693 # globally unique value that identifies the infrastructure. For Google API
3694 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3695 &quot;metadatas&quot;: { # Additional structured details about this error.
3696 #
3697 # Keys must match a regular expression of `a-z+` but should
3698 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3699 # length. When identifying the current value of an exceeded limit, the units
3700 # should be contained in the key, not the value. For example, rather than
3701 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3702 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3703 # instances that can be created in a single (batch) request.
3704 &quot;a_key&quot;: &quot;A String&quot;,
3705 },
3706 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3707 # proximate cause of the error. Error reasons are unique within a particular
3708 # domain of errors. This should be at most 63 characters and match a
3709 # regular expression of `A-Z+[A-Z0-9]`, which represents
3710 # UPPER_SNAKE_CASE.
3711 },
3712 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3713 #
3714 # For example, if a quota check failed with an error indicating the calling
3715 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3716 # directly to the right place in the developer console to flip the bit.
3717 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3718 { # Describes a URL link.
3719 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3720 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3721 },
3722 ],
3723 },
3724 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3725 # which can be attached to an RPC error.
3726 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3727 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3728 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3729 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3730 },
3731 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3732 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3733 &quot;a_key&quot;: &quot;A String&quot;,
3734 },
3735 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3736 # type or metric.
3737 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3738 # or metric.
3739 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3740 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3741 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3742 },
3743 },
3744 ],
3745 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3746 # This property is optional.
3747 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3748 },
3749 ],
3750 },
3751 &quot;getVersionOperationMetadata&quot;: {
3752 &quot;inlineSbomInfo&quot;: {
3753 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3754 # appropriate identifiers.
3755 &quot;a_key&quot;: &quot;A String&quot;,
3756 },
3757 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3758 # identifiers.
3759 &quot;a_key&quot;: &quot;A String&quot;,
3760 },
3761 },
3762 },
3763 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3764 # message that was returned, such as `NOT FOUND`.
3765 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3766 # status code that was returned. For example, a `404` means the
3767 # resource was not found.
3768 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3769 # defined by the server.
3770 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3771 # This value is inRFC3339
3772 # text format.
3773 &quot;instancesBulkInsertOperationMetadata&quot;: {
3774 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3775 # Example key: zones/us-central1-a
3776 &quot;a_key&quot;: {
3777 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3778 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3779 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3780 # error.
3781 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3782 # if the flow is rolling forward or rolling back.
3783 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3784 },
3785 },
3786 },
3787 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3788 # Operation resources.
3789 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3790 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3791 # group of operations results from a `bulkInsert` API request.
3792 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3793 # `update`, or `delete`, and so on.
3794 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3795 # There is no requirement that this be linear or support any granularity of
3796 # operations. This should not be used to guess when the operation will be
3797 # complete. This number should monotonically increase as the operation
3798 # progresses.
3799 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3800 # applicable when performing regional operations.
3801 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3802 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3803 # this field will contain information on all underlying zonal actions and
3804 # their state.
3805 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3806 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3807 # Example key: zones/us-central1-a
3808 &quot;a_key&quot;: {
3809 &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
3810 # populated.
3811 # different programming environments, including REST APIs and RPC APIs. It is
3812 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3813 # three pieces of data: error code, error message, and error details.
3814 #
3815 # You can find out more about this error model and how to work with it in the
3816 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3817 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3818 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3819 # message types for APIs to use.
3820 {
3821 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3822 },
3823 ],
3824 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3825 # user-facing error message should be localized and sent in the
3826 # google.rpc.Status.details field, or localized by the client.
3827 },
3828 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3829 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3830 },
3831 },
3832 },
3833 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3834 # This value is inRFC3339
3835 # text format.
3836 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3837 # following:
3838 # `PENDING`, `RUNNING`, or `DONE`.
3839 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3840 # operation.
3841 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3842 # of the target resource.
3843 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3844 # operations related to creating a snapshot, this points to the disk
3845 # that the snapshot was created from.
3846 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3847 # `[email protected]` or
3848 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3849 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3850 # operation, this field will be populated.
3851 {
3852 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3853 # Engine returns NO_RESULTS_ON_PAGE if there
3854 # are no results in the response.
3855 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3856 # value format. For example:
3857 #
3858 # &quot;data&quot;: [
3859 # {
3860 # &quot;key&quot;: &quot;scope&quot;,
3861 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3862 # }
3863 {
3864 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3865 # returned. For example, for warnings where there are no results in a list
3866 # request for a particular zone, this key might be scope and
3867 # the key value might be the zone name. Other examples might be a key
3868 # indicating a deprecated resource and a suggested replacement, or a
3869 # warning about invalid network settings (for example, if an instance
3870 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3871 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3872 },
3873 ],
3874 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3875 },
3876 ],
3877 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3878 # applicable when performing per-zone operations.
3879 }</pre>
3880 </div>
3881
3882 <div class="method">
3883 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
3884 <pre>Retrieves a list of Router resources available to the specified project.
3885
3886 Args:
3887 project: string, Project ID for this request. (required)
3888 region: string, Name of the region for this request. (required)
3889 filter: string, A filter expression that filters resources listed in the response. Most
3890 Compute resources support two types of filter expressions:
3891 expressions that support regular expressions and expressions that follow
3892 API improvement proposal AIP-160.
3893 These two types of filter expressions cannot be mixed in one request.
3894
3895 If you want to use AIP-160, your expression must specify the field name, an
3896 operator, and the value that you want to use for filtering. The value
3897 must be a string, a number, or a boolean. The operator
3898 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
3899
3900 For example, if you are filtering Compute Engine instances, you can
3901 exclude instances named `example-instance` by specifying
3902 `name != example-instance`.
3903
3904 The `:*` comparison can be used to test whether a key has been defined.
3905 For example, to find all objects with `owner` label use:
3906 ```
3907 labels.owner:*
3908 ```
3909
3910 You can also filter nested fields. For example, you could specify
3911 `scheduling.automaticRestart = false` to include instances only
3912 if they are not scheduled for automatic restarts. You can use filtering
3913 on nested fields to filter based onresource labels.
3914
3915 To filter on multiple expressions, provide each separate expression within
3916 parentheses. For example:
3917 ```
3918 (scheduling.automaticRestart = true)
3919 (cpuPlatform = &quot;Intel Skylake&quot;)
3920 ```
3921 By default, each expression is an `AND` expression. However, you
3922 can include `AND` and `OR` expressions explicitly.
3923 For example:
3924 ```
3925 (cpuPlatform = &quot;Intel Skylake&quot;) OR
3926 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
3927 (scheduling.automaticRestart = true)
3928 ```
3929
3930 If you want to use a regular expression, use the `eq` (equal) or `ne`
3931 (not equal) operator against a single un-parenthesized expression with or
3932 without quotes or against multiple parenthesized expressions. Examples:
3933
3934 `fieldname eq unquoted literal`
3935 `fieldname eq &#x27;single quoted literal&#x27;`
3936 `fieldname eq &quot;double quoted literal&quot;`
3937 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
3938
3939 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
3940 The literal value must match the entire field.
3941
3942 For example, to filter for instances that do not end with name &quot;instance&quot;,
3943 you would use `name ne .*instance`.
3944
3945 You cannot combine constraints on multiple fields using regular
3946 expressions.
3947 maxResults: integer, The maximum number of results per page that should be returned.
3948 If the number of available results is larger than `maxResults`,
3949 Compute Engine returns a `nextPageToken` that can be used to get
3950 the next page of results in subsequent list requests. Acceptable values are
3951 `0` to `500`, inclusive. (Default: `500`)
3952 orderBy: string, Sorts list results by a certain order. By default, results
3953 are returned in alphanumerical order based on the resource name.
3954
3955 You can also sort results in descending order based on the creation
3956 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
3957 results based on the `creationTimestamp` field in
3958 reverse chronological order (newest result first). Use this to sort
3959 resources like operations so that the newest operation is returned first.
3960
3961 Currently, only sorting by `name` or
3962 `creationTimestamp desc` is supported.
3963 pageToken: string, Specifies a page token to use. Set `pageToken` to the
3964 `nextPageToken` returned by a previous list request to get
3965 the next page of results.
3966 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
3967 of failure. The default value is false.
3968
3969 For example, when partial success behavior is enabled, aggregatedList for a
3970 single zone scope either returns all resources in the zone or no resources,
3971 with an error code.
3972 x__xgafv: string, V1 error format.
3973 Allowed values
3974 1 - v1 error format
3975 2 - v2 error format
3976
3977 Returns:
3978 An object of the form:
3979
3980 { # Contains a list of Router resources.
3981 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3982 &quot;items&quot;: [ # A list of Router resources.
3983 { # Represents a Cloud Router resource.
3984 #
3985 # For more information about Cloud Router, read theCloud
3986 # Router overview.
3987 &quot;bgp&quot;: { # BGP information specific to this router.
3988 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
3989 # The options are DEFAULT or CUSTOM.
3990 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
3991 # This field can only be populated if advertise_mode is CUSTOM and
3992 # is advertised to all peers of the router.
3993 # These groups will be advertised in addition to any specified prefixes.
3994 # Leave this field blank to advertise no custom groups.
3995 &quot;A String&quot;,
3996 ],
3997 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
3998 # This field can only be populated if advertise_mode is CUSTOM and
3999 # is advertised to all peers of the router.
4000 # These IP ranges will be advertised in addition to any specified groups.
4001 # Leave this field blank to advertise no custom IP ranges.
4002 { # Description-tagged IP ranges for the router to advertise.
4003 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
4004 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
4005 },
4006 ],
4007 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
4008 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
4009 # value will be fixed for this router resource. All VPN tunnels that link
4010 # to this router will have the same local ASN.
4011 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
4012 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
4013 # least /30, even if the BGP sessions are over IPv6. It must not overlap
4014 # with any IPv4 BGP session ranges.
4015 #
4016 #
4017 # Other vendors commonly call this &quot;router ID&quot;.
4018 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
4019 # sent to the peer.
4020 #
4021 #
4022 # Hold time is three times the interval at which keepalive messages are
4023 # sent, and the hold time is the maximum number of seconds allowed to
4024 # elapse between successive keepalive messages that BGP receives from a
4025 # peer.
4026 #
4027 #
4028 # BGP will use the smaller of either the local hold time value or the
4029 # peer&#x27;s hold time value as the hold time for the BGP connection between
4030 # the two peers.
4031 #
4032 #
4033 # If set, this value must be between 20 and 60. The default is 20.
4034 },
4035 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
4036 # establish BGP peering. This information must specify the peer ASN and
4037 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
4038 {
4039 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
4040 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
4041 # which currently supports the following option:
4042 #
4043 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
4044 # excludes any routes learned for subnets that use
4045 # VPC Network Peering.
4046 #
4047 #
4048 # Note that this field can only be populated if advertise_mode is CUSTOM
4049 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
4050 # These groups are advertised in addition to any specified prefixes.
4051 # Leave this field blank to advertise no custom groups.
4052 &quot;A String&quot;,
4053 ],
4054 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
4055 # This field can only be populated if advertise_mode is CUSTOM and
4056 # overrides the list defined for the router (in the &quot;bgp&quot; message).
4057 # These IP ranges are advertised in addition to any specified groups.
4058 # Leave this field blank to advertise no custom IP ranges.
4059 { # Description-tagged IP ranges for the router to advertise.
4060 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
4061 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
4062 },
4063 ],
4064 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
4065 # than one matching route of maximum length, the routes with the lowest
4066 # priority value win.
4067 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
4068 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
4069 # received from the peer router. The actual value is negotiated between
4070 # the two routers and is equal to the greater of this value and the
4071 # transmit interval of the other router.
4072 #
4073 #
4074 # If set, this value must be between 1000 and 30000.
4075 #
4076 #
4077 # The default is 1000.
4078 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
4079 # transmitted to the peer router. The actual value is negotiated between
4080 # the two routers and is equal to the greater of this value and the
4081 # corresponding receive interval of the other router.
4082 #
4083 #
4084 # If set, this value must be between 1000 and 30000.
4085 #
4086 #
4087 # The default is 1000.
4088 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
4089 # before BFD declares that a peer is unavailable.
4090 #
4091 #
4092 # If set, the value must be a value between 5 and 16.
4093 #
4094 #
4095 # The default is 5.
4096 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
4097 #
4098 #
4099 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
4100 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
4101 # peer router to initiate the BFD session for this BGP peer. If set to
4102 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
4103 },
4104 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
4105 # session.
4106 {
4107 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
4108 # CIDR-formatted prefix. If an IP address is provided without a subnet
4109 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
4110 # range, and, for IPv6, `/128`.
4111 },
4112 ],
4113 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
4114 # value is applied to all custom learned route ranges for the session.
4115 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
4116 # value, Google Cloud assigns a priority of `100` to the ranges.
4117 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
4118 #
4119 #
4120 # If set to FALSE, any active session with the peer is terminated and
4121 # all associated routing information is removed. If set to TRUE, the
4122 # peer connection can be established with routing information. The default
4123 # is TRUE.
4124 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
4125 # the peerIpAddress is version 4.
4126 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
4127 # peerIpAddress is version 6.
4128 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
4129 # evaluated. The name must correspond to an existing policy that has
4130 # ROUTE_POLICY_TYPE_EXPORT type.
4131 &quot;A String&quot;,
4132 ],
4133 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
4134 # evaluated. The name must correspond to an existing policy that has
4135 # ROUTE_POLICY_TYPE_IMPORT type.
4136 &quot;A String&quot;,
4137 ],
4138 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
4139 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
4140 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
4141 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
4142 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
4143 #
4144 # - MANAGED_BY_USER is the default value and can be managed by you
4145 # or other users
4146 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
4147 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
4148 # PARTNER. Google automatically creates, updates, and deletes this type of
4149 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
4150 # or deleted.
4151 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
4152 # name of one of the entries in the Router.md5_authentication_keys. The
4153 # field must comply with RFC1035.
4154 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
4155 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
4156 # characters long and match the regular expression
4157 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4158 # lowercase letter, and all following characters must be a dash, lowercase
4159 # letter, or digit, except the last character, which cannot be a dash.
4160 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
4161 # a different value.
4162 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
4163 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
4164 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
4165 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
4166 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
4167 # Appliances. The VM instance must be located in zones contained in the
4168 # same region as this Cloud Router.
4169 # The VM instance is the peer side of the BGP session.
4170 },
4171 ],
4172 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4173 # text format.
4174 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4175 # create the resource.
4176 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
4177 # attachments (interconnectAttachments).
4178 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4179 # defined by the server.
4180 &quot;interfaces&quot;: [ # Router interfaces.
4181 # To create a BGP peer that uses a router interface,
4182 # the interface must have one of the following fields specified:
4183 #
4184 # - linkedVpnTunnel
4185 # - linkedInterconnectAttachment
4186 # - subnetwork
4187 #
4188 #
4189 # You can create a router interface without any of these fields specified.
4190 # However, you cannot create a BGP peer that uses that interface.
4191 {
4192 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
4193 #
4194 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
4195 # be a CIDR-formatted string, for example, 169.254.0.1/30.
4196 # Note: Do not truncate the IP address, as it represents the IP address of
4197 # the interface.
4198 # - For Internet Protocol version 6 (IPv6), the value
4199 # must be a unique local address (ULA) range from fdff:1::/64
4200 # with a mask length of 126 or less. This value should be a CIDR-formatted
4201 # string, for example, fdff:1::1/112. Within the router&#x27;s
4202 # VPC, this IPv6 prefix will be reserved exclusively for this connection
4203 # and cannot be used for any other purpose.
4204 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
4205 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
4206 # as the router. Each interface can have one linked resource, which can be
4207 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
4208 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
4209 # router. Each interface can have one linked resource, which can be
4210 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
4211 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
4212 #
4213 # - MANAGED_BY_USER is the default value and can be managed directly
4214 # by users.
4215 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
4216 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
4217 # of type PARTNER. Google automatically creates, updates, and deletes
4218 # this type of interface when the PARTNER InterconnectAttachment is
4219 # created, updated, or deleted.
4220 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
4221 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
4222 # characters long and match the regular expression
4223 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4224 # lowercase letter, and all following characters must be a dash, lowercase
4225 # letter, or digit, except the last character, which cannot be a dash.
4226 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
4227 # BGP sessions to a VM instance acting as a third-party
4228 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
4229 # an SD-WAN VM.
4230 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
4231 # you are creating. The redundantInterface must belong to the same Cloud
4232 # Router as the interface here. To establish the BGP session to a Router
4233 # Appliance VM, you must create two BGP peers. The two BGP peers must be
4234 # attached to two separate interfaces that are redundant with each other.
4235 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
4236 # be 1-63 characters long and match the regular expression
4237 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4238 # lowercase letter, and all following characters must be a dash, lowercase
4239 # letter, or digit, except the last character, which cannot be a dash.
4240 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
4241 # must be in the same region as the Cloud Router.
4242 # When you establish a BGP session to a VM instance using this interface,
4243 # the VM instance must belong to the same subnetwork as the subnetwork
4244 # specified here.
4245 },
4246 ],
4247 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
4248 # routers.
4249 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
4250 {
4251 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
4252 #
4253 # For patch and update calls, it can be skipped to
4254 # copy the value from the previous configuration. This is allowed if the
4255 # key with the same name existed before the operation. Maximum length is 80
4256 # characters. Can only contain printable ASCII characters.
4257 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
4258 #
4259 # Must be unique within a router. Must be referenced by exactly
4260 # one bgpPeer. Must comply withRFC1035.
4261 },
4262 ],
4263 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
4264 # The name must be 1-63 characters long, and comply withRFC1035.
4265 # Specifically, the name must be 1-63 characters long and match the regular
4266 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4267 # character must be a lowercase letter, and all following characters must
4268 # be a dash, lowercase letter, or digit, except the last character, which
4269 # cannot be a dash.
4270 &quot;nats&quot;: [ # A list of NAT services created in this router.
4271 { # Represents a Nat resource. It enables the VMs within the specified
4272 # subnetworks to access Internet without external IP addresses. It specifies
4273 # a list of subnetworks (and the ranges within) that want to use NAT.
4274 # Customers can also provide the external IPs that would be used for NAT. GCP
4275 # would auto-allocate ephemeral IPs if no external IPs are provided.
4276 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
4277 # Must be one of: PREMIUM, STANDARD.
4278 # If not specified, then the current
4279 # project-level default tier is used.
4280 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
4281 # must be valid static external IPs that have been assigned to the NAT.
4282 # These IPs should be used for updating/patching a NAT only.
4283 &quot;A String&quot;,
4284 ],
4285 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
4286 # state. This value is equal to tcp_time_wait_timeout_sec.
4287 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
4288 # 120s. The field is output only.
4289 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
4290 #
4291 #
4292 # If not specified, it is disabled by default.
4293 #
4294 #
4295 # If set to true,
4296 #
4297 # - Dynamic Port Allocation will be enabled on this NAT
4298 # config.
4299 # - enableEndpointIndependentMapping cannot be set to true.
4300 # - If minPorts is set, minPortsPerVm must be set to a
4301 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
4302 # minimum of 32 ports will be allocated to a VM from this NAT
4303 # config.
4304 &quot;enableEndpointIndependentMapping&quot;: True or False,
4305 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
4306 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
4307 &quot;A String&quot;,
4308 ],
4309 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
4310 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
4311 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
4312 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
4313 # logs are exported for all connections handled by this NAT.
4314 # This option can take one of the following values:
4315 #
4316 # - ERRORS_ONLY: Export logs only for connection failures.
4317 # - TRANSLATIONS_ONLY: Export logs only for successful
4318 # connections.
4319 # - ALL: Export logs for all connections, successful and
4320 # unsuccessful.
4321 },
4322 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
4323 # Dynamic Port Allocation is enabled.
4324 #
4325 #
4326 # If Dynamic Port Allocation is not enabled, this field has no effect.
4327 #
4328 #
4329 # If Dynamic Port Allocation is enabled, and this field is set, it must be
4330 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
4331 # is not set.
4332 #
4333 #
4334 # If Dynamic Port Allocation is enabled and this field is not set,
4335 # a maximum of 65536 ports will be allocated to a VM from this NAT
4336 # config.
4337 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
4338 # set, a default number of ports is allocated to a VM. This is rounded
4339 # up to the nearest power of 2. For example, if the value of this field is
4340 # 50, at least 64 ports are allocated to a VM.
4341 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
4342 # The name must be 1-63 characters long and comply withRFC1035.
4343 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
4344 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
4345 # selected for the SubnetworkIpRangeToNat64Option above.
4346 { # Specifies a subnetwork to enable NAT64.
4347 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
4348 },
4349 ],
4350 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
4351 # values:
4352 #
4353 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
4354 # customers. When there are not enough specified Nat IPs, the Nat service
4355 # fails for new VMs.
4356 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
4357 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
4358 # be empty.
4359 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
4360 # addresses must be valid static external IP addresses assigned to the
4361 # project.
4362 &quot;A String&quot;,
4363 ],
4364 &quot;rules&quot;: [ # A list of rules associated with this NAT.
4365 {
4366 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
4367 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
4368 # addresses must be valid static external IP addresses assigned to the
4369 # project.
4370 # This field is used for public NAT.
4371 &quot;A String&quot;,
4372 ],
4373 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
4374 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
4375 # This field is used for private NAT.
4376 &quot;A String&quot;,
4377 ],
4378 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
4379 # must be valid static external IPs that have been assigned to the NAT.
4380 # These IPs should be used for updating/patching a NAT rule only.
4381 # This field is used for public NAT.
4382 &quot;A String&quot;,
4383 ],
4384 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
4385 # drained. This is only supported on patch/update, and these
4386 # subnetworks must have previously been used as active ranges in this
4387 # NAT Rule.
4388 # This field is used for private NAT.
4389 &quot;A String&quot;,
4390 ],
4391 },
4392 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
4393 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
4394 # from a VM is evaluated against. If it evaluates to true, the
4395 # corresponding `action` is enforced.
4396 #
4397 # The following examples are valid match expressions for public NAT:
4398 #
4399 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
4400 # &#x27;2.2.0.0/16&#x27;)`
4401 #
4402 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
4403 #
4404 # The following example is a valid match expression for private NAT:
4405 #
4406 # `nexthop.hub ==
4407 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
4408 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
4409 # must be a positive value between 0 and 65000, and
4410 # must be unique among rules within a NAT.
4411 },
4412 ],
4413 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
4414 #
4415 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
4416 # Subnetwork are allowed to Nat.
4417 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
4418 # in every Subnetwork are allowed to Nat.
4419 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
4420 # (specified in the field subnetwork below)
4421 #
4422 #
4423 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
4424 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
4425 # should not be any other Router.Nat section in any Router for this network
4426 # in this region.
4427 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
4428 # values:
4429 #
4430 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
4431 # every Subnetwork are allowed to Nat.
4432 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
4433 # (specified in the field nat64_subnetwork below)
4434 #
4435 #
4436 # The default is NAT64_OPTION_UNSPECIFIED.
4437 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
4438 # Router.Nat section in this region can also enable NAT64 for any
4439 # Subnetworks in this network. Other Router.Nat sections can still be
4440 # present to enable NAT44 only.
4441 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
4442 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
4443 # SubnetworkIpRangeToNatOption above.
4444 { # Defines the IP ranges that want to use NAT for a subnetwork.
4445 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
4446 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
4447 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
4448 # is one of the values in source_ip_ranges_to_nat.
4449 &quot;A String&quot;,
4450 ],
4451 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
4452 # options of a single value are valid except
4453 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
4454 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
4455 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
4456 # Default: [ALL_IP_RANGES]
4457 &quot;A String&quot;,
4458 ],
4459 },
4460 ],
4461 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
4462 # if not set.
4463 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
4464 # Defaults to 120s if not set.
4465 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
4466 # not set.
4467 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
4468 # translation. If unspecified, it defaults to PUBLIC.
4469 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
4470 },
4471 ],
4472 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
4473 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
4474 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
4475 # as part of resource payload.
4476 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
4477 # The field is allowed for INSERT
4478 # only. The keys/values to set on the resource should be specified in
4479 # either ID { : } or Namespaced format
4480 # { : }.
4481 # For example the following are valid inputs:
4482 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
4483 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
4484 # Note:
4485 # * Invalid combinations of ID &amp; namespaced format is not supported. For
4486 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
4487 # * Inconsistent format is not supported. For instance:
4488 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
4489 &quot;a_key&quot;: &quot;A String&quot;,
4490 },
4491 },
4492 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
4493 # You must specify this field as part of the HTTP request URL. It is
4494 # not settable as a field in the request body.
4495 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4496 },
4497 ],
4498 &quot;kind&quot;: &quot;compute#routerList&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
4499 # routers.
4500 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
4501 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
4502 # the query parameter pageToken in the next list request.
4503 # Subsequent list requests will have their own nextPageToken to
4504 # continue paging through the results.
4505 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
4506 &quot;warning&quot;: { # [Output Only] Informational warning message.
4507 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4508 # Engine returns NO_RESULTS_ON_PAGE if there
4509 # are no results in the response.
4510 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4511 # value format. For example:
4512 #
4513 # &quot;data&quot;: [
4514 # {
4515 # &quot;key&quot;: &quot;scope&quot;,
4516 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4517 # }
4518 {
4519 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4520 # returned. For example, for warnings where there are no results in a list
4521 # request for a particular zone, this key might be scope and
4522 # the key value might be the zone name. Other examples might be a key
4523 # indicating a deprecated resource and a suggested replacement, or a
4524 # warning about invalid network settings (for example, if an instance
4525 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4526 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4527 },
4528 ],
4529 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4530 },
4531 }</pre>
4532 </div>
4533
4534 <div class="method">
4535 <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>
4536 <pre>Retrieves a list of router bgp routes available to the specified project.
4537
4538 Args:
4539 project: string, Project ID for this request. (required)
4540 region: string, Name of the region for this request. (required)
4541 router: string, Name or id of the resource for this request.
4542 Name should conform to RFC1035. (required)
4543 addressFamily: string, (Required) limit results to this address family (either IPv4 or IPv6)
4544 Allowed values
4545 IPV4 -
4546 IPV6 -
4547 UNSPECIFIED_IP_VERSION -
4548 destinationPrefix: string, Limit results to destinations that are subnets of this CIDR range
4549 filter: string, A filter expression that filters resources listed in the response. Most
4550 Compute resources support two types of filter expressions:
4551 expressions that support regular expressions and expressions that follow
4552 API improvement proposal AIP-160.
4553 These two types of filter expressions cannot be mixed in one request.
4554
4555 If you want to use AIP-160, your expression must specify the field name, an
4556 operator, and the value that you want to use for filtering. The value
4557 must be a string, a number, or a boolean. The operator
4558 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4559
4560 For example, if you are filtering Compute Engine instances, you can
4561 exclude instances named `example-instance` by specifying
4562 `name != example-instance`.
4563
4564 The `:*` comparison can be used to test whether a key has been defined.
4565 For example, to find all objects with `owner` label use:
4566 ```
4567 labels.owner:*
4568 ```
4569
4570 You can also filter nested fields. For example, you could specify
4571 `scheduling.automaticRestart = false` to include instances only
4572 if they are not scheduled for automatic restarts. You can use filtering
4573 on nested fields to filter based onresource labels.
4574
4575 To filter on multiple expressions, provide each separate expression within
4576 parentheses. For example:
4577 ```
4578 (scheduling.automaticRestart = true)
4579 (cpuPlatform = &quot;Intel Skylake&quot;)
4580 ```
4581 By default, each expression is an `AND` expression. However, you
4582 can include `AND` and `OR` expressions explicitly.
4583 For example:
4584 ```
4585 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4586 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4587 (scheduling.automaticRestart = true)
4588 ```
4589
4590 If you want to use a regular expression, use the `eq` (equal) or `ne`
4591 (not equal) operator against a single un-parenthesized expression with or
4592 without quotes or against multiple parenthesized expressions. Examples:
4593
4594 `fieldname eq unquoted literal`
4595 `fieldname eq &#x27;single quoted literal&#x27;`
4596 `fieldname eq &quot;double quoted literal&quot;`
4597 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4598
4599 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4600 The literal value must match the entire field.
4601
4602 For example, to filter for instances that do not end with name &quot;instance&quot;,
4603 you would use `name ne .*instance`.
4604
4605 You cannot combine constraints on multiple fields using regular
4606 expressions.
4607 maxResults: integer, The maximum number of results per page that should be returned.
4608 If the number of available results is larger than `maxResults`,
4609 Compute Engine returns a `nextPageToken` that can be used to get
4610 the next page of results in subsequent list requests. Acceptable values are
4611 `0` to `500`, inclusive. (Default: `500`)
4612 orderBy: string, Sorts list results by a certain order. By default, results
4613 are returned in alphanumerical order based on the resource name.
4614
4615 You can also sort results in descending order based on the creation
4616 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4617 results based on the `creationTimestamp` field in
4618 reverse chronological order (newest result first). Use this to sort
4619 resources like operations so that the newest operation is returned first.
4620
4621 Currently, only sorting by `name` or
4622 `creationTimestamp desc` is supported.
4623 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4624 `nextPageToken` returned by a previous list request to get
4625 the next page of results.
4626 peer: string, (Required) limit results to the BGP peer with the given name.
4627 Name should conform to RFC1035.
4628 policyApplied: boolean, When true, the method returns post-policy routes. Otherwise, it returns
4629 pre-policy routes.
4630 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4631 of failure. The default value is false.
4632
4633 For example, when partial success behavior is enabled, aggregatedList for a
4634 single zone scope either returns all resources in the zone or no resources,
4635 with an error code.
4636 routeType: string, (Required) limit results to this type of route (either LEARNED or
4637 ADVERTISED)
4638 Allowed values
4639 ADVERTISED -
4640 LEARNED -
4641 UNSPECIFIED_ROUTE_TYPE -
4642 x__xgafv: string, V1 error format.
4643 Allowed values
4644 1 - v1 error format
4645 2 - v2 error format
4646
4647 Returns:
4648 An object of the form:
4649
4650 {
4651 &quot;etag&quot;: &quot;A String&quot;,
4652 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4653 # defined by the server.
4654 &quot;kind&quot;: &quot;compute#routersListBgpRoutes&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#routersListBgpRoutes for lists of bgp routes.
4655 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
4656 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
4657 # the query parameter pageToken in the next list request.
4658 # Subsequent list requests will have their own nextPageToken to
4659 # continue paging through the results.
4660 &quot;result&quot;: [ # [Output Only] A list of bgp routes.
4661 {
4662 &quot;asPaths&quot;: [ # Output only. [Output only] AS-PATH for the route
4663 {
4664 &quot;asns&quot;: [ # Output only. [Output only] ASNs in the path segment. When type is SEQUENCE, these are
4665 # ordered.
4666 42,
4667 ],
4668 &quot;asns32&quot;: [ # Output only. [Output only] ASNs in the path segment. This field is for better
4669 # support of 32 bit ASNs as the other asns field suffers from overflow when
4670 # the ASN is larger. When type is SEQUENCE, these are ordered.
4671 42,
4672 ],
4673 &quot;type&quot;: &quot;A String&quot;, # Output only. [Output only] Type of AS-PATH segment (SEQUENCE or SET)
4674 },
4675 ],
4676 &quot;communities&quot;: [ # Output only. [Output only] BGP communities in human-readable A:B format.
4677 &quot;A String&quot;,
4678 ],
4679 &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
4680 # format
4681 &quot;pathId&quot;: 42, # If the BGP session supports multiple paths (RFC 7911), the path
4682 # identifier for this route.
4683 &quot;prefix&quot;: &quot;A String&quot;, # Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16.
4684 },
4685 &quot;med&quot;: 42, # Output only. [Output only] BGP multi-exit discriminator
4686 &quot;origin&quot;: &quot;A String&quot;, # Output only. [Output only] BGP origin (EGP, IGP or INCOMPLETE)
4687 },
4688 ],
4689 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
4690 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
4691 &quot;A String&quot;,
4692 ],
4693 &quot;warning&quot;: { # [Output Only] Informational warning message.
4694 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4695 # Engine returns NO_RESULTS_ON_PAGE if there
4696 # are no results in the response.
4697 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4698 # value format. For example:
4699 #
4700 # &quot;data&quot;: [
4701 # {
4702 # &quot;key&quot;: &quot;scope&quot;,
4703 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4704 # }
4705 {
4706 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4707 # returned. For example, for warnings where there are no results in a list
4708 # request for a particular zone, this key might be scope and
4709 # the key value might be the zone name. Other examples might be a key
4710 # indicating a deprecated resource and a suggested replacement, or a
4711 # warning about invalid network settings (for example, if an instance
4712 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4713 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4714 },
4715 ],
4716 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4717 },
4718 }</pre>
4719 </div>
4720
4721 <div class="method">
4722 <code class="details" id="listBgpRoutes_next">listBgpRoutes_next()</code>
4723 <pre>Retrieves the next page of results.
4724
4725 Args:
4726 previous_request: The request for the previous page. (required)
4727 previous_response: The response from the request for the previous page. (required)
4728
4729 Returns:
4730 A request object that you can call &#x27;execute()&#x27; on to request the next
4731 page. Returns None if there are no more items in the collection.
4732 </pre>
4733 </div>
4734
4735 <div class="method">
4736 <code class="details" id="listRoutePolicies">listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4737 <pre>Retrieves a list of router route policy subresources available to the
4738 specified project.
4739
4740 Args:
4741 project: string, Project ID for this request. (required)
4742 region: string, Name of the region for this request. (required)
4743 router: string, Name or id of the resource for this request.
4744 Name should conform to RFC1035. (required)
4745 filter: string, A filter expression that filters resources listed in the response. Most
4746 Compute resources support two types of filter expressions:
4747 expressions that support regular expressions and expressions that follow
4748 API improvement proposal AIP-160.
4749 These two types of filter expressions cannot be mixed in one request.
4750
4751 If you want to use AIP-160, your expression must specify the field name, an
4752 operator, and the value that you want to use for filtering. The value
4753 must be a string, a number, or a boolean. The operator
4754 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4755
4756 For example, if you are filtering Compute Engine instances, you can
4757 exclude instances named `example-instance` by specifying
4758 `name != example-instance`.
4759
4760 The `:*` comparison can be used to test whether a key has been defined.
4761 For example, to find all objects with `owner` label use:
4762 ```
4763 labels.owner:*
4764 ```
4765
4766 You can also filter nested fields. For example, you could specify
4767 `scheduling.automaticRestart = false` to include instances only
4768 if they are not scheduled for automatic restarts. You can use filtering
4769 on nested fields to filter based onresource labels.
4770
4771 To filter on multiple expressions, provide each separate expression within
4772 parentheses. For example:
4773 ```
4774 (scheduling.automaticRestart = true)
4775 (cpuPlatform = &quot;Intel Skylake&quot;)
4776 ```
4777 By default, each expression is an `AND` expression. However, you
4778 can include `AND` and `OR` expressions explicitly.
4779 For example:
4780 ```
4781 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4782 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4783 (scheduling.automaticRestart = true)
4784 ```
4785
4786 If you want to use a regular expression, use the `eq` (equal) or `ne`
4787 (not equal) operator against a single un-parenthesized expression with or
4788 without quotes or against multiple parenthesized expressions. Examples:
4789
4790 `fieldname eq unquoted literal`
4791 `fieldname eq &#x27;single quoted literal&#x27;`
4792 `fieldname eq &quot;double quoted literal&quot;`
4793 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4794
4795 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4796 The literal value must match the entire field.
4797
4798 For example, to filter for instances that do not end with name &quot;instance&quot;,
4799 you would use `name ne .*instance`.
4800
4801 You cannot combine constraints on multiple fields using regular
4802 expressions.
4803 maxResults: integer, The maximum number of results per page that should be returned.
4804 If the number of available results is larger than `maxResults`,
4805 Compute Engine returns a `nextPageToken` that can be used to get
4806 the next page of results in subsequent list requests. Acceptable values are
4807 `0` to `500`, inclusive. (Default: `500`)
4808 orderBy: string, Sorts list results by a certain order. By default, results
4809 are returned in alphanumerical order based on the resource name.
4810
4811 You can also sort results in descending order based on the creation
4812 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4813 results based on the `creationTimestamp` field in
4814 reverse chronological order (newest result first). Use this to sort
4815 resources like operations so that the newest operation is returned first.
4816
4817 Currently, only sorting by `name` or
4818 `creationTimestamp desc` is supported.
4819 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4820 `nextPageToken` returned by a previous list request to get
4821 the next page of results.
4822 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4823 of failure. The default value is false.
4824
4825 For example, when partial success behavior is enabled, aggregatedList for a
4826 single zone scope either returns all resources in the zone or no resources,
4827 with an error code.
4828 x__xgafv: string, V1 error format.
4829 Allowed values
4830 1 - v1 error format
4831 2 - v2 error format
4832
4833 Returns:
4834 An object of the form:
4835
4836 {
4837 &quot;etag&quot;: &quot;A String&quot;,
4838 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4839 # defined by the server.
4840 &quot;kind&quot;: &quot;compute#routersListRoutePolicies&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#routersListRoutePolicies for lists of route policies.
4841 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
4842 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
4843 # the query parameter pageToken in the next list request.
4844 # Subsequent list requests will have their own nextPageToken to
4845 # continue paging through the results.
4846 &quot;result&quot;: [ # [Output Only] A list of route policies.
4847 {
4848 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
4849 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
4850 # essentially a hash of the Route Policy used for optimistic locking.
4851 # The fingerprint is initially generated by Compute Engine and changes
4852 # after every request to modify or update Route Policy. You must always
4853 # provide an up-to-date fingerprint hash in order to update or change
4854 # labels.
4855 #
4856 # To see the latest fingerprint, make a getRoutePolicy() request
4857 # to retrieve a Route Policy.
4858 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
4859 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
4860 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
4861 # in order of priority). Order of policies is not retained and might change
4862 # when getting policy later.
4863 {
4864 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
4865 { # Represents a textual expression in the Common Expression Language (CEL)
4866 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4867 # are documented at https://github.com/google/cel-spec.
4868 #
4869 # Example (Comparison):
4870 #
4871 # title: &quot;Summary size limit&quot;
4872 # description: &quot;Determines if a summary is less than 100 chars&quot;
4873 # expression: &quot;document.summary.size() &lt; 100&quot;
4874 #
4875 # Example (Equality):
4876 #
4877 # title: &quot;Requestor is owner&quot;
4878 # description: &quot;Determines if requestor is the document owner&quot;
4879 # expression: &quot;document.owner == request.auth.claims.email&quot;
4880 #
4881 # Example (Logic):
4882 #
4883 # title: &quot;Public documents&quot;
4884 # description: &quot;Determine whether the document should be publicly visible&quot;
4885 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4886 #
4887 # Example (Data Manipulation):
4888 #
4889 # title: &quot;Notification string&quot;
4890 # description: &quot;Create a notification string with a timestamp.&quot;
4891 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4892 #
4893 # The exact variables and functions that may be referenced within an expression
4894 # are determined by the service that evaluates it. See the service
4895 # documentation for additional information.
4896 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4897 # describes the expression, e.g. when hovered over it in a UI.
4898 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4899 # syntax.
4900 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4901 # reporting, e.g. a file name and a position in the file.
4902 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4903 # its purpose. This can be used e.g. in UIs which allow to enter the
4904 # expression.
4905 },
4906 ],
4907 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
4908 # applies. When not set, the term applies to all
4909 # routes.
4910 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4911 # are documented at https://github.com/google/cel-spec.
4912 #
4913 # Example (Comparison):
4914 #
4915 # title: &quot;Summary size limit&quot;
4916 # description: &quot;Determines if a summary is less than 100 chars&quot;
4917 # expression: &quot;document.summary.size() &lt; 100&quot;
4918 #
4919 # Example (Equality):
4920 #
4921 # title: &quot;Requestor is owner&quot;
4922 # description: &quot;Determines if requestor is the document owner&quot;
4923 # expression: &quot;document.owner == request.auth.claims.email&quot;
4924 #
4925 # Example (Logic):
4926 #
4927 # title: &quot;Public documents&quot;
4928 # description: &quot;Determine whether the document should be publicly visible&quot;
4929 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4930 #
4931 # Example (Data Manipulation):
4932 #
4933 # title: &quot;Notification string&quot;
4934 # description: &quot;Create a notification string with a timestamp.&quot;
4935 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4936 #
4937 # The exact variables and functions that may be referenced within an expression
4938 # are determined by the service that evaluates it. See the service
4939 # documentation for additional information.
4940 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4941 # describes the expression, e.g. when hovered over it in a UI.
4942 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4943 # syntax.
4944 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4945 # reporting, e.g. a file name and a position in the file.
4946 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4947 # its purpose. This can be used e.g. in UIs which allow to enter the
4948 # expression.
4949 },
4950 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
4951 # (inclusive) and 2^31 (exclusive), and unique within the list.
4952 },
4953 ],
4954 &quot;type&quot;: &quot;A String&quot;,
4955 },
4956 ],
4957 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
4958 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
4959 &quot;A String&quot;,
4960 ],
4961 &quot;warning&quot;: { # [Output Only] Informational warning message.
4962 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4963 # Engine returns NO_RESULTS_ON_PAGE if there
4964 # are no results in the response.
4965 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4966 # value format. For example:
4967 #
4968 # &quot;data&quot;: [
4969 # {
4970 # &quot;key&quot;: &quot;scope&quot;,
4971 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4972 # }
4973 {
4974 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4975 # returned. For example, for warnings where there are no results in a list
4976 # request for a particular zone, this key might be scope and
4977 # the key value might be the zone name. Other examples might be a key
4978 # indicating a deprecated resource and a suggested replacement, or a
4979 # warning about invalid network settings (for example, if an instance
4980 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4981 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4982 },
4983 ],
4984 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4985 },
4986 }</pre>
4987 </div>
4988
4989 <div class="method">
4990 <code class="details" id="listRoutePolicies_next">listRoutePolicies_next()</code>
4991 <pre>Retrieves the next page of results.
4992
4993 Args:
4994 previous_request: The request for the previous page. (required)
4995 previous_response: The response from the request for the previous page. (required)
4996
4997 Returns:
4998 A request object that you can call &#x27;execute()&#x27; on to request the next
4999 page. Returns None if there are no more items in the collection.
5000 </pre>
5001 </div>
5002
5003 <div class="method">
5004 <code class="details" id="list_next">list_next()</code>
5005 <pre>Retrieves the next page of results.
5006
5007 Args:
5008 previous_request: The request for the previous page. (required)
5009 previous_response: The response from the request for the previous page. (required)
5010
5011 Returns:
5012 A request object that you can call &#x27;execute()&#x27; on to request the next
5013 page. Returns None if there are no more items in the collection.
5014 </pre>
5015 </div>
5016
5017 <div class="method">
5018 <code class="details" id="patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
5019 <pre>Patches the specified Router resource with the data included in the
5020 request. This method supportsPATCH
5021 semantics and usesJSON merge
5022 patch format and processing rules.
5023
5024 Args:
5025 project: string, Project ID for this request. (required)
5026 region: string, Name of the region for this request. (required)
5027 router: string, Name of the Router resource to patch. (required)
5028 body: object, The request body.
5029 The object takes the form of:
5030
5031 { # Represents a Cloud Router resource.
5032 #
5033 # For more information about Cloud Router, read theCloud
5034 # Router overview.
5035 &quot;bgp&quot;: { # BGP information specific to this router.
5036 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
5037 # The options are DEFAULT or CUSTOM.
5038 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
5039 # This field can only be populated if advertise_mode is CUSTOM and
5040 # is advertised to all peers of the router.
5041 # These groups will be advertised in addition to any specified prefixes.
5042 # Leave this field blank to advertise no custom groups.
5043 &quot;A String&quot;,
5044 ],
5045 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
5046 # This field can only be populated if advertise_mode is CUSTOM and
5047 # is advertised to all peers of the router.
5048 # These IP ranges will be advertised in addition to any specified groups.
5049 # Leave this field blank to advertise no custom IP ranges.
5050 { # Description-tagged IP ranges for the router to advertise.
5051 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
5052 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
5053 },
5054 ],
5055 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
5056 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
5057 # value will be fixed for this router resource. All VPN tunnels that link
5058 # to this router will have the same local ASN.
5059 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
5060 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
5061 # least /30, even if the BGP sessions are over IPv6. It must not overlap
5062 # with any IPv4 BGP session ranges.
5063 #
5064 #
5065 # Other vendors commonly call this &quot;router ID&quot;.
5066 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
5067 # sent to the peer.
5068 #
5069 #
5070 # Hold time is three times the interval at which keepalive messages are
5071 # sent, and the hold time is the maximum number of seconds allowed to
5072 # elapse between successive keepalive messages that BGP receives from a
5073 # peer.
5074 #
5075 #
5076 # BGP will use the smaller of either the local hold time value or the
5077 # peer&#x27;s hold time value as the hold time for the BGP connection between
5078 # the two peers.
5079 #
5080 #
5081 # If set, this value must be between 20 and 60. The default is 20.
5082 },
5083 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
5084 # establish BGP peering. This information must specify the peer ASN and
5085 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
5086 {
5087 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
5088 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
5089 # which currently supports the following option:
5090 #
5091 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
5092 # excludes any routes learned for subnets that use
5093 # VPC Network Peering.
5094 #
5095 #
5096 # Note that this field can only be populated if advertise_mode is CUSTOM
5097 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
5098 # These groups are advertised in addition to any specified prefixes.
5099 # Leave this field blank to advertise no custom groups.
5100 &quot;A String&quot;,
5101 ],
5102 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
5103 # This field can only be populated if advertise_mode is CUSTOM and
5104 # overrides the list defined for the router (in the &quot;bgp&quot; message).
5105 # These IP ranges are advertised in addition to any specified groups.
5106 # Leave this field blank to advertise no custom IP ranges.
5107 { # Description-tagged IP ranges for the router to advertise.
5108 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
5109 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
5110 },
5111 ],
5112 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
5113 # than one matching route of maximum length, the routes with the lowest
5114 # priority value win.
5115 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
5116 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
5117 # received from the peer router. The actual value is negotiated between
5118 # the two routers and is equal to the greater of this value and the
5119 # transmit interval of the other router.
5120 #
5121 #
5122 # If set, this value must be between 1000 and 30000.
5123 #
5124 #
5125 # The default is 1000.
5126 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
5127 # transmitted to the peer router. The actual value is negotiated between
5128 # the two routers and is equal to the greater of this value and the
5129 # corresponding receive interval of the other router.
5130 #
5131 #
5132 # If set, this value must be between 1000 and 30000.
5133 #
5134 #
5135 # The default is 1000.
5136 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
5137 # before BFD declares that a peer is unavailable.
5138 #
5139 #
5140 # If set, the value must be a value between 5 and 16.
5141 #
5142 #
5143 # The default is 5.
5144 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
5145 #
5146 #
5147 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
5148 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
5149 # peer router to initiate the BFD session for this BGP peer. If set to
5150 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
5151 },
5152 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
5153 # session.
5154 {
5155 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
5156 # CIDR-formatted prefix. If an IP address is provided without a subnet
5157 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
5158 # range, and, for IPv6, `/128`.
5159 },
5160 ],
5161 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
5162 # value is applied to all custom learned route ranges for the session.
5163 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
5164 # value, Google Cloud assigns a priority of `100` to the ranges.
5165 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
5166 #
5167 #
5168 # If set to FALSE, any active session with the peer is terminated and
5169 # all associated routing information is removed. If set to TRUE, the
5170 # peer connection can be established with routing information. The default
5171 # is TRUE.
5172 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
5173 # the peerIpAddress is version 4.
5174 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
5175 # peerIpAddress is version 6.
5176 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
5177 # evaluated. The name must correspond to an existing policy that has
5178 # ROUTE_POLICY_TYPE_EXPORT type.
5179 &quot;A String&quot;,
5180 ],
5181 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
5182 # evaluated. The name must correspond to an existing policy that has
5183 # ROUTE_POLICY_TYPE_IMPORT type.
5184 &quot;A String&quot;,
5185 ],
5186 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
5187 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
5188 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
5189 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
5190 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
5191 #
5192 # - MANAGED_BY_USER is the default value and can be managed by you
5193 # or other users
5194 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
5195 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
5196 # PARTNER. Google automatically creates, updates, and deletes this type of
5197 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
5198 # or deleted.
5199 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
5200 # name of one of the entries in the Router.md5_authentication_keys. The
5201 # field must comply with RFC1035.
5202 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
5203 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
5204 # characters long and match the regular expression
5205 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
5206 # lowercase letter, and all following characters must be a dash, lowercase
5207 # letter, or digit, except the last character, which cannot be a dash.
5208 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
5209 # a different value.
5210 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
5211 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
5212 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
5213 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
5214 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
5215 # Appliances. The VM instance must be located in zones contained in the
5216 # same region as this Cloud Router.
5217 # The VM instance is the peer side of the BGP session.
5218 },
5219 ],
5220 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5221 # text format.
5222 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5223 # create the resource.
5224 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
5225 # attachments (interconnectAttachments).
5226 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5227 # defined by the server.
5228 &quot;interfaces&quot;: [ # Router interfaces.
5229 # To create a BGP peer that uses a router interface,
5230 # the interface must have one of the following fields specified:
5231 #
5232 # - linkedVpnTunnel
5233 # - linkedInterconnectAttachment
5234 # - subnetwork
5235 #
5236 #
5237 # You can create a router interface without any of these fields specified.
5238 # However, you cannot create a BGP peer that uses that interface.
5239 {
5240 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
5241 #
5242 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
5243 # be a CIDR-formatted string, for example, 169.254.0.1/30.
5244 # Note: Do not truncate the IP address, as it represents the IP address of
5245 # the interface.
5246 # - For Internet Protocol version 6 (IPv6), the value
5247 # must be a unique local address (ULA) range from fdff:1::/64
5248 # with a mask length of 126 or less. This value should be a CIDR-formatted
5249 # string, for example, fdff:1::1/112. Within the router&#x27;s
5250 # VPC, this IPv6 prefix will be reserved exclusively for this connection
5251 # and cannot be used for any other purpose.
5252 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
5253 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
5254 # as the router. Each interface can have one linked resource, which can be
5255 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
5256 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
5257 # router. Each interface can have one linked resource, which can be
5258 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
5259 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
5260 #
5261 # - MANAGED_BY_USER is the default value and can be managed directly
5262 # by users.
5263 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
5264 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
5265 # of type PARTNER. Google automatically creates, updates, and deletes
5266 # this type of interface when the PARTNER InterconnectAttachment is
5267 # created, updated, or deleted.
5268 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
5269 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
5270 # characters long and match the regular expression
5271 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
5272 # lowercase letter, and all following characters must be a dash, lowercase
5273 # letter, or digit, except the last character, which cannot be a dash.
5274 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
5275 # BGP sessions to a VM instance acting as a third-party
5276 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
5277 # an SD-WAN VM.
5278 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
5279 # you are creating. The redundantInterface must belong to the same Cloud
5280 # Router as the interface here. To establish the BGP session to a Router
5281 # Appliance VM, you must create two BGP peers. The two BGP peers must be
5282 # attached to two separate interfaces that are redundant with each other.
5283 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
5284 # be 1-63 characters long and match the regular expression
5285 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
5286 # lowercase letter, and all following characters must be a dash, lowercase
5287 # letter, or digit, except the last character, which cannot be a dash.
5288 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
5289 # must be in the same region as the Cloud Router.
5290 # When you establish a BGP session to a VM instance using this interface,
5291 # the VM instance must belong to the same subnetwork as the subnetwork
5292 # specified here.
5293 },
5294 ],
5295 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
5296 # routers.
5297 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
5298 {
5299 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
5300 #
5301 # For patch and update calls, it can be skipped to
5302 # copy the value from the previous configuration. This is allowed if the
5303 # key with the same name existed before the operation. Maximum length is 80
5304 # characters. Can only contain printable ASCII characters.
5305 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
5306 #
5307 # Must be unique within a router. Must be referenced by exactly
5308 # one bgpPeer. Must comply withRFC1035.
5309 },
5310 ],
5311 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
5312 # The name must be 1-63 characters long, and comply withRFC1035.
5313 # Specifically, the name must be 1-63 characters long and match the regular
5314 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5315 # character must be a lowercase letter, and all following characters must
5316 # be a dash, lowercase letter, or digit, except the last character, which
5317 # cannot be a dash.
5318 &quot;nats&quot;: [ # A list of NAT services created in this router.
5319 { # Represents a Nat resource. It enables the VMs within the specified
5320 # subnetworks to access Internet without external IP addresses. It specifies
5321 # a list of subnetworks (and the ranges within) that want to use NAT.
5322 # Customers can also provide the external IPs that would be used for NAT. GCP
5323 # would auto-allocate ephemeral IPs if no external IPs are provided.
5324 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
5325 # Must be one of: PREMIUM, STANDARD.
5326 # If not specified, then the current
5327 # project-level default tier is used.
5328 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
5329 # must be valid static external IPs that have been assigned to the NAT.
5330 # These IPs should be used for updating/patching a NAT only.
5331 &quot;A String&quot;,
5332 ],
5333 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
5334 # state. This value is equal to tcp_time_wait_timeout_sec.
5335 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
5336 # 120s. The field is output only.
5337 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
5338 #
5339 #
5340 # If not specified, it is disabled by default.
5341 #
5342 #
5343 # If set to true,
5344 #
5345 # - Dynamic Port Allocation will be enabled on this NAT
5346 # config.
5347 # - enableEndpointIndependentMapping cannot be set to true.
5348 # - If minPorts is set, minPortsPerVm must be set to a
5349 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
5350 # minimum of 32 ports will be allocated to a VM from this NAT
5351 # config.
5352 &quot;enableEndpointIndependentMapping&quot;: True or False,
5353 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
5354 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
5355 &quot;A String&quot;,
5356 ],
5357 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
5358 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
5359 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
5360 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
5361 # logs are exported for all connections handled by this NAT.
5362 # This option can take one of the following values:
5363 #
5364 # - ERRORS_ONLY: Export logs only for connection failures.
5365 # - TRANSLATIONS_ONLY: Export logs only for successful
5366 # connections.
5367 # - ALL: Export logs for all connections, successful and
5368 # unsuccessful.
5369 },
5370 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
5371 # Dynamic Port Allocation is enabled.
5372 #
5373 #
5374 # If Dynamic Port Allocation is not enabled, this field has no effect.
5375 #
5376 #
5377 # If Dynamic Port Allocation is enabled, and this field is set, it must be
5378 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
5379 # is not set.
5380 #
5381 #
5382 # If Dynamic Port Allocation is enabled and this field is not set,
5383 # a maximum of 65536 ports will be allocated to a VM from this NAT
5384 # config.
5385 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
5386 # set, a default number of ports is allocated to a VM. This is rounded
5387 # up to the nearest power of 2. For example, if the value of this field is
5388 # 50, at least 64 ports are allocated to a VM.
5389 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
5390 # The name must be 1-63 characters long and comply withRFC1035.
5391 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
5392 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
5393 # selected for the SubnetworkIpRangeToNat64Option above.
5394 { # Specifies a subnetwork to enable NAT64.
5395 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
5396 },
5397 ],
5398 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
5399 # values:
5400 #
5401 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
5402 # customers. When there are not enough specified Nat IPs, the Nat service
5403 # fails for new VMs.
5404 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
5405 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
5406 # be empty.
5407 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
5408 # addresses must be valid static external IP addresses assigned to the
5409 # project.
5410 &quot;A String&quot;,
5411 ],
5412 &quot;rules&quot;: [ # A list of rules associated with this NAT.
5413 {
5414 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
5415 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
5416 # addresses must be valid static external IP addresses assigned to the
5417 # project.
5418 # This field is used for public NAT.
5419 &quot;A String&quot;,
5420 ],
5421 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
5422 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
5423 # This field is used for private NAT.
5424 &quot;A String&quot;,
5425 ],
5426 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
5427 # must be valid static external IPs that have been assigned to the NAT.
5428 # These IPs should be used for updating/patching a NAT rule only.
5429 # This field is used for public NAT.
5430 &quot;A String&quot;,
5431 ],
5432 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
5433 # drained. This is only supported on patch/update, and these
5434 # subnetworks must have previously been used as active ranges in this
5435 # NAT Rule.
5436 # This field is used for private NAT.
5437 &quot;A String&quot;,
5438 ],
5439 },
5440 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
5441 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
5442 # from a VM is evaluated against. If it evaluates to true, the
5443 # corresponding `action` is enforced.
5444 #
5445 # The following examples are valid match expressions for public NAT:
5446 #
5447 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
5448 # &#x27;2.2.0.0/16&#x27;)`
5449 #
5450 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
5451 #
5452 # The following example is a valid match expression for private NAT:
5453 #
5454 # `nexthop.hub ==
5455 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
5456 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
5457 # must be a positive value between 0 and 65000, and
5458 # must be unique among rules within a NAT.
5459 },
5460 ],
5461 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
5462 #
5463 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
5464 # Subnetwork are allowed to Nat.
5465 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
5466 # in every Subnetwork are allowed to Nat.
5467 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
5468 # (specified in the field subnetwork below)
5469 #
5470 #
5471 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
5472 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
5473 # should not be any other Router.Nat section in any Router for this network
5474 # in this region.
5475 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
5476 # values:
5477 #
5478 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
5479 # every Subnetwork are allowed to Nat.
5480 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
5481 # (specified in the field nat64_subnetwork below)
5482 #
5483 #
5484 # The default is NAT64_OPTION_UNSPECIFIED.
5485 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
5486 # Router.Nat section in this region can also enable NAT64 for any
5487 # Subnetworks in this network. Other Router.Nat sections can still be
5488 # present to enable NAT44 only.
5489 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
5490 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
5491 # SubnetworkIpRangeToNatOption above.
5492 { # Defines the IP ranges that want to use NAT for a subnetwork.
5493 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
5494 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
5495 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
5496 # is one of the values in source_ip_ranges_to_nat.
5497 &quot;A String&quot;,
5498 ],
5499 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
5500 # options of a single value are valid except
5501 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
5502 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
5503 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
5504 # Default: [ALL_IP_RANGES]
5505 &quot;A String&quot;,
5506 ],
5507 },
5508 ],
5509 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
5510 # if not set.
5511 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
5512 # Defaults to 120s if not set.
5513 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
5514 # not set.
5515 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
5516 # translation. If unspecified, it defaults to PUBLIC.
5517 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
5518 },
5519 ],
5520 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
5521 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
5522 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
5523 # as part of resource payload.
5524 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
5525 # The field is allowed for INSERT
5526 # only. The keys/values to set on the resource should be specified in
5527 # either ID { : } or Namespaced format
5528 # { : }.
5529 # For example the following are valid inputs:
5530 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
5531 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
5532 # Note:
5533 # * Invalid combinations of ID &amp; namespaced format is not supported. For
5534 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
5535 # * Inconsistent format is not supported. For instance:
5536 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
5537 &quot;a_key&quot;: &quot;A String&quot;,
5538 },
5539 },
5540 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
5541 # You must specify this field as part of the HTTP request URL. It is
5542 # not settable as a field in the request body.
5543 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5544 }
5545
5546 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5547 that if you must retry your request, the server will know to ignore the
5548 request if it has already been completed.
5549
5550 For example, consider a situation where you make an initial request and
5551 the request times out. If you make the request again with the same
5552 request ID, the server can check if original operation with the same
5553 request ID was received, and if so, will ignore the second request. This
5554 prevents clients from accidentally creating duplicate commitments.
5555
5556 The request ID must be
5557 a valid UUID with the exception that zero UUID is not supported
5558 (00000000-0000-0000-0000-000000000000).
5559 x__xgafv: string, V1 error format.
5560 Allowed values
5561 1 - v1 error format
5562 2 - v2 error format
5563
5564 Returns:
5565 An object of the form:
5566
5567 { # Represents an Operation resource.
5568 #
5569 # Google Compute Engine has three Operation resources:
5570 #
5571 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
5572 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
5573 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
5574 #
5575 # You can use an operation resource to manage asynchronous API requests.
5576 # For more information, readHandling
5577 # API responses.
5578 #
5579 # Operations can be global, regional or zonal.
5580 #
5581 # - For global operations, use the `globalOperations`
5582 # resource.
5583 # - For regional operations, use the
5584 # `regionOperations` resource.
5585 # - For zonal operations, use
5586 # the `zoneOperations` resource.
5587 #
5588 #
5589 #
5590 # For more information, read
5591 # Global, Regional, and Zonal Resources.
5592 #
5593 # Note that completed Operation resources have a limited
5594 # retention period.
5595 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5596 # Not present otherwise.
5597 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5598 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5599 # set when the operation is created.
5600 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5601 # text format.
5602 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5603 # this field will be populated.
5604 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5605 # operation.
5606 {
5607 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5608 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5609 # details. There is a set of defined message types to use for providing
5610 # details.The syntax depends on the error code. For example,
5611 # QuotaExceededInfo will have details when the error code is
5612 # QUOTA_EXCEEDED.
5613 {
5614 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5615 #
5616 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5617 # is not enabled:
5618 #
5619 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5620 # &quot;domain&quot;: &quot;googleapis.com&quot;
5621 # &quot;metadata&quot;: {
5622 # &quot;resource&quot;: &quot;projects/123&quot;,
5623 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5624 # }
5625 # }
5626 #
5627 # This response indicates that the pubsub.googleapis.com API is not enabled.
5628 #
5629 # Example of an error that is returned when attempting to create a Spanner
5630 # instance in a region that is out of stock:
5631 #
5632 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5633 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5634 # &quot;metadata&quot;: {
5635 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5636 # }
5637 # }
5638 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5639 # is typically the registered service name of the tool or product that
5640 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5641 # generated by some common infrastructure, the error domain must be a
5642 # globally unique value that identifies the infrastructure. For Google API
5643 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5644 &quot;metadatas&quot;: { # Additional structured details about this error.
5645 #
5646 # Keys must match a regular expression of `a-z+` but should
5647 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5648 # length. When identifying the current value of an exceeded limit, the units
5649 # should be contained in the key, not the value. For example, rather than
5650 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5651 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5652 # instances that can be created in a single (batch) request.
5653 &quot;a_key&quot;: &quot;A String&quot;,
5654 },
5655 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5656 # proximate cause of the error. Error reasons are unique within a particular
5657 # domain of errors. This should be at most 63 characters and match a
5658 # regular expression of `A-Z+[A-Z0-9]`, which represents
5659 # UPPER_SNAKE_CASE.
5660 },
5661 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5662 #
5663 # For example, if a quota check failed with an error indicating the calling
5664 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5665 # directly to the right place in the developer console to flip the bit.
5666 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5667 { # Describes a URL link.
5668 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5669 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5670 },
5671 ],
5672 },
5673 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5674 # which can be attached to an RPC error.
5675 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5676 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5677 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5678 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5679 },
5680 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5681 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5682 &quot;a_key&quot;: &quot;A String&quot;,
5683 },
5684 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5685 # type or metric.
5686 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5687 # or metric.
5688 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5689 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5690 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5691 },
5692 },
5693 ],
5694 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5695 # This property is optional.
5696 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5697 },
5698 ],
5699 },
5700 &quot;getVersionOperationMetadata&quot;: {
5701 &quot;inlineSbomInfo&quot;: {
5702 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5703 # appropriate identifiers.
5704 &quot;a_key&quot;: &quot;A String&quot;,
5705 },
5706 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5707 # identifiers.
5708 &quot;a_key&quot;: &quot;A String&quot;,
5709 },
5710 },
5711 },
5712 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5713 # message that was returned, such as `NOT FOUND`.
5714 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5715 # status code that was returned. For example, a `404` means the
5716 # resource was not found.
5717 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5718 # defined by the server.
5719 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5720 # This value is inRFC3339
5721 # text format.
5722 &quot;instancesBulkInsertOperationMetadata&quot;: {
5723 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5724 # Example key: zones/us-central1-a
5725 &quot;a_key&quot;: {
5726 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5727 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5728 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5729 # error.
5730 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5731 # if the flow is rolling forward or rolling back.
5732 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5733 },
5734 },
5735 },
5736 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5737 # Operation resources.
5738 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5739 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5740 # group of operations results from a `bulkInsert` API request.
5741 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5742 # `update`, or `delete`, and so on.
5743 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5744 # There is no requirement that this be linear or support any granularity of
5745 # operations. This should not be used to guess when the operation will be
5746 # complete. This number should monotonically increase as the operation
5747 # progresses.
5748 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5749 # applicable when performing regional operations.
5750 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5751 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5752 # this field will contain information on all underlying zonal actions and
5753 # their state.
5754 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5755 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5756 # Example key: zones/us-central1-a
5757 &quot;a_key&quot;: {
5758 &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
5759 # populated.
5760 # different programming environments, including REST APIs and RPC APIs. It is
5761 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5762 # three pieces of data: error code, error message, and error details.
5763 #
5764 # You can find out more about this error model and how to work with it in the
5765 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5766 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5767 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5768 # message types for APIs to use.
5769 {
5770 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5771 },
5772 ],
5773 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5774 # user-facing error message should be localized and sent in the
5775 # google.rpc.Status.details field, or localized by the client.
5776 },
5777 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5778 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5779 },
5780 },
5781 },
5782 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5783 # This value is inRFC3339
5784 # text format.
5785 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5786 # following:
5787 # `PENDING`, `RUNNING`, or `DONE`.
5788 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5789 # operation.
5790 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5791 # of the target resource.
5792 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5793 # operations related to creating a snapshot, this points to the disk
5794 # that the snapshot was created from.
5795 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5796 # `[email protected]` or
5797 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5798 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5799 # operation, this field will be populated.
5800 {
5801 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5802 # Engine returns NO_RESULTS_ON_PAGE if there
5803 # are no results in the response.
5804 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5805 # value format. For example:
5806 #
5807 # &quot;data&quot;: [
5808 # {
5809 # &quot;key&quot;: &quot;scope&quot;,
5810 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5811 # }
5812 {
5813 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5814 # returned. For example, for warnings where there are no results in a list
5815 # request for a particular zone, this key might be scope and
5816 # the key value might be the zone name. Other examples might be a key
5817 # indicating a deprecated resource and a suggested replacement, or a
5818 # warning about invalid network settings (for example, if an instance
5819 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5820 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5821 },
5822 ],
5823 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5824 },
5825 ],
5826 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5827 # applicable when performing per-zone operations.
5828 }</pre>
5829 </div>
5830
5831 <div class="method">
5832 <code class="details" id="patchRoutePolicy">patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
5833 <pre>Patches Route Policy
5834
5835 Args:
5836 project: string, Project ID for this request. (required)
5837 region: string, Name of the region for this request. (required)
5838 router: string, Name of the Router resource where Route Policy is defined. (required)
5839 body: object, The request body.
5840 The object takes the form of:
5841
5842 {
5843 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
5844 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
5845 # essentially a hash of the Route Policy used for optimistic locking.
5846 # The fingerprint is initially generated by Compute Engine and changes
5847 # after every request to modify or update Route Policy. You must always
5848 # provide an up-to-date fingerprint hash in order to update or change
5849 # labels.
5850 #
5851 # To see the latest fingerprint, make a getRoutePolicy() request
5852 # to retrieve a Route Policy.
5853 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
5854 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
5855 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
5856 # in order of priority). Order of policies is not retained and might change
5857 # when getting policy later.
5858 {
5859 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
5860 { # Represents a textual expression in the Common Expression Language (CEL)
5861 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5862 # are documented at https://github.com/google/cel-spec.
5863 #
5864 # Example (Comparison):
5865 #
5866 # title: &quot;Summary size limit&quot;
5867 # description: &quot;Determines if a summary is less than 100 chars&quot;
5868 # expression: &quot;document.summary.size() &lt; 100&quot;
5869 #
5870 # Example (Equality):
5871 #
5872 # title: &quot;Requestor is owner&quot;
5873 # description: &quot;Determines if requestor is the document owner&quot;
5874 # expression: &quot;document.owner == request.auth.claims.email&quot;
5875 #
5876 # Example (Logic):
5877 #
5878 # title: &quot;Public documents&quot;
5879 # description: &quot;Determine whether the document should be publicly visible&quot;
5880 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5881 #
5882 # Example (Data Manipulation):
5883 #
5884 # title: &quot;Notification string&quot;
5885 # description: &quot;Create a notification string with a timestamp.&quot;
5886 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5887 #
5888 # The exact variables and functions that may be referenced within an expression
5889 # are determined by the service that evaluates it. See the service
5890 # documentation for additional information.
5891 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5892 # describes the expression, e.g. when hovered over it in a UI.
5893 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5894 # syntax.
5895 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5896 # reporting, e.g. a file name and a position in the file.
5897 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5898 # its purpose. This can be used e.g. in UIs which allow to enter the
5899 # expression.
5900 },
5901 ],
5902 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
5903 # applies. When not set, the term applies to all
5904 # routes.
5905 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5906 # are documented at https://github.com/google/cel-spec.
5907 #
5908 # Example (Comparison):
5909 #
5910 # title: &quot;Summary size limit&quot;
5911 # description: &quot;Determines if a summary is less than 100 chars&quot;
5912 # expression: &quot;document.summary.size() &lt; 100&quot;
5913 #
5914 # Example (Equality):
5915 #
5916 # title: &quot;Requestor is owner&quot;
5917 # description: &quot;Determines if requestor is the document owner&quot;
5918 # expression: &quot;document.owner == request.auth.claims.email&quot;
5919 #
5920 # Example (Logic):
5921 #
5922 # title: &quot;Public documents&quot;
5923 # description: &quot;Determine whether the document should be publicly visible&quot;
5924 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5925 #
5926 # Example (Data Manipulation):
5927 #
5928 # title: &quot;Notification string&quot;
5929 # description: &quot;Create a notification string with a timestamp.&quot;
5930 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5931 #
5932 # The exact variables and functions that may be referenced within an expression
5933 # are determined by the service that evaluates it. See the service
5934 # documentation for additional information.
5935 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5936 # describes the expression, e.g. when hovered over it in a UI.
5937 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5938 # syntax.
5939 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5940 # reporting, e.g. a file name and a position in the file.
5941 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5942 # its purpose. This can be used e.g. in UIs which allow to enter the
5943 # expression.
5944 },
5945 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
5946 # (inclusive) and 2^31 (exclusive), and unique within the list.
5947 },
5948 ],
5949 &quot;type&quot;: &quot;A String&quot;,
5950 }
5951
5952 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5953 that if you must retry your request, the server will know to ignore the
5954 request if it has already been completed.
5955
5956 For example, consider a situation where you make an initial request and
5957 the request times out. If you make the request again with the same
5958 request ID, the server can check if original operation with the same
5959 request ID was received, and if so, will ignore the second request. This
5960 prevents clients from accidentally creating duplicate commitments.
5961
5962 The request ID must be
5963 a valid UUID with the exception that zero UUID is not supported
5964 (00000000-0000-0000-0000-000000000000).
5965 x__xgafv: string, V1 error format.
5966 Allowed values
5967 1 - v1 error format
5968 2 - v2 error format
5969
5970 Returns:
5971 An object of the form:
5972
5973 { # Represents an Operation resource.
5974 #
5975 # Google Compute Engine has three Operation resources:
5976 #
5977 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
5978 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
5979 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
5980 #
5981 # You can use an operation resource to manage asynchronous API requests.
5982 # For more information, readHandling
5983 # API responses.
5984 #
5985 # Operations can be global, regional or zonal.
5986 #
5987 # - For global operations, use the `globalOperations`
5988 # resource.
5989 # - For regional operations, use the
5990 # `regionOperations` resource.
5991 # - For zonal operations, use
5992 # the `zoneOperations` resource.
5993 #
5994 #
5995 #
5996 # For more information, read
5997 # Global, Regional, and Zonal Resources.
5998 #
5999 # Note that completed Operation resources have a limited
6000 # retention period.
6001 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6002 # Not present otherwise.
6003 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6004 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6005 # set when the operation is created.
6006 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6007 # text format.
6008 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6009 # this field will be populated.
6010 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6011 # operation.
6012 {
6013 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6014 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6015 # details. There is a set of defined message types to use for providing
6016 # details.The syntax depends on the error code. For example,
6017 # QuotaExceededInfo will have details when the error code is
6018 # QUOTA_EXCEEDED.
6019 {
6020 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6021 #
6022 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6023 # is not enabled:
6024 #
6025 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6026 # &quot;domain&quot;: &quot;googleapis.com&quot;
6027 # &quot;metadata&quot;: {
6028 # &quot;resource&quot;: &quot;projects/123&quot;,
6029 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6030 # }
6031 # }
6032 #
6033 # This response indicates that the pubsub.googleapis.com API is not enabled.
6034 #
6035 # Example of an error that is returned when attempting to create a Spanner
6036 # instance in a region that is out of stock:
6037 #
6038 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6039 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6040 # &quot;metadata&quot;: {
6041 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6042 # }
6043 # }
6044 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6045 # is typically the registered service name of the tool or product that
6046 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6047 # generated by some common infrastructure, the error domain must be a
6048 # globally unique value that identifies the infrastructure. For Google API
6049 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6050 &quot;metadatas&quot;: { # Additional structured details about this error.
6051 #
6052 # Keys must match a regular expression of `a-z+` but should
6053 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6054 # length. When identifying the current value of an exceeded limit, the units
6055 # should be contained in the key, not the value. For example, rather than
6056 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6057 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6058 # instances that can be created in a single (batch) request.
6059 &quot;a_key&quot;: &quot;A String&quot;,
6060 },
6061 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6062 # proximate cause of the error. Error reasons are unique within a particular
6063 # domain of errors. This should be at most 63 characters and match a
6064 # regular expression of `A-Z+[A-Z0-9]`, which represents
6065 # UPPER_SNAKE_CASE.
6066 },
6067 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6068 #
6069 # For example, if a quota check failed with an error indicating the calling
6070 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6071 # directly to the right place in the developer console to flip the bit.
6072 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6073 { # Describes a URL link.
6074 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6075 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6076 },
6077 ],
6078 },
6079 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6080 # which can be attached to an RPC error.
6081 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6082 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6083 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6084 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6085 },
6086 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6087 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6088 &quot;a_key&quot;: &quot;A String&quot;,
6089 },
6090 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6091 # type or metric.
6092 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6093 # or metric.
6094 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6095 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6096 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6097 },
6098 },
6099 ],
6100 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6101 # This property is optional.
6102 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6103 },
6104 ],
6105 },
6106 &quot;getVersionOperationMetadata&quot;: {
6107 &quot;inlineSbomInfo&quot;: {
6108 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6109 # appropriate identifiers.
6110 &quot;a_key&quot;: &quot;A String&quot;,
6111 },
6112 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6113 # identifiers.
6114 &quot;a_key&quot;: &quot;A String&quot;,
6115 },
6116 },
6117 },
6118 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6119 # message that was returned, such as `NOT FOUND`.
6120 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6121 # status code that was returned. For example, a `404` means the
6122 # resource was not found.
6123 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6124 # defined by the server.
6125 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6126 # This value is inRFC3339
6127 # text format.
6128 &quot;instancesBulkInsertOperationMetadata&quot;: {
6129 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6130 # Example key: zones/us-central1-a
6131 &quot;a_key&quot;: {
6132 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6133 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6134 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6135 # error.
6136 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6137 # if the flow is rolling forward or rolling back.
6138 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6139 },
6140 },
6141 },
6142 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6143 # Operation resources.
6144 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6145 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6146 # group of operations results from a `bulkInsert` API request.
6147 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6148 # `update`, or `delete`, and so on.
6149 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6150 # There is no requirement that this be linear or support any granularity of
6151 # operations. This should not be used to guess when the operation will be
6152 # complete. This number should monotonically increase as the operation
6153 # progresses.
6154 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6155 # applicable when performing regional operations.
6156 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6157 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6158 # this field will contain information on all underlying zonal actions and
6159 # their state.
6160 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6161 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6162 # Example key: zones/us-central1-a
6163 &quot;a_key&quot;: {
6164 &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
6165 # populated.
6166 # different programming environments, including REST APIs and RPC APIs. It is
6167 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6168 # three pieces of data: error code, error message, and error details.
6169 #
6170 # You can find out more about this error model and how to work with it in the
6171 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6172 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6173 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6174 # message types for APIs to use.
6175 {
6176 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6177 },
6178 ],
6179 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6180 # user-facing error message should be localized and sent in the
6181 # google.rpc.Status.details field, or localized by the client.
6182 },
6183 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6184 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6185 },
6186 },
6187 },
6188 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6189 # This value is inRFC3339
6190 # text format.
6191 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6192 # following:
6193 # `PENDING`, `RUNNING`, or `DONE`.
6194 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6195 # operation.
6196 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6197 # of the target resource.
6198 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6199 # operations related to creating a snapshot, this points to the disk
6200 # that the snapshot was created from.
6201 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6202 # `[email protected]` or
6203 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6204 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6205 # operation, this field will be populated.
6206 {
6207 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6208 # Engine returns NO_RESULTS_ON_PAGE if there
6209 # are no results in the response.
6210 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6211 # value format. For example:
6212 #
6213 # &quot;data&quot;: [
6214 # {
6215 # &quot;key&quot;: &quot;scope&quot;,
6216 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6217 # }
6218 {
6219 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6220 # returned. For example, for warnings where there are no results in a list
6221 # request for a particular zone, this key might be scope and
6222 # the key value might be the zone name. Other examples might be a key
6223 # indicating a deprecated resource and a suggested replacement, or a
6224 # warning about invalid network settings (for example, if an instance
6225 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6226 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6227 },
6228 ],
6229 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6230 },
6231 ],
6232 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6233 # applicable when performing per-zone operations.
6234 }</pre>
6235 </div>
6236
6237 <div class="method">
6238 <code class="details" id="preview">preview(project, region, router, body=None, x__xgafv=None)</code>
6239 <pre>Preview fields auto-generated during router create andupdate operations.
6240 Calling this method does NOT create or update the router.
6241
6242 Args:
6243 project: string, Project ID for this request. (required)
6244 region: string, Name of the region for this request. (required)
6245 router: string, Name of the Router resource to query. (required)
6246 body: object, The request body.
6247 The object takes the form of:
6248
6249 { # Represents a Cloud Router resource.
6250 #
6251 # For more information about Cloud Router, read theCloud
6252 # Router overview.
6253 &quot;bgp&quot;: { # BGP information specific to this router.
6254 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
6255 # The options are DEFAULT or CUSTOM.
6256 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
6257 # This field can only be populated if advertise_mode is CUSTOM and
6258 # is advertised to all peers of the router.
6259 # These groups will be advertised in addition to any specified prefixes.
6260 # Leave this field blank to advertise no custom groups.
6261 &quot;A String&quot;,
6262 ],
6263 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
6264 # This field can only be populated if advertise_mode is CUSTOM and
6265 # is advertised to all peers of the router.
6266 # These IP ranges will be advertised in addition to any specified groups.
6267 # Leave this field blank to advertise no custom IP ranges.
6268 { # Description-tagged IP ranges for the router to advertise.
6269 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
6270 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
6271 },
6272 ],
6273 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
6274 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
6275 # value will be fixed for this router resource. All VPN tunnels that link
6276 # to this router will have the same local ASN.
6277 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
6278 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
6279 # least /30, even if the BGP sessions are over IPv6. It must not overlap
6280 # with any IPv4 BGP session ranges.
6281 #
6282 #
6283 # Other vendors commonly call this &quot;router ID&quot;.
6284 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
6285 # sent to the peer.
6286 #
6287 #
6288 # Hold time is three times the interval at which keepalive messages are
6289 # sent, and the hold time is the maximum number of seconds allowed to
6290 # elapse between successive keepalive messages that BGP receives from a
6291 # peer.
6292 #
6293 #
6294 # BGP will use the smaller of either the local hold time value or the
6295 # peer&#x27;s hold time value as the hold time for the BGP connection between
6296 # the two peers.
6297 #
6298 #
6299 # If set, this value must be between 20 and 60. The default is 20.
6300 },
6301 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
6302 # establish BGP peering. This information must specify the peer ASN and
6303 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
6304 {
6305 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
6306 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
6307 # which currently supports the following option:
6308 #
6309 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
6310 # excludes any routes learned for subnets that use
6311 # VPC Network Peering.
6312 #
6313 #
6314 # Note that this field can only be populated if advertise_mode is CUSTOM
6315 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
6316 # These groups are advertised in addition to any specified prefixes.
6317 # Leave this field blank to advertise no custom groups.
6318 &quot;A String&quot;,
6319 ],
6320 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
6321 # This field can only be populated if advertise_mode is CUSTOM and
6322 # overrides the list defined for the router (in the &quot;bgp&quot; message).
6323 # These IP ranges are advertised in addition to any specified groups.
6324 # Leave this field blank to advertise no custom IP ranges.
6325 { # Description-tagged IP ranges for the router to advertise.
6326 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
6327 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
6328 },
6329 ],
6330 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
6331 # than one matching route of maximum length, the routes with the lowest
6332 # priority value win.
6333 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
6334 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
6335 # received from the peer router. The actual value is negotiated between
6336 # the two routers and is equal to the greater of this value and the
6337 # transmit interval of the other router.
6338 #
6339 #
6340 # If set, this value must be between 1000 and 30000.
6341 #
6342 #
6343 # The default is 1000.
6344 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
6345 # transmitted to the peer router. The actual value is negotiated between
6346 # the two routers and is equal to the greater of this value and the
6347 # corresponding receive interval of the other router.
6348 #
6349 #
6350 # If set, this value must be between 1000 and 30000.
6351 #
6352 #
6353 # The default is 1000.
6354 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
6355 # before BFD declares that a peer is unavailable.
6356 #
6357 #
6358 # If set, the value must be a value between 5 and 16.
6359 #
6360 #
6361 # The default is 5.
6362 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
6363 #
6364 #
6365 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
6366 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
6367 # peer router to initiate the BFD session for this BGP peer. If set to
6368 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
6369 },
6370 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
6371 # session.
6372 {
6373 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
6374 # CIDR-formatted prefix. If an IP address is provided without a subnet
6375 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
6376 # range, and, for IPv6, `/128`.
6377 },
6378 ],
6379 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
6380 # value is applied to all custom learned route ranges for the session.
6381 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
6382 # value, Google Cloud assigns a priority of `100` to the ranges.
6383 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
6384 #
6385 #
6386 # If set to FALSE, any active session with the peer is terminated and
6387 # all associated routing information is removed. If set to TRUE, the
6388 # peer connection can be established with routing information. The default
6389 # is TRUE.
6390 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
6391 # the peerIpAddress is version 4.
6392 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
6393 # peerIpAddress is version 6.
6394 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
6395 # evaluated. The name must correspond to an existing policy that has
6396 # ROUTE_POLICY_TYPE_EXPORT type.
6397 &quot;A String&quot;,
6398 ],
6399 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
6400 # evaluated. The name must correspond to an existing policy that has
6401 # ROUTE_POLICY_TYPE_IMPORT type.
6402 &quot;A String&quot;,
6403 ],
6404 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
6405 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
6406 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
6407 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
6408 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
6409 #
6410 # - MANAGED_BY_USER is the default value and can be managed by you
6411 # or other users
6412 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
6413 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
6414 # PARTNER. Google automatically creates, updates, and deletes this type of
6415 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
6416 # or deleted.
6417 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
6418 # name of one of the entries in the Router.md5_authentication_keys. The
6419 # field must comply with RFC1035.
6420 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
6421 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
6422 # characters long and match the regular expression
6423 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
6424 # lowercase letter, and all following characters must be a dash, lowercase
6425 # letter, or digit, except the last character, which cannot be a dash.
6426 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
6427 # a different value.
6428 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
6429 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
6430 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
6431 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
6432 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
6433 # Appliances. The VM instance must be located in zones contained in the
6434 # same region as this Cloud Router.
6435 # The VM instance is the peer side of the BGP session.
6436 },
6437 ],
6438 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
6439 # text format.
6440 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6441 # create the resource.
6442 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
6443 # attachments (interconnectAttachments).
6444 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
6445 # defined by the server.
6446 &quot;interfaces&quot;: [ # Router interfaces.
6447 # To create a BGP peer that uses a router interface,
6448 # the interface must have one of the following fields specified:
6449 #
6450 # - linkedVpnTunnel
6451 # - linkedInterconnectAttachment
6452 # - subnetwork
6453 #
6454 #
6455 # You can create a router interface without any of these fields specified.
6456 # However, you cannot create a BGP peer that uses that interface.
6457 {
6458 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
6459 #
6460 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
6461 # be a CIDR-formatted string, for example, 169.254.0.1/30.
6462 # Note: Do not truncate the IP address, as it represents the IP address of
6463 # the interface.
6464 # - For Internet Protocol version 6 (IPv6), the value
6465 # must be a unique local address (ULA) range from fdff:1::/64
6466 # with a mask length of 126 or less. This value should be a CIDR-formatted
6467 # string, for example, fdff:1::1/112. Within the router&#x27;s
6468 # VPC, this IPv6 prefix will be reserved exclusively for this connection
6469 # and cannot be used for any other purpose.
6470 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
6471 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
6472 # as the router. Each interface can have one linked resource, which can be
6473 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
6474 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
6475 # router. Each interface can have one linked resource, which can be
6476 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
6477 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
6478 #
6479 # - MANAGED_BY_USER is the default value and can be managed directly
6480 # by users.
6481 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
6482 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
6483 # of type PARTNER. Google automatically creates, updates, and deletes
6484 # this type of interface when the PARTNER InterconnectAttachment is
6485 # created, updated, or deleted.
6486 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
6487 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
6488 # characters long and match the regular expression
6489 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
6490 # lowercase letter, and all following characters must be a dash, lowercase
6491 # letter, or digit, except the last character, which cannot be a dash.
6492 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
6493 # BGP sessions to a VM instance acting as a third-party
6494 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
6495 # an SD-WAN VM.
6496 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
6497 # you are creating. The redundantInterface must belong to the same Cloud
6498 # Router as the interface here. To establish the BGP session to a Router
6499 # Appliance VM, you must create two BGP peers. The two BGP peers must be
6500 # attached to two separate interfaces that are redundant with each other.
6501 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
6502 # be 1-63 characters long and match the regular expression
6503 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
6504 # lowercase letter, and all following characters must be a dash, lowercase
6505 # letter, or digit, except the last character, which cannot be a dash.
6506 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
6507 # must be in the same region as the Cloud Router.
6508 # When you establish a BGP session to a VM instance using this interface,
6509 # the VM instance must belong to the same subnetwork as the subnetwork
6510 # specified here.
6511 },
6512 ],
6513 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
6514 # routers.
6515 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
6516 {
6517 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
6518 #
6519 # For patch and update calls, it can be skipped to
6520 # copy the value from the previous configuration. This is allowed if the
6521 # key with the same name existed before the operation. Maximum length is 80
6522 # characters. Can only contain printable ASCII characters.
6523 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
6524 #
6525 # Must be unique within a router. Must be referenced by exactly
6526 # one bgpPeer. Must comply withRFC1035.
6527 },
6528 ],
6529 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
6530 # The name must be 1-63 characters long, and comply withRFC1035.
6531 # Specifically, the name must be 1-63 characters long and match the regular
6532 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
6533 # character must be a lowercase letter, and all following characters must
6534 # be a dash, lowercase letter, or digit, except the last character, which
6535 # cannot be a dash.
6536 &quot;nats&quot;: [ # A list of NAT services created in this router.
6537 { # Represents a Nat resource. It enables the VMs within the specified
6538 # subnetworks to access Internet without external IP addresses. It specifies
6539 # a list of subnetworks (and the ranges within) that want to use NAT.
6540 # Customers can also provide the external IPs that would be used for NAT. GCP
6541 # would auto-allocate ephemeral IPs if no external IPs are provided.
6542 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
6543 # Must be one of: PREMIUM, STANDARD.
6544 # If not specified, then the current
6545 # project-level default tier is used.
6546 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
6547 # must be valid static external IPs that have been assigned to the NAT.
6548 # These IPs should be used for updating/patching a NAT only.
6549 &quot;A String&quot;,
6550 ],
6551 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
6552 # state. This value is equal to tcp_time_wait_timeout_sec.
6553 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
6554 # 120s. The field is output only.
6555 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
6556 #
6557 #
6558 # If not specified, it is disabled by default.
6559 #
6560 #
6561 # If set to true,
6562 #
6563 # - Dynamic Port Allocation will be enabled on this NAT
6564 # config.
6565 # - enableEndpointIndependentMapping cannot be set to true.
6566 # - If minPorts is set, minPortsPerVm must be set to a
6567 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
6568 # minimum of 32 ports will be allocated to a VM from this NAT
6569 # config.
6570 &quot;enableEndpointIndependentMapping&quot;: True or False,
6571 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
6572 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
6573 &quot;A String&quot;,
6574 ],
6575 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
6576 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
6577 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
6578 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
6579 # logs are exported for all connections handled by this NAT.
6580 # This option can take one of the following values:
6581 #
6582 # - ERRORS_ONLY: Export logs only for connection failures.
6583 # - TRANSLATIONS_ONLY: Export logs only for successful
6584 # connections.
6585 # - ALL: Export logs for all connections, successful and
6586 # unsuccessful.
6587 },
6588 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
6589 # Dynamic Port Allocation is enabled.
6590 #
6591 #
6592 # If Dynamic Port Allocation is not enabled, this field has no effect.
6593 #
6594 #
6595 # If Dynamic Port Allocation is enabled, and this field is set, it must be
6596 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
6597 # is not set.
6598 #
6599 #
6600 # If Dynamic Port Allocation is enabled and this field is not set,
6601 # a maximum of 65536 ports will be allocated to a VM from this NAT
6602 # config.
6603 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
6604 # set, a default number of ports is allocated to a VM. This is rounded
6605 # up to the nearest power of 2. For example, if the value of this field is
6606 # 50, at least 64 ports are allocated to a VM.
6607 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
6608 # The name must be 1-63 characters long and comply withRFC1035.
6609 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
6610 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
6611 # selected for the SubnetworkIpRangeToNat64Option above.
6612 { # Specifies a subnetwork to enable NAT64.
6613 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
6614 },
6615 ],
6616 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
6617 # values:
6618 #
6619 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
6620 # customers. When there are not enough specified Nat IPs, the Nat service
6621 # fails for new VMs.
6622 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
6623 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
6624 # be empty.
6625 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
6626 # addresses must be valid static external IP addresses assigned to the
6627 # project.
6628 &quot;A String&quot;,
6629 ],
6630 &quot;rules&quot;: [ # A list of rules associated with this NAT.
6631 {
6632 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
6633 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
6634 # addresses must be valid static external IP addresses assigned to the
6635 # project.
6636 # This field is used for public NAT.
6637 &quot;A String&quot;,
6638 ],
6639 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
6640 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
6641 # This field is used for private NAT.
6642 &quot;A String&quot;,
6643 ],
6644 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
6645 # must be valid static external IPs that have been assigned to the NAT.
6646 # These IPs should be used for updating/patching a NAT rule only.
6647 # This field is used for public NAT.
6648 &quot;A String&quot;,
6649 ],
6650 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
6651 # drained. This is only supported on patch/update, and these
6652 # subnetworks must have previously been used as active ranges in this
6653 # NAT Rule.
6654 # This field is used for private NAT.
6655 &quot;A String&quot;,
6656 ],
6657 },
6658 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
6659 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
6660 # from a VM is evaluated against. If it evaluates to true, the
6661 # corresponding `action` is enforced.
6662 #
6663 # The following examples are valid match expressions for public NAT:
6664 #
6665 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
6666 # &#x27;2.2.0.0/16&#x27;)`
6667 #
6668 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
6669 #
6670 # The following example is a valid match expression for private NAT:
6671 #
6672 # `nexthop.hub ==
6673 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
6674 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
6675 # must be a positive value between 0 and 65000, and
6676 # must be unique among rules within a NAT.
6677 },
6678 ],
6679 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
6680 #
6681 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
6682 # Subnetwork are allowed to Nat.
6683 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
6684 # in every Subnetwork are allowed to Nat.
6685 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
6686 # (specified in the field subnetwork below)
6687 #
6688 #
6689 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
6690 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
6691 # should not be any other Router.Nat section in any Router for this network
6692 # in this region.
6693 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
6694 # values:
6695 #
6696 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
6697 # every Subnetwork are allowed to Nat.
6698 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
6699 # (specified in the field nat64_subnetwork below)
6700 #
6701 #
6702 # The default is NAT64_OPTION_UNSPECIFIED.
6703 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
6704 # Router.Nat section in this region can also enable NAT64 for any
6705 # Subnetworks in this network. Other Router.Nat sections can still be
6706 # present to enable NAT44 only.
6707 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
6708 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
6709 # SubnetworkIpRangeToNatOption above.
6710 { # Defines the IP ranges that want to use NAT for a subnetwork.
6711 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
6712 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
6713 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
6714 # is one of the values in source_ip_ranges_to_nat.
6715 &quot;A String&quot;,
6716 ],
6717 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
6718 # options of a single value are valid except
6719 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
6720 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
6721 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
6722 # Default: [ALL_IP_RANGES]
6723 &quot;A String&quot;,
6724 ],
6725 },
6726 ],
6727 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
6728 # if not set.
6729 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
6730 # Defaults to 120s if not set.
6731 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
6732 # not set.
6733 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
6734 # translation. If unspecified, it defaults to PUBLIC.
6735 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
6736 },
6737 ],
6738 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
6739 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
6740 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
6741 # as part of resource payload.
6742 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
6743 # The field is allowed for INSERT
6744 # only. The keys/values to set on the resource should be specified in
6745 # either ID { : } or Namespaced format
6746 # { : }.
6747 # For example the following are valid inputs:
6748 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
6749 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
6750 # Note:
6751 # * Invalid combinations of ID &amp; namespaced format is not supported. For
6752 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
6753 # * Inconsistent format is not supported. For instance:
6754 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
6755 &quot;a_key&quot;: &quot;A String&quot;,
6756 },
6757 },
6758 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
6759 # You must specify this field as part of the HTTP request URL. It is
6760 # not settable as a field in the request body.
6761 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6762 }
6763
6764 x__xgafv: string, V1 error format.
6765 Allowed values
6766 1 - v1 error format
6767 2 - v2 error format
6768
6769 Returns:
6770 An object of the form:
6771
6772 {
6773 &quot;resource&quot;: { # Represents a Cloud Router resource. # Preview of given router.
6774 #
6775 # For more information about Cloud Router, read theCloud
6776 # Router overview.
6777 &quot;bgp&quot;: { # BGP information specific to this router.
6778 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
6779 # The options are DEFAULT or CUSTOM.
6780 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
6781 # This field can only be populated if advertise_mode is CUSTOM and
6782 # is advertised to all peers of the router.
6783 # These groups will be advertised in addition to any specified prefixes.
6784 # Leave this field blank to advertise no custom groups.
6785 &quot;A String&quot;,
6786 ],
6787 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
6788 # This field can only be populated if advertise_mode is CUSTOM and
6789 # is advertised to all peers of the router.
6790 # These IP ranges will be advertised in addition to any specified groups.
6791 # Leave this field blank to advertise no custom IP ranges.
6792 { # Description-tagged IP ranges for the router to advertise.
6793 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
6794 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
6795 },
6796 ],
6797 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
6798 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
6799 # value will be fixed for this router resource. All VPN tunnels that link
6800 # to this router will have the same local ASN.
6801 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
6802 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
6803 # least /30, even if the BGP sessions are over IPv6. It must not overlap
6804 # with any IPv4 BGP session ranges.
6805 #
6806 #
6807 # Other vendors commonly call this &quot;router ID&quot;.
6808 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
6809 # sent to the peer.
6810 #
6811 #
6812 # Hold time is three times the interval at which keepalive messages are
6813 # sent, and the hold time is the maximum number of seconds allowed to
6814 # elapse between successive keepalive messages that BGP receives from a
6815 # peer.
6816 #
6817 #
6818 # BGP will use the smaller of either the local hold time value or the
6819 # peer&#x27;s hold time value as the hold time for the BGP connection between
6820 # the two peers.
6821 #
6822 #
6823 # If set, this value must be between 20 and 60. The default is 20.
6824 },
6825 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
6826 # establish BGP peering. This information must specify the peer ASN and
6827 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
6828 {
6829 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
6830 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
6831 # which currently supports the following option:
6832 #
6833 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
6834 # excludes any routes learned for subnets that use
6835 # VPC Network Peering.
6836 #
6837 #
6838 # Note that this field can only be populated if advertise_mode is CUSTOM
6839 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
6840 # These groups are advertised in addition to any specified prefixes.
6841 # Leave this field blank to advertise no custom groups.
6842 &quot;A String&quot;,
6843 ],
6844 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
6845 # This field can only be populated if advertise_mode is CUSTOM and
6846 # overrides the list defined for the router (in the &quot;bgp&quot; message).
6847 # These IP ranges are advertised in addition to any specified groups.
6848 # Leave this field blank to advertise no custom IP ranges.
6849 { # Description-tagged IP ranges for the router to advertise.
6850 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
6851 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
6852 },
6853 ],
6854 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
6855 # than one matching route of maximum length, the routes with the lowest
6856 # priority value win.
6857 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
6858 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
6859 # received from the peer router. The actual value is negotiated between
6860 # the two routers and is equal to the greater of this value and the
6861 # transmit interval of the other router.
6862 #
6863 #
6864 # If set, this value must be between 1000 and 30000.
6865 #
6866 #
6867 # The default is 1000.
6868 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
6869 # transmitted to the peer router. The actual value is negotiated between
6870 # the two routers and is equal to the greater of this value and the
6871 # corresponding receive interval of the other router.
6872 #
6873 #
6874 # If set, this value must be between 1000 and 30000.
6875 #
6876 #
6877 # The default is 1000.
6878 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
6879 # before BFD declares that a peer is unavailable.
6880 #
6881 #
6882 # If set, the value must be a value between 5 and 16.
6883 #
6884 #
6885 # The default is 5.
6886 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
6887 #
6888 #
6889 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
6890 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
6891 # peer router to initiate the BFD session for this BGP peer. If set to
6892 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
6893 },
6894 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
6895 # session.
6896 {
6897 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
6898 # CIDR-formatted prefix. If an IP address is provided without a subnet
6899 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
6900 # range, and, for IPv6, `/128`.
6901 },
6902 ],
6903 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
6904 # value is applied to all custom learned route ranges for the session.
6905 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
6906 # value, Google Cloud assigns a priority of `100` to the ranges.
6907 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
6908 #
6909 #
6910 # If set to FALSE, any active session with the peer is terminated and
6911 # all associated routing information is removed. If set to TRUE, the
6912 # peer connection can be established with routing information. The default
6913 # is TRUE.
6914 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
6915 # the peerIpAddress is version 4.
6916 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
6917 # peerIpAddress is version 6.
6918 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
6919 # evaluated. The name must correspond to an existing policy that has
6920 # ROUTE_POLICY_TYPE_EXPORT type.
6921 &quot;A String&quot;,
6922 ],
6923 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
6924 # evaluated. The name must correspond to an existing policy that has
6925 # ROUTE_POLICY_TYPE_IMPORT type.
6926 &quot;A String&quot;,
6927 ],
6928 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
6929 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
6930 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
6931 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
6932 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
6933 #
6934 # - MANAGED_BY_USER is the default value and can be managed by you
6935 # or other users
6936 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
6937 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
6938 # PARTNER. Google automatically creates, updates, and deletes this type of
6939 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
6940 # or deleted.
6941 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
6942 # name of one of the entries in the Router.md5_authentication_keys. The
6943 # field must comply with RFC1035.
6944 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
6945 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
6946 # characters long and match the regular expression
6947 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
6948 # lowercase letter, and all following characters must be a dash, lowercase
6949 # letter, or digit, except the last character, which cannot be a dash.
6950 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
6951 # a different value.
6952 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
6953 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
6954 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
6955 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
6956 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
6957 # Appliances. The VM instance must be located in zones contained in the
6958 # same region as this Cloud Router.
6959 # The VM instance is the peer side of the BGP session.
6960 },
6961 ],
6962 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
6963 # text format.
6964 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6965 # create the resource.
6966 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
6967 # attachments (interconnectAttachments).
6968 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
6969 # defined by the server.
6970 &quot;interfaces&quot;: [ # Router interfaces.
6971 # To create a BGP peer that uses a router interface,
6972 # the interface must have one of the following fields specified:
6973 #
6974 # - linkedVpnTunnel
6975 # - linkedInterconnectAttachment
6976 # - subnetwork
6977 #
6978 #
6979 # You can create a router interface without any of these fields specified.
6980 # However, you cannot create a BGP peer that uses that interface.
6981 {
6982 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
6983 #
6984 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
6985 # be a CIDR-formatted string, for example, 169.254.0.1/30.
6986 # Note: Do not truncate the IP address, as it represents the IP address of
6987 # the interface.
6988 # - For Internet Protocol version 6 (IPv6), the value
6989 # must be a unique local address (ULA) range from fdff:1::/64
6990 # with a mask length of 126 or less. This value should be a CIDR-formatted
6991 # string, for example, fdff:1::1/112. Within the router&#x27;s
6992 # VPC, this IPv6 prefix will be reserved exclusively for this connection
6993 # and cannot be used for any other purpose.
6994 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
6995 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
6996 # as the router. Each interface can have one linked resource, which can be
6997 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
6998 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
6999 # router. Each interface can have one linked resource, which can be
7000 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
7001 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
7002 #
7003 # - MANAGED_BY_USER is the default value and can be managed directly
7004 # by users.
7005 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
7006 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
7007 # of type PARTNER. Google automatically creates, updates, and deletes
7008 # this type of interface when the PARTNER InterconnectAttachment is
7009 # created, updated, or deleted.
7010 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
7011 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
7012 # characters long and match the regular expression
7013 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7014 # lowercase letter, and all following characters must be a dash, lowercase
7015 # letter, or digit, except the last character, which cannot be a dash.
7016 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
7017 # BGP sessions to a VM instance acting as a third-party
7018 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
7019 # an SD-WAN VM.
7020 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
7021 # you are creating. The redundantInterface must belong to the same Cloud
7022 # Router as the interface here. To establish the BGP session to a Router
7023 # Appliance VM, you must create two BGP peers. The two BGP peers must be
7024 # attached to two separate interfaces that are redundant with each other.
7025 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
7026 # be 1-63 characters long and match the regular expression
7027 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7028 # lowercase letter, and all following characters must be a dash, lowercase
7029 # letter, or digit, except the last character, which cannot be a dash.
7030 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
7031 # must be in the same region as the Cloud Router.
7032 # When you establish a BGP session to a VM instance using this interface,
7033 # the VM instance must belong to the same subnetwork as the subnetwork
7034 # specified here.
7035 },
7036 ],
7037 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
7038 # routers.
7039 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
7040 {
7041 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
7042 #
7043 # For patch and update calls, it can be skipped to
7044 # copy the value from the previous configuration. This is allowed if the
7045 # key with the same name existed before the operation. Maximum length is 80
7046 # characters. Can only contain printable ASCII characters.
7047 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
7048 #
7049 # Must be unique within a router. Must be referenced by exactly
7050 # one bgpPeer. Must comply withRFC1035.
7051 },
7052 ],
7053 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
7054 # The name must be 1-63 characters long, and comply withRFC1035.
7055 # Specifically, the name must be 1-63 characters long and match the regular
7056 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7057 # character must be a lowercase letter, and all following characters must
7058 # be a dash, lowercase letter, or digit, except the last character, which
7059 # cannot be a dash.
7060 &quot;nats&quot;: [ # A list of NAT services created in this router.
7061 { # Represents a Nat resource. It enables the VMs within the specified
7062 # subnetworks to access Internet without external IP addresses. It specifies
7063 # a list of subnetworks (and the ranges within) that want to use NAT.
7064 # Customers can also provide the external IPs that would be used for NAT. GCP
7065 # would auto-allocate ephemeral IPs if no external IPs are provided.
7066 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
7067 # Must be one of: PREMIUM, STANDARD.
7068 # If not specified, then the current
7069 # project-level default tier is used.
7070 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
7071 # must be valid static external IPs that have been assigned to the NAT.
7072 # These IPs should be used for updating/patching a NAT only.
7073 &quot;A String&quot;,
7074 ],
7075 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
7076 # state. This value is equal to tcp_time_wait_timeout_sec.
7077 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
7078 # 120s. The field is output only.
7079 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
7080 #
7081 #
7082 # If not specified, it is disabled by default.
7083 #
7084 #
7085 # If set to true,
7086 #
7087 # - Dynamic Port Allocation will be enabled on this NAT
7088 # config.
7089 # - enableEndpointIndependentMapping cannot be set to true.
7090 # - If minPorts is set, minPortsPerVm must be set to a
7091 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
7092 # minimum of 32 ports will be allocated to a VM from this NAT
7093 # config.
7094 &quot;enableEndpointIndependentMapping&quot;: True or False,
7095 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
7096 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
7097 &quot;A String&quot;,
7098 ],
7099 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
7100 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
7101 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
7102 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
7103 # logs are exported for all connections handled by this NAT.
7104 # This option can take one of the following values:
7105 #
7106 # - ERRORS_ONLY: Export logs only for connection failures.
7107 # - TRANSLATIONS_ONLY: Export logs only for successful
7108 # connections.
7109 # - ALL: Export logs for all connections, successful and
7110 # unsuccessful.
7111 },
7112 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
7113 # Dynamic Port Allocation is enabled.
7114 #
7115 #
7116 # If Dynamic Port Allocation is not enabled, this field has no effect.
7117 #
7118 #
7119 # If Dynamic Port Allocation is enabled, and this field is set, it must be
7120 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
7121 # is not set.
7122 #
7123 #
7124 # If Dynamic Port Allocation is enabled and this field is not set,
7125 # a maximum of 65536 ports will be allocated to a VM from this NAT
7126 # config.
7127 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
7128 # set, a default number of ports is allocated to a VM. This is rounded
7129 # up to the nearest power of 2. For example, if the value of this field is
7130 # 50, at least 64 ports are allocated to a VM.
7131 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
7132 # The name must be 1-63 characters long and comply withRFC1035.
7133 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
7134 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
7135 # selected for the SubnetworkIpRangeToNat64Option above.
7136 { # Specifies a subnetwork to enable NAT64.
7137 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
7138 },
7139 ],
7140 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
7141 # values:
7142 #
7143 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
7144 # customers. When there are not enough specified Nat IPs, the Nat service
7145 # fails for new VMs.
7146 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
7147 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
7148 # be empty.
7149 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
7150 # addresses must be valid static external IP addresses assigned to the
7151 # project.
7152 &quot;A String&quot;,
7153 ],
7154 &quot;rules&quot;: [ # A list of rules associated with this NAT.
7155 {
7156 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
7157 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
7158 # addresses must be valid static external IP addresses assigned to the
7159 # project.
7160 # This field is used for public NAT.
7161 &quot;A String&quot;,
7162 ],
7163 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
7164 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
7165 # This field is used for private NAT.
7166 &quot;A String&quot;,
7167 ],
7168 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
7169 # must be valid static external IPs that have been assigned to the NAT.
7170 # These IPs should be used for updating/patching a NAT rule only.
7171 # This field is used for public NAT.
7172 &quot;A String&quot;,
7173 ],
7174 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
7175 # drained. This is only supported on patch/update, and these
7176 # subnetworks must have previously been used as active ranges in this
7177 # NAT Rule.
7178 # This field is used for private NAT.
7179 &quot;A String&quot;,
7180 ],
7181 },
7182 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
7183 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
7184 # from a VM is evaluated against. If it evaluates to true, the
7185 # corresponding `action` is enforced.
7186 #
7187 # The following examples are valid match expressions for public NAT:
7188 #
7189 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
7190 # &#x27;2.2.0.0/16&#x27;)`
7191 #
7192 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
7193 #
7194 # The following example is a valid match expression for private NAT:
7195 #
7196 # `nexthop.hub ==
7197 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
7198 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
7199 # must be a positive value between 0 and 65000, and
7200 # must be unique among rules within a NAT.
7201 },
7202 ],
7203 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
7204 #
7205 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
7206 # Subnetwork are allowed to Nat.
7207 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
7208 # in every Subnetwork are allowed to Nat.
7209 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
7210 # (specified in the field subnetwork below)
7211 #
7212 #
7213 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
7214 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
7215 # should not be any other Router.Nat section in any Router for this network
7216 # in this region.
7217 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
7218 # values:
7219 #
7220 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
7221 # every Subnetwork are allowed to Nat.
7222 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
7223 # (specified in the field nat64_subnetwork below)
7224 #
7225 #
7226 # The default is NAT64_OPTION_UNSPECIFIED.
7227 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
7228 # Router.Nat section in this region can also enable NAT64 for any
7229 # Subnetworks in this network. Other Router.Nat sections can still be
7230 # present to enable NAT44 only.
7231 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
7232 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
7233 # SubnetworkIpRangeToNatOption above.
7234 { # Defines the IP ranges that want to use NAT for a subnetwork.
7235 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
7236 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
7237 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
7238 # is one of the values in source_ip_ranges_to_nat.
7239 &quot;A String&quot;,
7240 ],
7241 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
7242 # options of a single value are valid except
7243 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
7244 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
7245 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
7246 # Default: [ALL_IP_RANGES]
7247 &quot;A String&quot;,
7248 ],
7249 },
7250 ],
7251 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
7252 # if not set.
7253 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
7254 # Defaults to 120s if not set.
7255 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
7256 # not set.
7257 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
7258 # translation. If unspecified, it defaults to PUBLIC.
7259 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
7260 },
7261 ],
7262 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
7263 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
7264 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
7265 # as part of resource payload.
7266 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
7267 # The field is allowed for INSERT
7268 # only. The keys/values to set on the resource should be specified in
7269 # either ID { : } or Namespaced format
7270 # { : }.
7271 # For example the following are valid inputs:
7272 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
7273 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
7274 # Note:
7275 # * Invalid combinations of ID &amp; namespaced format is not supported. For
7276 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
7277 # * Inconsistent format is not supported. For instance:
7278 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
7279 &quot;a_key&quot;: &quot;A String&quot;,
7280 },
7281 },
7282 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
7283 # You must specify this field as part of the HTTP request URL. It is
7284 # not settable as a field in the request body.
7285 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7286 },
7287 }</pre>
7288 </div>
7289
7290 <div class="method">
7291 <code class="details" id="update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
7292 <pre>Updates the specified Router resource with the data included in the
7293 request. This method conforms toPUT semantics, which requests that the state of the
7294 target resource be created or replaced with the state defined by the
7295 representation enclosed in the request message payload.
7296
7297 Args:
7298 project: string, Project ID for this request. (required)
7299 region: string, Name of the region for this request. (required)
7300 router: string, Name of the Router resource to update. (required)
7301 body: object, The request body.
7302 The object takes the form of:
7303
7304 { # Represents a Cloud Router resource.
7305 #
7306 # For more information about Cloud Router, read theCloud
7307 # Router overview.
7308 &quot;bgp&quot;: { # BGP information specific to this router.
7309 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
7310 # The options are DEFAULT or CUSTOM.
7311 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
7312 # This field can only be populated if advertise_mode is CUSTOM and
7313 # is advertised to all peers of the router.
7314 # These groups will be advertised in addition to any specified prefixes.
7315 # Leave this field blank to advertise no custom groups.
7316 &quot;A String&quot;,
7317 ],
7318 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
7319 # This field can only be populated if advertise_mode is CUSTOM and
7320 # is advertised to all peers of the router.
7321 # These IP ranges will be advertised in addition to any specified groups.
7322 # Leave this field blank to advertise no custom IP ranges.
7323 { # Description-tagged IP ranges for the router to advertise.
7324 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
7325 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
7326 },
7327 ],
7328 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
7329 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
7330 # value will be fixed for this router resource. All VPN tunnels that link
7331 # to this router will have the same local ASN.
7332 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
7333 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
7334 # least /30, even if the BGP sessions are over IPv6. It must not overlap
7335 # with any IPv4 BGP session ranges.
7336 #
7337 #
7338 # Other vendors commonly call this &quot;router ID&quot;.
7339 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
7340 # sent to the peer.
7341 #
7342 #
7343 # Hold time is three times the interval at which keepalive messages are
7344 # sent, and the hold time is the maximum number of seconds allowed to
7345 # elapse between successive keepalive messages that BGP receives from a
7346 # peer.
7347 #
7348 #
7349 # BGP will use the smaller of either the local hold time value or the
7350 # peer&#x27;s hold time value as the hold time for the BGP connection between
7351 # the two peers.
7352 #
7353 #
7354 # If set, this value must be between 20 and 60. The default is 20.
7355 },
7356 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
7357 # establish BGP peering. This information must specify the peer ASN and
7358 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
7359 {
7360 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
7361 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
7362 # which currently supports the following option:
7363 #
7364 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
7365 # excludes any routes learned for subnets that use
7366 # VPC Network Peering.
7367 #
7368 #
7369 # Note that this field can only be populated if advertise_mode is CUSTOM
7370 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
7371 # These groups are advertised in addition to any specified prefixes.
7372 # Leave this field blank to advertise no custom groups.
7373 &quot;A String&quot;,
7374 ],
7375 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
7376 # This field can only be populated if advertise_mode is CUSTOM and
7377 # overrides the list defined for the router (in the &quot;bgp&quot; message).
7378 # These IP ranges are advertised in addition to any specified groups.
7379 # Leave this field blank to advertise no custom IP ranges.
7380 { # Description-tagged IP ranges for the router to advertise.
7381 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
7382 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
7383 },
7384 ],
7385 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
7386 # than one matching route of maximum length, the routes with the lowest
7387 # priority value win.
7388 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
7389 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
7390 # received from the peer router. The actual value is negotiated between
7391 # the two routers and is equal to the greater of this value and the
7392 # transmit interval of the other router.
7393 #
7394 #
7395 # If set, this value must be between 1000 and 30000.
7396 #
7397 #
7398 # The default is 1000.
7399 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
7400 # transmitted to the peer router. The actual value is negotiated between
7401 # the two routers and is equal to the greater of this value and the
7402 # corresponding receive interval of the other router.
7403 #
7404 #
7405 # If set, this value must be between 1000 and 30000.
7406 #
7407 #
7408 # The default is 1000.
7409 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
7410 # before BFD declares that a peer is unavailable.
7411 #
7412 #
7413 # If set, the value must be a value between 5 and 16.
7414 #
7415 #
7416 # The default is 5.
7417 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
7418 #
7419 #
7420 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
7421 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
7422 # peer router to initiate the BFD session for this BGP peer. If set to
7423 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
7424 },
7425 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
7426 # session.
7427 {
7428 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
7429 # CIDR-formatted prefix. If an IP address is provided without a subnet
7430 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
7431 # range, and, for IPv6, `/128`.
7432 },
7433 ],
7434 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
7435 # value is applied to all custom learned route ranges for the session.
7436 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
7437 # value, Google Cloud assigns a priority of `100` to the ranges.
7438 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
7439 #
7440 #
7441 # If set to FALSE, any active session with the peer is terminated and
7442 # all associated routing information is removed. If set to TRUE, the
7443 # peer connection can be established with routing information. The default
7444 # is TRUE.
7445 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
7446 # the peerIpAddress is version 4.
7447 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
7448 # peerIpAddress is version 6.
7449 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
7450 # evaluated. The name must correspond to an existing policy that has
7451 # ROUTE_POLICY_TYPE_EXPORT type.
7452 &quot;A String&quot;,
7453 ],
7454 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
7455 # evaluated. The name must correspond to an existing policy that has
7456 # ROUTE_POLICY_TYPE_IMPORT type.
7457 &quot;A String&quot;,
7458 ],
7459 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
7460 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
7461 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
7462 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
7463 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
7464 #
7465 # - MANAGED_BY_USER is the default value and can be managed by you
7466 # or other users
7467 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
7468 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
7469 # PARTNER. Google automatically creates, updates, and deletes this type of
7470 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
7471 # or deleted.
7472 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
7473 # name of one of the entries in the Router.md5_authentication_keys. The
7474 # field must comply with RFC1035.
7475 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
7476 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
7477 # characters long and match the regular expression
7478 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7479 # lowercase letter, and all following characters must be a dash, lowercase
7480 # letter, or digit, except the last character, which cannot be a dash.
7481 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
7482 # a different value.
7483 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
7484 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
7485 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
7486 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
7487 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
7488 # Appliances. The VM instance must be located in zones contained in the
7489 # same region as this Cloud Router.
7490 # The VM instance is the peer side of the BGP session.
7491 },
7492 ],
7493 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7494 # text format.
7495 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7496 # create the resource.
7497 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
7498 # attachments (interconnectAttachments).
7499 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
7500 # defined by the server.
7501 &quot;interfaces&quot;: [ # Router interfaces.
7502 # To create a BGP peer that uses a router interface,
7503 # the interface must have one of the following fields specified:
7504 #
7505 # - linkedVpnTunnel
7506 # - linkedInterconnectAttachment
7507 # - subnetwork
7508 #
7509 #
7510 # You can create a router interface without any of these fields specified.
7511 # However, you cannot create a BGP peer that uses that interface.
7512 {
7513 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
7514 #
7515 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
7516 # be a CIDR-formatted string, for example, 169.254.0.1/30.
7517 # Note: Do not truncate the IP address, as it represents the IP address of
7518 # the interface.
7519 # - For Internet Protocol version 6 (IPv6), the value
7520 # must be a unique local address (ULA) range from fdff:1::/64
7521 # with a mask length of 126 or less. This value should be a CIDR-formatted
7522 # string, for example, fdff:1::1/112. Within the router&#x27;s
7523 # VPC, this IPv6 prefix will be reserved exclusively for this connection
7524 # and cannot be used for any other purpose.
7525 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
7526 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
7527 # as the router. Each interface can have one linked resource, which can be
7528 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
7529 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
7530 # router. Each interface can have one linked resource, which can be
7531 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
7532 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
7533 #
7534 # - MANAGED_BY_USER is the default value and can be managed directly
7535 # by users.
7536 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
7537 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
7538 # of type PARTNER. Google automatically creates, updates, and deletes
7539 # this type of interface when the PARTNER InterconnectAttachment is
7540 # created, updated, or deleted.
7541 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
7542 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
7543 # characters long and match the regular expression
7544 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7545 # lowercase letter, and all following characters must be a dash, lowercase
7546 # letter, or digit, except the last character, which cannot be a dash.
7547 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
7548 # BGP sessions to a VM instance acting as a third-party
7549 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
7550 # an SD-WAN VM.
7551 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
7552 # you are creating. The redundantInterface must belong to the same Cloud
7553 # Router as the interface here. To establish the BGP session to a Router
7554 # Appliance VM, you must create two BGP peers. The two BGP peers must be
7555 # attached to two separate interfaces that are redundant with each other.
7556 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
7557 # be 1-63 characters long and match the regular expression
7558 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7559 # lowercase letter, and all following characters must be a dash, lowercase
7560 # letter, or digit, except the last character, which cannot be a dash.
7561 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
7562 # must be in the same region as the Cloud Router.
7563 # When you establish a BGP session to a VM instance using this interface,
7564 # the VM instance must belong to the same subnetwork as the subnetwork
7565 # specified here.
7566 },
7567 ],
7568 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
7569 # routers.
7570 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
7571 {
7572 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
7573 #
7574 # For patch and update calls, it can be skipped to
7575 # copy the value from the previous configuration. This is allowed if the
7576 # key with the same name existed before the operation. Maximum length is 80
7577 # characters. Can only contain printable ASCII characters.
7578 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
7579 #
7580 # Must be unique within a router. Must be referenced by exactly
7581 # one bgpPeer. Must comply withRFC1035.
7582 },
7583 ],
7584 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
7585 # The name must be 1-63 characters long, and comply withRFC1035.
7586 # Specifically, the name must be 1-63 characters long and match the regular
7587 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7588 # character must be a lowercase letter, and all following characters must
7589 # be a dash, lowercase letter, or digit, except the last character, which
7590 # cannot be a dash.
7591 &quot;nats&quot;: [ # A list of NAT services created in this router.
7592 { # Represents a Nat resource. It enables the VMs within the specified
7593 # subnetworks to access Internet without external IP addresses. It specifies
7594 # a list of subnetworks (and the ranges within) that want to use NAT.
7595 # Customers can also provide the external IPs that would be used for NAT. GCP
7596 # would auto-allocate ephemeral IPs if no external IPs are provided.
7597 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
7598 # Must be one of: PREMIUM, STANDARD.
7599 # If not specified, then the current
7600 # project-level default tier is used.
7601 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
7602 # must be valid static external IPs that have been assigned to the NAT.
7603 # These IPs should be used for updating/patching a NAT only.
7604 &quot;A String&quot;,
7605 ],
7606 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
7607 # state. This value is equal to tcp_time_wait_timeout_sec.
7608 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
7609 # 120s. The field is output only.
7610 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
7611 #
7612 #
7613 # If not specified, it is disabled by default.
7614 #
7615 #
7616 # If set to true,
7617 #
7618 # - Dynamic Port Allocation will be enabled on this NAT
7619 # config.
7620 # - enableEndpointIndependentMapping cannot be set to true.
7621 # - If minPorts is set, minPortsPerVm must be set to a
7622 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
7623 # minimum of 32 ports will be allocated to a VM from this NAT
7624 # config.
7625 &quot;enableEndpointIndependentMapping&quot;: True or False,
7626 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
7627 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
7628 &quot;A String&quot;,
7629 ],
7630 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
7631 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
7632 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
7633 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
7634 # logs are exported for all connections handled by this NAT.
7635 # This option can take one of the following values:
7636 #
7637 # - ERRORS_ONLY: Export logs only for connection failures.
7638 # - TRANSLATIONS_ONLY: Export logs only for successful
7639 # connections.
7640 # - ALL: Export logs for all connections, successful and
7641 # unsuccessful.
7642 },
7643 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
7644 # Dynamic Port Allocation is enabled.
7645 #
7646 #
7647 # If Dynamic Port Allocation is not enabled, this field has no effect.
7648 #
7649 #
7650 # If Dynamic Port Allocation is enabled, and this field is set, it must be
7651 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
7652 # is not set.
7653 #
7654 #
7655 # If Dynamic Port Allocation is enabled and this field is not set,
7656 # a maximum of 65536 ports will be allocated to a VM from this NAT
7657 # config.
7658 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
7659 # set, a default number of ports is allocated to a VM. This is rounded
7660 # up to the nearest power of 2. For example, if the value of this field is
7661 # 50, at least 64 ports are allocated to a VM.
7662 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
7663 # The name must be 1-63 characters long and comply withRFC1035.
7664 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
7665 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
7666 # selected for the SubnetworkIpRangeToNat64Option above.
7667 { # Specifies a subnetwork to enable NAT64.
7668 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
7669 },
7670 ],
7671 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
7672 # values:
7673 #
7674 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
7675 # customers. When there are not enough specified Nat IPs, the Nat service
7676 # fails for new VMs.
7677 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
7678 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
7679 # be empty.
7680 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
7681 # addresses must be valid static external IP addresses assigned to the
7682 # project.
7683 &quot;A String&quot;,
7684 ],
7685 &quot;rules&quot;: [ # A list of rules associated with this NAT.
7686 {
7687 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
7688 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
7689 # addresses must be valid static external IP addresses assigned to the
7690 # project.
7691 # This field is used for public NAT.
7692 &quot;A String&quot;,
7693 ],
7694 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
7695 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
7696 # This field is used for private NAT.
7697 &quot;A String&quot;,
7698 ],
7699 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
7700 # must be valid static external IPs that have been assigned to the NAT.
7701 # These IPs should be used for updating/patching a NAT rule only.
7702 # This field is used for public NAT.
7703 &quot;A String&quot;,
7704 ],
7705 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
7706 # drained. This is only supported on patch/update, and these
7707 # subnetworks must have previously been used as active ranges in this
7708 # NAT Rule.
7709 # This field is used for private NAT.
7710 &quot;A String&quot;,
7711 ],
7712 },
7713 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
7714 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
7715 # from a VM is evaluated against. If it evaluates to true, the
7716 # corresponding `action` is enforced.
7717 #
7718 # The following examples are valid match expressions for public NAT:
7719 #
7720 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
7721 # &#x27;2.2.0.0/16&#x27;)`
7722 #
7723 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
7724 #
7725 # The following example is a valid match expression for private NAT:
7726 #
7727 # `nexthop.hub ==
7728 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
7729 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
7730 # must be a positive value between 0 and 65000, and
7731 # must be unique among rules within a NAT.
7732 },
7733 ],
7734 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
7735 #
7736 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
7737 # Subnetwork are allowed to Nat.
7738 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
7739 # in every Subnetwork are allowed to Nat.
7740 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
7741 # (specified in the field subnetwork below)
7742 #
7743 #
7744 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
7745 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
7746 # should not be any other Router.Nat section in any Router for this network
7747 # in this region.
7748 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
7749 # values:
7750 #
7751 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
7752 # every Subnetwork are allowed to Nat.
7753 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
7754 # (specified in the field nat64_subnetwork below)
7755 #
7756 #
7757 # The default is NAT64_OPTION_UNSPECIFIED.
7758 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
7759 # Router.Nat section in this region can also enable NAT64 for any
7760 # Subnetworks in this network. Other Router.Nat sections can still be
7761 # present to enable NAT44 only.
7762 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
7763 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
7764 # SubnetworkIpRangeToNatOption above.
7765 { # Defines the IP ranges that want to use NAT for a subnetwork.
7766 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
7767 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
7768 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
7769 # is one of the values in source_ip_ranges_to_nat.
7770 &quot;A String&quot;,
7771 ],
7772 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
7773 # options of a single value are valid except
7774 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
7775 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
7776 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
7777 # Default: [ALL_IP_RANGES]
7778 &quot;A String&quot;,
7779 ],
7780 },
7781 ],
7782 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
7783 # if not set.
7784 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
7785 # Defaults to 120s if not set.
7786 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
7787 # not set.
7788 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
7789 # translation. If unspecified, it defaults to PUBLIC.
7790 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
7791 },
7792 ],
7793 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
7794 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
7795 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
7796 # as part of resource payload.
7797 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
7798 # The field is allowed for INSERT
7799 # only. The keys/values to set on the resource should be specified in
7800 # either ID { : } or Namespaced format
7801 # { : }.
7802 # For example the following are valid inputs:
7803 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
7804 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
7805 # Note:
7806 # * Invalid combinations of ID &amp; namespaced format is not supported. For
7807 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
7808 # * Inconsistent format is not supported. For instance:
7809 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
7810 &quot;a_key&quot;: &quot;A String&quot;,
7811 },
7812 },
7813 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
7814 # You must specify this field as part of the HTTP request URL. It is
7815 # not settable as a field in the request body.
7816 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7817 }
7818
7819 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7820 that if you must retry your request, the server will know to ignore the
7821 request if it has already been completed.
7822
7823 For example, consider a situation where you make an initial request and
7824 the request times out. If you make the request again with the same
7825 request ID, the server can check if original operation with the same
7826 request ID was received, and if so, will ignore the second request. This
7827 prevents clients from accidentally creating duplicate commitments.
7828
7829 The request ID must be
7830 a valid UUID with the exception that zero UUID is not supported
7831 (00000000-0000-0000-0000-000000000000).
7832 x__xgafv: string, V1 error format.
7833 Allowed values
7834 1 - v1 error format
7835 2 - v2 error format
7836
7837 Returns:
7838 An object of the form:
7839
7840 { # Represents an Operation resource.
7841 #
7842 # Google Compute Engine has three Operation resources:
7843 #
7844 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7845 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7846 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7847 #
7848 # You can use an operation resource to manage asynchronous API requests.
7849 # For more information, readHandling
7850 # API responses.
7851 #
7852 # Operations can be global, regional or zonal.
7853 #
7854 # - For global operations, use the `globalOperations`
7855 # resource.
7856 # - For regional operations, use the
7857 # `regionOperations` resource.
7858 # - For zonal operations, use
7859 # the `zoneOperations` resource.
7860 #
7861 #
7862 #
7863 # For more information, read
7864 # Global, Regional, and Zonal Resources.
7865 #
7866 # Note that completed Operation resources have a limited
7867 # retention period.
7868 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7869 # Not present otherwise.
7870 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7871 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7872 # set when the operation is created.
7873 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7874 # text format.
7875 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7876 # this field will be populated.
7877 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7878 # operation.
7879 {
7880 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7881 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7882 # details. There is a set of defined message types to use for providing
7883 # details.The syntax depends on the error code. For example,
7884 # QuotaExceededInfo will have details when the error code is
7885 # QUOTA_EXCEEDED.
7886 {
7887 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7888 #
7889 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7890 # is not enabled:
7891 #
7892 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7893 # &quot;domain&quot;: &quot;googleapis.com&quot;
7894 # &quot;metadata&quot;: {
7895 # &quot;resource&quot;: &quot;projects/123&quot;,
7896 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7897 # }
7898 # }
7899 #
7900 # This response indicates that the pubsub.googleapis.com API is not enabled.
7901 #
7902 # Example of an error that is returned when attempting to create a Spanner
7903 # instance in a region that is out of stock:
7904 #
7905 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7906 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7907 # &quot;metadata&quot;: {
7908 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7909 # }
7910 # }
7911 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7912 # is typically the registered service name of the tool or product that
7913 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7914 # generated by some common infrastructure, the error domain must be a
7915 # globally unique value that identifies the infrastructure. For Google API
7916 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7917 &quot;metadatas&quot;: { # Additional structured details about this error.
7918 #
7919 # Keys must match a regular expression of `a-z+` but should
7920 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7921 # length. When identifying the current value of an exceeded limit, the units
7922 # should be contained in the key, not the value. For example, rather than
7923 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7924 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7925 # instances that can be created in a single (batch) request.
7926 &quot;a_key&quot;: &quot;A String&quot;,
7927 },
7928 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7929 # proximate cause of the error. Error reasons are unique within a particular
7930 # domain of errors. This should be at most 63 characters and match a
7931 # regular expression of `A-Z+[A-Z0-9]`, which represents
7932 # UPPER_SNAKE_CASE.
7933 },
7934 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7935 #
7936 # For example, if a quota check failed with an error indicating the calling
7937 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7938 # directly to the right place in the developer console to flip the bit.
7939 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7940 { # Describes a URL link.
7941 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7942 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7943 },
7944 ],
7945 },
7946 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7947 # which can be attached to an RPC error.
7948 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7949 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7950 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7951 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7952 },
7953 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7954 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7955 &quot;a_key&quot;: &quot;A String&quot;,
7956 },
7957 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7958 # type or metric.
7959 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7960 # or metric.
7961 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7962 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7963 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7964 },
7965 },
7966 ],
7967 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7968 # This property is optional.
7969 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7970 },
7971 ],
7972 },
7973 &quot;getVersionOperationMetadata&quot;: {
7974 &quot;inlineSbomInfo&quot;: {
7975 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7976 # appropriate identifiers.
7977 &quot;a_key&quot;: &quot;A String&quot;,
7978 },
7979 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7980 # identifiers.
7981 &quot;a_key&quot;: &quot;A String&quot;,
7982 },
7983 },
7984 },
7985 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7986 # message that was returned, such as `NOT FOUND`.
7987 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7988 # status code that was returned. For example, a `404` means the
7989 # resource was not found.
7990 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7991 # defined by the server.
7992 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7993 # This value is inRFC3339
7994 # text format.
7995 &quot;instancesBulkInsertOperationMetadata&quot;: {
7996 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7997 # Example key: zones/us-central1-a
7998 &quot;a_key&quot;: {
7999 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8000 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8001 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8002 # error.
8003 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8004 # if the flow is rolling forward or rolling back.
8005 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8006 },
8007 },
8008 },
8009 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8010 # Operation resources.
8011 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8012 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8013 # group of operations results from a `bulkInsert` API request.
8014 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8015 # `update`, or `delete`, and so on.
8016 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8017 # There is no requirement that this be linear or support any granularity of
8018 # operations. This should not be used to guess when the operation will be
8019 # complete. This number should monotonically increase as the operation
8020 # progresses.
8021 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8022 # applicable when performing regional operations.
8023 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8024 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8025 # this field will contain information on all underlying zonal actions and
8026 # their state.
8027 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8028 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8029 # Example key: zones/us-central1-a
8030 &quot;a_key&quot;: {
8031 &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
8032 # populated.
8033 # different programming environments, including REST APIs and RPC APIs. It is
8034 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8035 # three pieces of data: error code, error message, and error details.
8036 #
8037 # You can find out more about this error model and how to work with it in the
8038 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8039 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8040 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8041 # message types for APIs to use.
8042 {
8043 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8044 },
8045 ],
8046 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8047 # user-facing error message should be localized and sent in the
8048 # google.rpc.Status.details field, or localized by the client.
8049 },
8050 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8051 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8052 },
8053 },
8054 },
8055 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8056 # This value is inRFC3339
8057 # text format.
8058 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8059 # following:
8060 # `PENDING`, `RUNNING`, or `DONE`.
8061 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8062 # operation.
8063 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8064 # of the target resource.
8065 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8066 # operations related to creating a snapshot, this points to the disk
8067 # that the snapshot was created from.
8068 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8069 # `[email protected]` or
8070 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8071 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8072 # operation, this field will be populated.
8073 {
8074 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8075 # Engine returns NO_RESULTS_ON_PAGE if there
8076 # are no results in the response.
8077 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8078 # value format. For example:
8079 #
8080 # &quot;data&quot;: [
8081 # {
8082 # &quot;key&quot;: &quot;scope&quot;,
8083 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8084 # }
8085 {
8086 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8087 # returned. For example, for warnings where there are no results in a list
8088 # request for a particular zone, this key might be scope and
8089 # the key value might be the zone name. Other examples might be a key
8090 # indicating a deprecated resource and a suggested replacement, or a
8091 # warning about invalid network settings (for example, if an instance
8092 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8093 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8094 },
8095 ],
8096 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8097 },
8098 ],
8099 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8100 # applicable when performing per-zone operations.
8101 }</pre>
8102 </div>
8103
8104 <div class="method">
8105 <code class="details" id="updateRoutePolicy">updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
8106 <pre>Updates or creates new Route Policy
8107
8108 Args:
8109 project: string, Project ID for this request. (required)
8110 region: string, Name of the region for this request. (required)
8111 router: string, Name of the Router resource where Route Policy is defined. (required)
8112 body: object, The request body.
8113 The object takes the form of:
8114
8115 {
8116 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
8117 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
8118 # essentially a hash of the Route Policy used for optimistic locking.
8119 # The fingerprint is initially generated by Compute Engine and changes
8120 # after every request to modify or update Route Policy. You must always
8121 # provide an up-to-date fingerprint hash in order to update or change
8122 # labels.
8123 #
8124 # To see the latest fingerprint, make a getRoutePolicy() request
8125 # to retrieve a Route Policy.
8126 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
8127 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
8128 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
8129 # in order of priority). Order of policies is not retained and might change
8130 # when getting policy later.
8131 {
8132 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
8133 { # Represents a textual expression in the Common Expression Language (CEL)
8134 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8135 # are documented at https://github.com/google/cel-spec.
8136 #
8137 # Example (Comparison):
8138 #
8139 # title: &quot;Summary size limit&quot;
8140 # description: &quot;Determines if a summary is less than 100 chars&quot;
8141 # expression: &quot;document.summary.size() &lt; 100&quot;
8142 #
8143 # Example (Equality):
8144 #
8145 # title: &quot;Requestor is owner&quot;
8146 # description: &quot;Determines if requestor is the document owner&quot;
8147 # expression: &quot;document.owner == request.auth.claims.email&quot;
8148 #
8149 # Example (Logic):
8150 #
8151 # title: &quot;Public documents&quot;
8152 # description: &quot;Determine whether the document should be publicly visible&quot;
8153 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8154 #
8155 # Example (Data Manipulation):
8156 #
8157 # title: &quot;Notification string&quot;
8158 # description: &quot;Create a notification string with a timestamp.&quot;
8159 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8160 #
8161 # The exact variables and functions that may be referenced within an expression
8162 # are determined by the service that evaluates it. See the service
8163 # documentation for additional information.
8164 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8165 # describes the expression, e.g. when hovered over it in a UI.
8166 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8167 # syntax.
8168 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8169 # reporting, e.g. a file name and a position in the file.
8170 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8171 # its purpose. This can be used e.g. in UIs which allow to enter the
8172 # expression.
8173 },
8174 ],
8175 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
8176 # applies. When not set, the term applies to all
8177 # routes.
8178 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8179 # are documented at https://github.com/google/cel-spec.
8180 #
8181 # Example (Comparison):
8182 #
8183 # title: &quot;Summary size limit&quot;
8184 # description: &quot;Determines if a summary is less than 100 chars&quot;
8185 # expression: &quot;document.summary.size() &lt; 100&quot;
8186 #
8187 # Example (Equality):
8188 #
8189 # title: &quot;Requestor is owner&quot;
8190 # description: &quot;Determines if requestor is the document owner&quot;
8191 # expression: &quot;document.owner == request.auth.claims.email&quot;
8192 #
8193 # Example (Logic):
8194 #
8195 # title: &quot;Public documents&quot;
8196 # description: &quot;Determine whether the document should be publicly visible&quot;
8197 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8198 #
8199 # Example (Data Manipulation):
8200 #
8201 # title: &quot;Notification string&quot;
8202 # description: &quot;Create a notification string with a timestamp.&quot;
8203 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8204 #
8205 # The exact variables and functions that may be referenced within an expression
8206 # are determined by the service that evaluates it. See the service
8207 # documentation for additional information.
8208 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8209 # describes the expression, e.g. when hovered over it in a UI.
8210 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8211 # syntax.
8212 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8213 # reporting, e.g. a file name and a position in the file.
8214 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8215 # its purpose. This can be used e.g. in UIs which allow to enter the
8216 # expression.
8217 },
8218 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
8219 # (inclusive) and 2^31 (exclusive), and unique within the list.
8220 },
8221 ],
8222 &quot;type&quot;: &quot;A String&quot;,
8223 }
8224
8225 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8226 that if you must retry your request, the server will know to ignore the
8227 request if it has already been completed.
8228
8229 For example, consider a situation where you make an initial request and
8230 the request times out. If you make the request again with the same
8231 request ID, the server can check if original operation with the same
8232 request ID was received, and if so, will ignore the second request. This
8233 prevents clients from accidentally creating duplicate commitments.
8234
8235 The request ID must be
8236 a valid UUID with the exception that zero UUID is not supported
8237 (00000000-0000-0000-0000-000000000000).
8238 x__xgafv: string, V1 error format.
8239 Allowed values
8240 1 - v1 error format
8241 2 - v2 error format
8242
8243 Returns:
8244 An object of the form:
8245
8246 { # Represents an Operation resource.
8247 #
8248 # Google Compute Engine has three Operation resources:
8249 #
8250 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
8251 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
8252 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
8253 #
8254 # You can use an operation resource to manage asynchronous API requests.
8255 # For more information, readHandling
8256 # API responses.
8257 #
8258 # Operations can be global, regional or zonal.
8259 #
8260 # - For global operations, use the `globalOperations`
8261 # resource.
8262 # - For regional operations, use the
8263 # `regionOperations` resource.
8264 # - For zonal operations, use
8265 # the `zoneOperations` resource.
8266 #
8267 #
8268 #
8269 # For more information, read
8270 # Global, Regional, and Zonal Resources.
8271 #
8272 # Note that completed Operation resources have a limited
8273 # retention period.
8274 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8275 # Not present otherwise.
8276 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8277 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8278 # set when the operation is created.
8279 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8280 # text format.
8281 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8282 # this field will be populated.
8283 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8284 # operation.
8285 {
8286 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8287 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8288 # details. There is a set of defined message types to use for providing
8289 # details.The syntax depends on the error code. For example,
8290 # QuotaExceededInfo will have details when the error code is
8291 # QUOTA_EXCEEDED.
8292 {
8293 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8294 #
8295 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8296 # is not enabled:
8297 #
8298 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8299 # &quot;domain&quot;: &quot;googleapis.com&quot;
8300 # &quot;metadata&quot;: {
8301 # &quot;resource&quot;: &quot;projects/123&quot;,
8302 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8303 # }
8304 # }
8305 #
8306 # This response indicates that the pubsub.googleapis.com API is not enabled.
8307 #
8308 # Example of an error that is returned when attempting to create a Spanner
8309 # instance in a region that is out of stock:
8310 #
8311 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8312 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8313 # &quot;metadata&quot;: {
8314 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8315 # }
8316 # }
8317 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8318 # is typically the registered service name of the tool or product that
8319 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8320 # generated by some common infrastructure, the error domain must be a
8321 # globally unique value that identifies the infrastructure. For Google API
8322 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8323 &quot;metadatas&quot;: { # Additional structured details about this error.
8324 #
8325 # Keys must match a regular expression of `a-z+` but should
8326 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8327 # length. When identifying the current value of an exceeded limit, the units
8328 # should be contained in the key, not the value. For example, rather than
8329 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8330 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8331 # instances that can be created in a single (batch) request.
8332 &quot;a_key&quot;: &quot;A String&quot;,
8333 },
8334 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8335 # proximate cause of the error. Error reasons are unique within a particular
8336 # domain of errors. This should be at most 63 characters and match a
8337 # regular expression of `A-Z+[A-Z0-9]`, which represents
8338 # UPPER_SNAKE_CASE.
8339 },
8340 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8341 #
8342 # For example, if a quota check failed with an error indicating the calling
8343 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8344 # directly to the right place in the developer console to flip the bit.
8345 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8346 { # Describes a URL link.
8347 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8348 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8349 },
8350 ],
8351 },
8352 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8353 # which can be attached to an RPC error.
8354 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8355 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8356 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8357 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8358 },
8359 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8360 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8361 &quot;a_key&quot;: &quot;A String&quot;,
8362 },
8363 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8364 # type or metric.
8365 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8366 # or metric.
8367 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8368 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8369 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8370 },
8371 },
8372 ],
8373 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8374 # This property is optional.
8375 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8376 },
8377 ],
8378 },
8379 &quot;getVersionOperationMetadata&quot;: {
8380 &quot;inlineSbomInfo&quot;: {
8381 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8382 # appropriate identifiers.
8383 &quot;a_key&quot;: &quot;A String&quot;,
8384 },
8385 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8386 # identifiers.
8387 &quot;a_key&quot;: &quot;A String&quot;,
8388 },
8389 },
8390 },
8391 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8392 # message that was returned, such as `NOT FOUND`.
8393 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8394 # status code that was returned. For example, a `404` means the
8395 # resource was not found.
8396 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8397 # defined by the server.
8398 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8399 # This value is inRFC3339
8400 # text format.
8401 &quot;instancesBulkInsertOperationMetadata&quot;: {
8402 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8403 # Example key: zones/us-central1-a
8404 &quot;a_key&quot;: {
8405 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8406 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8407 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8408 # error.
8409 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8410 # if the flow is rolling forward or rolling back.
8411 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8412 },
8413 },
8414 },
8415 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8416 # Operation resources.
8417 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8418 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8419 # group of operations results from a `bulkInsert` API request.
8420 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8421 # `update`, or `delete`, and so on.
8422 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8423 # There is no requirement that this be linear or support any granularity of
8424 # operations. This should not be used to guess when the operation will be
8425 # complete. This number should monotonically increase as the operation
8426 # progresses.
8427 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8428 # applicable when performing regional operations.
8429 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8430 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8431 # this field will contain information on all underlying zonal actions and
8432 # their state.
8433 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8434 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8435 # Example key: zones/us-central1-a
8436 &quot;a_key&quot;: {
8437 &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
8438 # populated.
8439 # different programming environments, including REST APIs and RPC APIs. It is
8440 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8441 # three pieces of data: error code, error message, and error details.
8442 #
8443 # You can find out more about this error model and how to work with it in the
8444 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8445 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8446 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8447 # message types for APIs to use.
8448 {
8449 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8450 },
8451 ],
8452 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8453 # user-facing error message should be localized and sent in the
8454 # google.rpc.Status.details field, or localized by the client.
8455 },
8456 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8457 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8458 },
8459 },
8460 },
8461 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8462 # This value is inRFC3339
8463 # text format.
8464 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8465 # following:
8466 # `PENDING`, `RUNNING`, or `DONE`.
8467 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8468 # operation.
8469 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8470 # of the target resource.
8471 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8472 # operations related to creating a snapshot, this points to the disk
8473 # that the snapshot was created from.
8474 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8475 # `[email protected]` or
8476 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8477 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8478 # operation, this field will be populated.
8479 {
8480 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8481 # Engine returns NO_RESULTS_ON_PAGE if there
8482 # are no results in the response.
8483 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8484 # value format. For example:
8485 #
8486 # &quot;data&quot;: [
8487 # {
8488 # &quot;key&quot;: &quot;scope&quot;,
8489 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8490 # }
8491 {
8492 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8493 # returned. For example, for warnings where there are no results in a list
8494 # request for a particular zone, this key might be scope and
8495 # the key value might be the zone name. Other examples might be a key
8496 # indicating a deprecated resource and a suggested replacement, or a
8497 # warning about invalid network settings (for example, if an instance
8498 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8499 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8500 },
8501 ],
8502 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8503 },
8504 ],
8505 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8506 # applicable when performing per-zone operations.
8507 }</pre>
8508 </div>
8509
8510 </body></html>