Debian Codegraph @

docs/dyn/compute_beta.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_beta.html">Compute Engine API</a> . <a href="compute_beta.routers.html">routers</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves an aggregated list of routers.</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, region, router, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified Router resource.</p>
89 <p class="toc_element">
90 <code><a href="#deleteNamedSet">deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes Named Set</p>
92 <p class="toc_element">
93 <code><a href="#deleteRoutePolicy">deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Deletes Route Policy</p>
95 <p class="toc_element">
96 <code><a href="#get">get(project, region, router, x__xgafv=None)</a></code></p>
97 <p class="firstline">Returns the specified Router resource.</p>
98 <p class="toc_element">
99 <code><a href="#getNamedSet">getNamedSet(project, region, router, namedSet=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Returns specified Named Set</p>
101 <p class="toc_element">
102 <code><a href="#getNatIpInfo">getNatIpInfo(project, region, router, natName=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Retrieves runtime NAT IP information.</p>
104 <p class="toc_element">
105 <code><a href="#getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, natName=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Retrieves runtime Nat mapping information of VM endpoints.</p>
107 <p class="toc_element">
108 <code><a href="#getNatMappingInfo_next">getNatMappingInfo_next()</a></code></p>
109 <p class="firstline">Retrieves the next page of results.</p>
110 <p class="toc_element">
111 <code><a href="#getRoutePolicy">getRoutePolicy(project, region, router, policy=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Returns specified Route Policy</p>
113 <p class="toc_element">
114 <code><a href="#getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</a></code></p>
115 <p class="firstline">Retrieves runtime information of the specified router.</p>
116 <p class="toc_element">
117 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Creates a Router resource in the specified project and region using</p>
119 <p class="toc_element">
120 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Retrieves a list of Router resources available to the specified project.</p>
122 <p class="toc_element">
123 <code><a href="#listBgpRoutes">listBgpRoutes(project, region, router, addressFamily=None, destinationPrefix=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peer=None, policyApplied=None, returnPartialSuccess=None, routeType=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Retrieves a list of router bgp routes available to the specified project.</p>
125 <p class="toc_element">
126 <code><a href="#listBgpRoutes_next">listBgpRoutes_next()</a></code></p>
127 <p class="firstline">Retrieves the next page of results.</p>
128 <p class="toc_element">
129 <code><a href="#listNamedSets">listNamedSets(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Retrieves a list of router named set subresources available to the</p>
131 <p class="toc_element">
132 <code><a href="#listNamedSets_next">listNamedSets_next()</a></code></p>
133 <p class="firstline">Retrieves the next page of results.</p>
134 <p class="toc_element">
135 <code><a href="#listRoutePolicies">listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Retrieves a list of router route policy subresources available to the</p>
137 <p class="toc_element">
138 <code><a href="#listRoutePolicies_next">listRoutePolicies_next()</a></code></p>
139 <p class="firstline">Retrieves the next page of results.</p>
140 <p class="toc_element">
141 <code><a href="#list_next">list_next()</a></code></p>
142 <p class="firstline">Retrieves the next page of results.</p>
143 <p class="toc_element">
144 <code><a href="#patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Patches the specified Router resource with the data included in the</p>
146 <p class="toc_element">
147 <code><a href="#patchNamedSet">patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
148 <p class="firstline">Patches Named Set</p>
149 <p class="toc_element">
150 <code><a href="#patchRoutePolicy">patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
151 <p class="firstline">Patches Route Policy</p>
152 <p class="toc_element">
153 <code><a href="#preview">preview(project, region, router, body=None, x__xgafv=None)</a></code></p>
154 <p class="firstline">Preview fields auto-generated during router create andupdate operations.</p>
155 <p class="toc_element">
156 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
157 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
158 <p class="toc_element">
159 <code><a href="#update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
160 <p class="firstline">Updates the specified Router resource with the data included in the</p>
161 <p class="toc_element">
162 <code><a href="#updateNamedSet">updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
163 <p class="firstline">Updates or creates new Named Set</p>
164 <p class="toc_element">
165 <code><a href="#updateRoutePolicy">updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>
166 <p class="firstline">Updates or creates new Route Policy</p>
167 <h3>Method Details</h3>
168 <div class="method">
169 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
170 <pre>Retrieves an aggregated list of routers.
171
172 To prevent failure, Google recommends that you set the
173 `returnPartialSuccess` parameter to `true`.
174
175 Args:
176 project: string, Project ID for this request. (required)
177 filter: string, A filter expression that filters resources listed in the response. Most
178 Compute resources support two types of filter expressions:
179 expressions that support regular expressions and expressions that follow
180 API improvement proposal AIP-160.
181 These two types of filter expressions cannot be mixed in one request.
182
183 If you want to use AIP-160, your expression must specify the field name, an
184 operator, and the value that you want to use for filtering. The value
185 must be a string, a number, or a boolean. The operator
186 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
187
188 For example, if you are filtering Compute Engine instances, you can
189 exclude instances named `example-instance` by specifying
190 `name != example-instance`.
191
192 The `:*` comparison can be used to test whether a key has been defined.
193 For example, to find all objects with `owner` label use:
194 ```
195 labels.owner:*
196 ```
197
198 You can also filter nested fields. For example, you could specify
199 `scheduling.automaticRestart = false` to include instances only
200 if they are not scheduled for automatic restarts. You can use filtering
201 on nested fields to filter based onresource labels.
202
203 To filter on multiple expressions, provide each separate expression within
204 parentheses. For example:
205 ```
206 (scheduling.automaticRestart = true)
207 (cpuPlatform = &quot;Intel Skylake&quot;)
208 ```
209 By default, each expression is an `AND` expression. However, you
210 can include `AND` and `OR` expressions explicitly.
211 For example:
212 ```
213 (cpuPlatform = &quot;Intel Skylake&quot;) OR
214 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
215 (scheduling.automaticRestart = true)
216 ```
217
218 If you want to use a regular expression, use the `eq` (equal) or `ne`
219 (not equal) operator against a single un-parenthesized expression with or
220 without quotes or against multiple parenthesized expressions. Examples:
221
222 `fieldname eq unquoted literal`
223 `fieldname eq &#x27;single quoted literal&#x27;`
224 `fieldname eq &quot;double quoted literal&quot;`
225 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
226
227 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
228 The literal value must match the entire field.
229
230 For example, to filter for instances that do not end with name &quot;instance&quot;,
231 you would use `name ne .*instance`.
232
233 You cannot combine constraints on multiple fields using regular
234 expressions.
235 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
236 global) should be included in the response. For new resource types added
237 after this field, the flag has no effect as new resource types will always
238 include every visible scope for each scope type in response. For resource
239 types which predate this field, if this flag is omitted or false, only
240 scopes of the scope types where the resource type is expected to be found
241 will be included.
242 maxResults: integer, The maximum number of results per page that should be returned.
243 If the number of available results is larger than `maxResults`,
244 Compute Engine returns a `nextPageToken` that can be used to get
245 the next page of results in subsequent list requests. Acceptable values are
246 `0` to `500`, inclusive. (Default: `500`)
247 orderBy: string, Sorts list results by a certain order. By default, results
248 are returned in alphanumerical order based on the resource name.
249
250 You can also sort results in descending order based on the creation
251 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
252 results based on the `creationTimestamp` field in
253 reverse chronological order (newest result first). Use this to sort
254 resources like operations so that the newest operation is returned first.
255
256 Currently, only sorting by `name` or
257 `creationTimestamp desc` is supported.
258 pageToken: string, Specifies a page token to use. Set `pageToken` to the
259 `nextPageToken` returned by a previous list request to get
260 the next page of results.
261 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
262 of failure. The default value is false.
263
264 For example, when partial success behavior is enabled, aggregatedList for a
265 single zone scope either returns all resources in the zone or no resources,
266 with an error code.
267 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
268 aggregated list request is invoked for subnetworks list-usable api.
269 x__xgafv: string, V1 error format.
270 Allowed values
271 1 - v1 error format
272 2 - v2 error format
273
274 Returns:
275 An object of the form:
276
277 { # Contains a list of routers.
278 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
279 &quot;items&quot;: { # A list of Router resources.
280 &quot;a_key&quot;: { # Name of the scope containing this set of routers.
281 &quot;routers&quot;: [ # A list of routers contained in this scope.
282 { # Represents a Cloud Router resource.
283 #
284 # For more information about Cloud Router, read theCloud
285 # Router overview.
286 &quot;bgp&quot;: { # BGP information specific to this router.
287 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
288 # The options are DEFAULT or CUSTOM.
289 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
290 # This field can only be populated if advertise_mode is CUSTOM and
291 # is advertised to all peers of the router.
292 # These groups will be advertised in addition to any specified prefixes.
293 # Leave this field blank to advertise no custom groups.
294 &quot;A String&quot;,
295 ],
296 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
297 # This field can only be populated if advertise_mode is CUSTOM and
298 # is advertised to all peers of the router.
299 # These IP ranges will be advertised in addition to any specified groups.
300 # Leave this field blank to advertise no custom IP ranges.
301 { # Description-tagged IP ranges for the router to advertise.
302 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
303 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
304 },
305 ],
306 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
307 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
308 # value will be fixed for this router resource. All VPN tunnels that link
309 # to this router will have the same local ASN.
310 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
311 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
312 # least /30, even if the BGP sessions are over IPv6. It must not overlap
313 # with any IPv4 BGP session ranges.
314 #
315 #
316 # Other vendors commonly call this &quot;router ID&quot;.
317 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
318 # sent to the peer.
319 #
320 #
321 # Hold time is three times the interval at which keepalive messages are
322 # sent, and the hold time is the maximum number of seconds allowed to
323 # elapse between successive keepalive messages that BGP receives from a
324 # peer.
325 #
326 #
327 # BGP will use the smaller of either the local hold time value or the
328 # peer&#x27;s hold time value as the hold time for the BGP connection between
329 # the two peers.
330 #
331 #
332 # If set, this value must be between 20 and 60. The default is 20.
333 },
334 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
335 # establish BGP peering. This information must specify the peer ASN and
336 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
337 {
338 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
339 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
340 # which currently supports the following option:
341 #
342 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
343 # excludes any routes learned for subnets that use
344 # VPC Network Peering.
345 #
346 #
347 # Note that this field can only be populated if advertise_mode is CUSTOM
348 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
349 # These groups are advertised in addition to any specified prefixes.
350 # Leave this field blank to advertise no custom groups.
351 &quot;A String&quot;,
352 ],
353 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
354 # This field can only be populated if advertise_mode is CUSTOM and
355 # overrides the list defined for the router (in the &quot;bgp&quot; message).
356 # These IP ranges are advertised in addition to any specified groups.
357 # Leave this field blank to advertise no custom IP ranges.
358 { # Description-tagged IP ranges for the router to advertise.
359 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
360 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
361 },
362 ],
363 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
364 # than one matching route of maximum length, the routes with the lowest
365 # priority value win.
366 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
367 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
368 # received from the peer router. The actual value is negotiated between
369 # the two routers and is equal to the greater of this value and the
370 # transmit interval of the other router.
371 #
372 #
373 # If set, this value must be between 1000 and 30000.
374 #
375 #
376 # The default is 1000.
377 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
378 # transmitted to the peer router. The actual value is negotiated between
379 # the two routers and is equal to the greater of this value and the
380 # corresponding receive interval of the other router.
381 #
382 #
383 # If set, this value must be between 1000 and 30000.
384 #
385 #
386 # The default is 1000.
387 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
388 # before BFD declares that a peer is unavailable.
389 #
390 #
391 # If set, the value must be a value between 5 and 16.
392 #
393 #
394 # The default is 5.
395 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
396 #
397 #
398 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
399 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
400 # peer router to initiate the BFD session for this BGP peer. If set to
401 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
402 },
403 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
404 # session.
405 {
406 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
407 # CIDR-formatted prefix. If an IP address is provided without a subnet
408 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
409 # range, and, for IPv6, `/128`.
410 },
411 ],
412 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
413 # value is applied to all custom learned route ranges for the session.
414 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
415 # value, Google Cloud assigns a priority of `100` to the ranges.
416 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
417 #
418 #
419 # If set to FALSE, any active session with the peer is terminated and
420 # all associated routing information is removed. If set to TRUE, the
421 # peer connection can be established with routing information. The default
422 # is TRUE.
423 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
424 # the peerIpAddress is version 4.
425 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
426 # peerIpAddress is version 6.
427 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
428 # evaluated. The name must correspond to an existing policy that has
429 # ROUTE_POLICY_TYPE_EXPORT type.
430 &quot;A String&quot;,
431 ],
432 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
433 # evaluated. The name must correspond to an existing policy that has
434 # ROUTE_POLICY_TYPE_IMPORT type.
435 &quot;A String&quot;,
436 ],
437 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
438 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
439 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
440 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
441 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
442 #
443 # - MANAGED_BY_USER is the default value and can be managed by you
444 # or other users
445 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
446 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
447 # PARTNER. Google automatically creates, updates, and deletes this type of
448 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
449 # or deleted.
450 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
451 # name of one of the entries in the Router.md5_authentication_keys. The
452 # field must comply with RFC1035.
453 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
454 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
455 # characters long and match the regular expression
456 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
457 # lowercase letter, and all following characters must be a dash, lowercase
458 # letter, or digit, except the last character, which cannot be a dash.
459 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
460 # a different value.
461 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
462 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
463 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
464 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
465 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
466 # Appliances. The VM instance must be located in zones contained in the
467 # same region as this Cloud Router.
468 # The VM instance is the peer side of the BGP session.
469 },
470 ],
471 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
472 # text format.
473 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
474 # create the resource.
475 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
476 # attachments (interconnectAttachments).
477 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
478 # defined by the server.
479 &quot;interfaces&quot;: [ # Router interfaces.
480 # To create a BGP peer that uses a router interface,
481 # the interface must have one of the following fields specified:
482 #
483 # - linkedVpnTunnel
484 # - linkedInterconnectAttachment
485 # - subnetwork
486 #
487 #
488 # You can create a router interface without any of these fields specified.
489 # However, you cannot create a BGP peer that uses that interface.
490 {
491 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
492 #
493 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
494 # be a CIDR-formatted string, for example, 169.254.0.1/30.
495 # Note: Do not truncate the IP address, as it represents the IP address of
496 # the interface.
497 # - For Internet Protocol version 6 (IPv6), the value
498 # must be a unique local address (ULA) range from fdff:1::/64
499 # with a mask length of 126 or less. This value should be a CIDR-formatted
500 # string, for example, fdff:1::1/112. Within the router&#x27;s
501 # VPC, this IPv6 prefix will be reserved exclusively for this connection
502 # and cannot be used for any other purpose.
503 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
504 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
505 # as the router. Each interface can have one linked resource, which can be
506 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
507 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
508 # router. Each interface can have one linked resource, which can be
509 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
510 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
511 #
512 # - MANAGED_BY_USER is the default value and can be managed directly
513 # by users.
514 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
515 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
516 # of type PARTNER. Google automatically creates, updates, and deletes
517 # this type of interface when the PARTNER InterconnectAttachment is
518 # created, updated, or deleted.
519 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
520 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
521 # characters long and match the regular expression
522 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
523 # lowercase letter, and all following characters must be a dash, lowercase
524 # letter, or digit, except the last character, which cannot be a dash.
525 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
526 # BGP sessions to a VM instance acting as a third-party
527 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
528 # an SD-WAN VM.
529 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
530 # you are creating. The redundantInterface must belong to the same Cloud
531 # Router as the interface here. To establish the BGP session to a Router
532 # Appliance VM, you must create two BGP peers. The two BGP peers must be
533 # attached to two separate interfaces that are redundant with each other.
534 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
535 # be 1-63 characters long and match the regular expression
536 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
537 # lowercase letter, and all following characters must be a dash, lowercase
538 # letter, or digit, except the last character, which cannot be a dash.
539 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
540 # must be in the same region as the Cloud Router.
541 # When you establish a BGP session to a VM instance using this interface,
542 # the VM instance must belong to the same subnetwork as the subnetwork
543 # specified here.
544 },
545 ],
546 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
547 # routers.
548 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
549 {
550 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
551 #
552 # For patch and update calls, it can be skipped to
553 # copy the value from the previous configuration. This is allowed if the
554 # key with the same name existed before the operation. Maximum length is 80
555 # characters. Can only contain printable ASCII characters.
556 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
557 #
558 # Must be unique within a router. Must be referenced by exactly
559 # one bgpPeer. Must comply withRFC1035.
560 },
561 ],
562 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
563 # The name must be 1-63 characters long, and comply withRFC1035.
564 # Specifically, the name must be 1-63 characters long and match the regular
565 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
566 # character must be a lowercase letter, and all following characters must
567 # be a dash, lowercase letter, or digit, except the last character, which
568 # cannot be a dash.
569 &quot;nats&quot;: [ # A list of NAT services created in this router.
570 { # Represents a Nat resource. It enables the VMs within the specified
571 # subnetworks to access Internet without external IP addresses. It specifies
572 # a list of subnetworks (and the ranges within) that want to use NAT.
573 # Customers can also provide the external IPs that would be used for NAT. GCP
574 # would auto-allocate ephemeral IPs if no external IPs are provided.
575 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
576 # Must be one of: PREMIUM, STANDARD.
577 # If not specified, then the current
578 # project-level default tier is used.
579 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
580 # must be valid static external IPs that have been assigned to the NAT.
581 # These IPs should be used for updating/patching a NAT only.
582 &quot;A String&quot;,
583 ],
584 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
585 # state. This value is equal to tcp_time_wait_timeout_sec.
586 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
587 # 120s. The field is output only.
588 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
589 #
590 #
591 # If not specified, it is disabled by default.
592 #
593 #
594 # If set to true,
595 #
596 # - Dynamic Port Allocation will be enabled on this NAT
597 # config.
598 # - enableEndpointIndependentMapping cannot be set to true.
599 # - If minPorts is set, minPortsPerVm must be set to a
600 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
601 # minimum of 32 ports will be allocated to a VM from this NAT
602 # config.
603 &quot;enableEndpointIndependentMapping&quot;: True or False,
604 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
605 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
606 &quot;A String&quot;,
607 ],
608 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
609 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
610 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
611 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
612 # logs are exported for all connections handled by this NAT.
613 # This option can take one of the following values:
614 #
615 # - ERRORS_ONLY: Export logs only for connection failures.
616 # - TRANSLATIONS_ONLY: Export logs only for successful
617 # connections.
618 # - ALL: Export logs for all connections, successful and
619 # unsuccessful.
620 },
621 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
622 # Dynamic Port Allocation is enabled.
623 #
624 #
625 # If Dynamic Port Allocation is not enabled, this field has no effect.
626 #
627 #
628 # If Dynamic Port Allocation is enabled, and this field is set, it must be
629 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
630 # is not set.
631 #
632 #
633 # If Dynamic Port Allocation is enabled and this field is not set,
634 # a maximum of 65536 ports will be allocated to a VM from this NAT
635 # config.
636 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
637 # set, a default number of ports is allocated to a VM. This is rounded
638 # up to the nearest power of 2. For example, if the value of this field is
639 # 50, at least 64 ports are allocated to a VM.
640 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
641 # The name must be 1-63 characters long and comply withRFC1035.
642 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
643 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
644 # selected for the SubnetworkIpRangeToNat64Option above.
645 { # Specifies a subnetwork to enable NAT64.
646 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
647 },
648 ],
649 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
650 # values:
651 #
652 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
653 # customers. When there are not enough specified Nat IPs, the Nat service
654 # fails for new VMs.
655 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
656 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
657 # be empty.
658 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
659 # addresses must be valid static external IP addresses assigned to the
660 # project.
661 &quot;A String&quot;,
662 ],
663 &quot;rules&quot;: [ # A list of rules associated with this NAT.
664 {
665 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
666 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
667 # addresses must be valid static external IP addresses assigned to the
668 # project.
669 # This field is used for public NAT.
670 &quot;A String&quot;,
671 ],
672 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
673 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
674 # This field is used for private NAT.
675 &quot;A String&quot;,
676 ],
677 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
678 # must be valid static external IPs that have been assigned to the NAT.
679 # These IPs should be used for updating/patching a NAT rule only.
680 # This field is used for public NAT.
681 &quot;A String&quot;,
682 ],
683 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
684 # drained. This is only supported on patch/update, and these
685 # subnetworks must have previously been used as active ranges in this
686 # NAT Rule.
687 # This field is used for private NAT.
688 &quot;A String&quot;,
689 ],
690 },
691 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
692 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
693 # from a VM is evaluated against. If it evaluates to true, the
694 # corresponding `action` is enforced.
695 #
696 # The following examples are valid match expressions for public NAT:
697 #
698 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
699 # &#x27;2.2.0.0/16&#x27;)`
700 #
701 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
702 #
703 # The following example is a valid match expression for private NAT:
704 #
705 # `nexthop.hub ==
706 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
707 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
708 # must be a positive value between 0 and 65000, and
709 # must be unique among rules within a NAT.
710 },
711 ],
712 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
713 #
714 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
715 # Subnetwork are allowed to Nat.
716 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
717 # in every Subnetwork are allowed to Nat.
718 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
719 # (specified in the field subnetwork below)
720 #
721 #
722 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
723 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
724 # should not be any other Router.Nat section in any Router for this network
725 # in this region.
726 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
727 # values:
728 #
729 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
730 # every Subnetwork are allowed to Nat.
731 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
732 # (specified in the field nat64_subnetwork below)
733 #
734 #
735 # The default is NAT64_OPTION_UNSPECIFIED.
736 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
737 # Router.Nat section in this region can also enable NAT64 for any
738 # Subnetworks in this network. Other Router.Nat sections can still be
739 # present to enable NAT44 only.
740 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
741 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
742 # SubnetworkIpRangeToNatOption above.
743 { # Defines the IP ranges that want to use NAT for a subnetwork.
744 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
745 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
746 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
747 # is one of the values in source_ip_ranges_to_nat.
748 &quot;A String&quot;,
749 ],
750 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
751 # options of a single value are valid except
752 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
753 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
754 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
755 # Default: [ALL_IP_RANGES]
756 &quot;A String&quot;,
757 ],
758 },
759 ],
760 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
761 # if not set.
762 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
763 # Defaults to 120s if not set.
764 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
765 # not set.
766 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
767 # translation. If unspecified, it defaults to PUBLIC.
768 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
769 },
770 ],
771 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
772 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
773 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
774 # as part of resource payload.
775 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
776 # The field is allowed for INSERT
777 # only. The keys/values to set on the resource should be specified in
778 # either ID { : } or Namespaced format
779 # { : }.
780 # For example the following are valid inputs:
781 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
782 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
783 # Note:
784 # * Invalid combinations of ID &amp; namespaced format is not supported. For
785 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
786 # * Inconsistent format is not supported. For instance:
787 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
788 &quot;a_key&quot;: &quot;A String&quot;,
789 },
790 },
791 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
792 # You must specify this field as part of the HTTP request URL. It is
793 # not settable as a field in the request body.
794 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
795 },
796 ],
797 &quot;warning&quot;: { # Informational warning which replaces the list of routers when
798 # the list is empty.
799 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
800 # Engine returns NO_RESULTS_ON_PAGE if there
801 # are no results in the response.
802 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
803 # value format. For example:
804 #
805 # &quot;data&quot;: [
806 # {
807 # &quot;key&quot;: &quot;scope&quot;,
808 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
809 # }
810 {
811 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
812 # returned. For example, for warnings where there are no results in a list
813 # request for a particular zone, this key might be scope and
814 # the key value might be the zone name. Other examples might be a key
815 # indicating a deprecated resource and a suggested replacement, or a
816 # warning about invalid network settings (for example, if an instance
817 # attempts to perform IP forwarding but is not enabled for IP forwarding).
818 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
819 },
820 ],
821 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
822 },
823 },
824 },
825 &quot;kind&quot;: &quot;compute#routerAggregatedList&quot;, # Output only. Type of resource.
826 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
827 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
828 # the query parameter pageToken in the next list request.
829 # Subsequent list requests will have their own nextPageToken to
830 # continue paging through the results.
831 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
832 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
833 &quot;A String&quot;,
834 ],
835 &quot;warning&quot;: { # [Output Only] Informational warning message.
836 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
837 # Engine returns NO_RESULTS_ON_PAGE if there
838 # are no results in the response.
839 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
840 # value format. For example:
841 #
842 # &quot;data&quot;: [
843 # {
844 # &quot;key&quot;: &quot;scope&quot;,
845 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
846 # }
847 {
848 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
849 # returned. For example, for warnings where there are no results in a list
850 # request for a particular zone, this key might be scope and
851 # the key value might be the zone name. Other examples might be a key
852 # indicating a deprecated resource and a suggested replacement, or a
853 # warning about invalid network settings (for example, if an instance
854 # attempts to perform IP forwarding but is not enabled for IP forwarding).
855 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
856 },
857 ],
858 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
859 },
860 }</pre>
861 </div>
862
863 <div class="method">
864 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
865 <pre>Retrieves the next page of results.
866
867 Args:
868 previous_request: The request for the previous page. (required)
869 previous_response: The response from the request for the previous page. (required)
870
871 Returns:
872 A request object that you can call &#x27;execute()&#x27; on to request the next
873 page. Returns None if there are no more items in the collection.
874 </pre>
875 </div>
876
877 <div class="method">
878 <code class="details" id="close">close()</code>
879 <pre>Close httplib2 connections.</pre>
880 </div>
881
882 <div class="method">
883 <code class="details" id="delete">delete(project, region, router, requestId=None, x__xgafv=None)</code>
884 <pre>Deletes the specified Router resource.
885
886 Args:
887 project: string, Project ID for this request. (required)
888 region: string, Name of the region for this request. (required)
889 router: string, Name of the Router resource to delete. (required)
890 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
891 that if you must retry your request, the server will know to ignore the
892 request if it has already been completed.
893
894 For example, consider a situation where you make an initial request and
895 the request times out. If you make the request again with the same
896 request ID, the server can check if original operation with the same
897 request ID was received, and if so, will ignore the second request. This
898 prevents clients from accidentally creating duplicate commitments.
899
900 The request ID must be
901 a valid UUID with the exception that zero UUID is not supported
902 (00000000-0000-0000-0000-000000000000).
903 x__xgafv: string, V1 error format.
904 Allowed values
905 1 - v1 error format
906 2 - v2 error format
907
908 Returns:
909 An object of the form:
910
911 { # Represents an Operation resource.
912 #
913 # Google Compute Engine has three Operation resources:
914 #
915 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
916 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
917 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
918 #
919 # You can use an operation resource to manage asynchronous API requests.
920 # For more information, readHandling
921 # API responses.
922 #
923 # Operations can be global, regional or zonal.
924 #
925 # - For global operations, use the `globalOperations`
926 # resource.
927 # - For regional operations, use the
928 # `regionOperations` resource.
929 # - For zonal operations, use
930 # the `zoneOperations` resource.
931 #
932 #
933 #
934 # For more information, read
935 # Global, Regional, and Zonal Resources.
936 #
937 # Note that completed Operation resources have a limited
938 # retention period.
939 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
940 # Not present otherwise.
941 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
942 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
943 # set when the operation is created.
944 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
945 # text format.
946 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
947 # this field will be populated.
948 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
949 # operation.
950 {
951 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
952 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
953 # details. There is a set of defined message types to use for providing
954 # details.The syntax depends on the error code. For example,
955 # QuotaExceededInfo will have details when the error code is
956 # QUOTA_EXCEEDED.
957 {
958 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
959 #
960 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
961 # is not enabled:
962 #
963 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
964 # &quot;domain&quot;: &quot;googleapis.com&quot;
965 # &quot;metadata&quot;: {
966 # &quot;resource&quot;: &quot;projects/123&quot;,
967 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
968 # }
969 # }
970 #
971 # This response indicates that the pubsub.googleapis.com API is not enabled.
972 #
973 # Example of an error that is returned when attempting to create a Spanner
974 # instance in a region that is out of stock:
975 #
976 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
977 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
978 # &quot;metadata&quot;: {
979 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
980 # }
981 # }
982 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
983 # is typically the registered service name of the tool or product that
984 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
985 # generated by some common infrastructure, the error domain must be a
986 # globally unique value that identifies the infrastructure. For Google API
987 # infrastructure, the error domain is &quot;googleapis.com&quot;.
988 &quot;metadatas&quot;: { # Additional structured details about this error.
989 #
990 # Keys must match a regular expression of `a-z+` but should
991 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
992 # length. When identifying the current value of an exceeded limit, the units
993 # should be contained in the key, not the value. For example, rather than
994 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
995 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
996 # instances that can be created in a single (batch) request.
997 &quot;a_key&quot;: &quot;A String&quot;,
998 },
999 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1000 # proximate cause of the error. Error reasons are unique within a particular
1001 # domain of errors. This should be at most 63 characters and match a
1002 # regular expression of `A-Z+[A-Z0-9]`, which represents
1003 # UPPER_SNAKE_CASE.
1004 },
1005 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1006 #
1007 # For example, if a quota check failed with an error indicating the calling
1008 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1009 # directly to the right place in the developer console to flip the bit.
1010 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1011 { # Describes a URL link.
1012 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1013 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1014 },
1015 ],
1016 },
1017 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1018 # which can be attached to an RPC error.
1019 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1020 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1021 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1022 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1023 },
1024 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1025 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1026 &quot;a_key&quot;: &quot;A String&quot;,
1027 },
1028 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1029 # type or metric.
1030 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1031 # or metric.
1032 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1033 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1034 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1035 },
1036 },
1037 ],
1038 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1039 # This property is optional.
1040 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1041 },
1042 ],
1043 },
1044 &quot;getVersionOperationMetadata&quot;: {
1045 &quot;inlineSbomInfo&quot;: {
1046 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1047 # appropriate identifiers.
1048 &quot;a_key&quot;: &quot;A String&quot;,
1049 },
1050 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1051 # identifiers.
1052 &quot;a_key&quot;: &quot;A String&quot;,
1053 },
1054 },
1055 },
1056 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1057 # message that was returned, such as `NOT FOUND`.
1058 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1059 # status code that was returned. For example, a `404` means the
1060 # resource was not found.
1061 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1062 # defined by the server.
1063 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1064 # This value is inRFC3339
1065 # text format.
1066 &quot;instancesBulkInsertOperationMetadata&quot;: {
1067 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1068 # Example key: zones/us-central1-a
1069 &quot;a_key&quot;: {
1070 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1071 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1072 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1073 # error.
1074 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1075 # if the flow is rolling forward or rolling back.
1076 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1077 },
1078 },
1079 },
1080 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1081 # Operation resources.
1082 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1083 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1084 # group of operations results from a `bulkInsert` API request.
1085 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1086 # `update`, or `delete`, and so on.
1087 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1088 # There is no requirement that this be linear or support any granularity of
1089 # operations. This should not be used to guess when the operation will be
1090 # complete. This number should monotonically increase as the operation
1091 # progresses.
1092 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1093 # applicable when performing regional operations.
1094 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1095 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1096 # this field will contain information on all underlying zonal actions and
1097 # their state.
1098 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1099 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1100 # Example key: zones/us-central1-a
1101 &quot;a_key&quot;: {
1102 &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
1103 # populated.
1104 # different programming environments, including REST APIs and RPC APIs. It is
1105 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1106 # three pieces of data: error code, error message, and error details.
1107 #
1108 # You can find out more about this error model and how to work with it in the
1109 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1110 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1111 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1112 # message types for APIs to use.
1113 {
1114 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1115 },
1116 ],
1117 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1118 # user-facing error message should be localized and sent in the
1119 # google.rpc.Status.details field, or localized by the client.
1120 },
1121 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1122 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1123 },
1124 },
1125 },
1126 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1127 # This value is inRFC3339
1128 # text format.
1129 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1130 # following:
1131 # `PENDING`, `RUNNING`, or `DONE`.
1132 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1133 # operation.
1134 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1135 # of the target resource.
1136 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1137 # operations related to creating a snapshot, this points to the disk
1138 # that the snapshot was created from.
1139 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1140 # `[email protected]` or
1141 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1142 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1143 # operation, this field will be populated.
1144 {
1145 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1146 # Engine returns NO_RESULTS_ON_PAGE if there
1147 # are no results in the response.
1148 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1149 # value format. For example:
1150 #
1151 # &quot;data&quot;: [
1152 # {
1153 # &quot;key&quot;: &quot;scope&quot;,
1154 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1155 # }
1156 {
1157 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1158 # returned. For example, for warnings where there are no results in a list
1159 # request for a particular zone, this key might be scope and
1160 # the key value might be the zone name. Other examples might be a key
1161 # indicating a deprecated resource and a suggested replacement, or a
1162 # warning about invalid network settings (for example, if an instance
1163 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1164 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1165 },
1166 ],
1167 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1168 },
1169 ],
1170 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1171 # applicable when performing per-zone operations.
1172 }</pre>
1173 </div>
1174
1175 <div class="method">
1176 <code class="details" id="deleteNamedSet">deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)</code>
1177 <pre>Deletes Named Set
1178
1179 Args:
1180 project: string, Project ID for this request. (required)
1181 region: string, Name of the region for this request. (required)
1182 router: string, Name of the Router resource where Named Set is defined. (required)
1183 namedSet: string, The Named Set name for this request. Name must conform to RFC1035
1184 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1185 that if you must retry your request, the server will know to ignore the
1186 request if it has already been completed.
1187
1188 For example, consider a situation where you make an initial request and
1189 the request times out. If you make the request again with the same
1190 request ID, the server can check if original operation with the same
1191 request ID was received, and if so, will ignore the second request. This
1192 prevents clients from accidentally creating duplicate commitments.
1193
1194 The request ID must be
1195 a valid UUID with the exception that zero UUID is not supported
1196 (00000000-0000-0000-0000-000000000000).
1197 x__xgafv: string, V1 error format.
1198 Allowed values
1199 1 - v1 error format
1200 2 - v2 error format
1201
1202 Returns:
1203 An object of the form:
1204
1205 { # Represents an Operation resource.
1206 #
1207 # Google Compute Engine has three Operation resources:
1208 #
1209 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1210 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1211 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1212 #
1213 # You can use an operation resource to manage asynchronous API requests.
1214 # For more information, readHandling
1215 # API responses.
1216 #
1217 # Operations can be global, regional or zonal.
1218 #
1219 # - For global operations, use the `globalOperations`
1220 # resource.
1221 # - For regional operations, use the
1222 # `regionOperations` resource.
1223 # - For zonal operations, use
1224 # the `zoneOperations` resource.
1225 #
1226 #
1227 #
1228 # For more information, read
1229 # Global, Regional, and Zonal Resources.
1230 #
1231 # Note that completed Operation resources have a limited
1232 # retention period.
1233 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1234 # Not present otherwise.
1235 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1236 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1237 # set when the operation is created.
1238 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1239 # text format.
1240 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1241 # this field will be populated.
1242 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1243 # operation.
1244 {
1245 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1246 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1247 # details. There is a set of defined message types to use for providing
1248 # details.The syntax depends on the error code. For example,
1249 # QuotaExceededInfo will have details when the error code is
1250 # QUOTA_EXCEEDED.
1251 {
1252 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1253 #
1254 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1255 # is not enabled:
1256 #
1257 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1258 # &quot;domain&quot;: &quot;googleapis.com&quot;
1259 # &quot;metadata&quot;: {
1260 # &quot;resource&quot;: &quot;projects/123&quot;,
1261 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1262 # }
1263 # }
1264 #
1265 # This response indicates that the pubsub.googleapis.com API is not enabled.
1266 #
1267 # Example of an error that is returned when attempting to create a Spanner
1268 # instance in a region that is out of stock:
1269 #
1270 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1271 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1272 # &quot;metadata&quot;: {
1273 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1274 # }
1275 # }
1276 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1277 # is typically the registered service name of the tool or product that
1278 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1279 # generated by some common infrastructure, the error domain must be a
1280 # globally unique value that identifies the infrastructure. For Google API
1281 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1282 &quot;metadatas&quot;: { # Additional structured details about this error.
1283 #
1284 # Keys must match a regular expression of `a-z+` but should
1285 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1286 # length. When identifying the current value of an exceeded limit, the units
1287 # should be contained in the key, not the value. For example, rather than
1288 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1289 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1290 # instances that can be created in a single (batch) request.
1291 &quot;a_key&quot;: &quot;A String&quot;,
1292 },
1293 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1294 # proximate cause of the error. Error reasons are unique within a particular
1295 # domain of errors. This should be at most 63 characters and match a
1296 # regular expression of `A-Z+[A-Z0-9]`, which represents
1297 # UPPER_SNAKE_CASE.
1298 },
1299 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1300 #
1301 # For example, if a quota check failed with an error indicating the calling
1302 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1303 # directly to the right place in the developer console to flip the bit.
1304 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1305 { # Describes a URL link.
1306 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1307 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1308 },
1309 ],
1310 },
1311 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1312 # which can be attached to an RPC error.
1313 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1314 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1315 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1316 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1317 },
1318 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1319 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1320 &quot;a_key&quot;: &quot;A String&quot;,
1321 },
1322 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1323 # type or metric.
1324 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1325 # or metric.
1326 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1327 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1328 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1329 },
1330 },
1331 ],
1332 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1333 # This property is optional.
1334 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1335 },
1336 ],
1337 },
1338 &quot;getVersionOperationMetadata&quot;: {
1339 &quot;inlineSbomInfo&quot;: {
1340 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1341 # appropriate identifiers.
1342 &quot;a_key&quot;: &quot;A String&quot;,
1343 },
1344 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1345 # identifiers.
1346 &quot;a_key&quot;: &quot;A String&quot;,
1347 },
1348 },
1349 },
1350 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1351 # message that was returned, such as `NOT FOUND`.
1352 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1353 # status code that was returned. For example, a `404` means the
1354 # resource was not found.
1355 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1356 # defined by the server.
1357 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1358 # This value is inRFC3339
1359 # text format.
1360 &quot;instancesBulkInsertOperationMetadata&quot;: {
1361 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1362 # Example key: zones/us-central1-a
1363 &quot;a_key&quot;: {
1364 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1365 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1366 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1367 # error.
1368 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1369 # if the flow is rolling forward or rolling back.
1370 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1371 },
1372 },
1373 },
1374 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1375 # Operation resources.
1376 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1377 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1378 # group of operations results from a `bulkInsert` API request.
1379 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1380 # `update`, or `delete`, and so on.
1381 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1382 # There is no requirement that this be linear or support any granularity of
1383 # operations. This should not be used to guess when the operation will be
1384 # complete. This number should monotonically increase as the operation
1385 # progresses.
1386 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1387 # applicable when performing regional operations.
1388 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1389 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1390 # this field will contain information on all underlying zonal actions and
1391 # their state.
1392 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1393 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1394 # Example key: zones/us-central1-a
1395 &quot;a_key&quot;: {
1396 &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
1397 # populated.
1398 # different programming environments, including REST APIs and RPC APIs. It is
1399 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1400 # three pieces of data: error code, error message, and error details.
1401 #
1402 # You can find out more about this error model and how to work with it in the
1403 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1404 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1405 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1406 # message types for APIs to use.
1407 {
1408 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1409 },
1410 ],
1411 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1412 # user-facing error message should be localized and sent in the
1413 # google.rpc.Status.details field, or localized by the client.
1414 },
1415 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1416 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1417 },
1418 },
1419 },
1420 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1421 # This value is inRFC3339
1422 # text format.
1423 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1424 # following:
1425 # `PENDING`, `RUNNING`, or `DONE`.
1426 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1427 # operation.
1428 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1429 # of the target resource.
1430 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1431 # operations related to creating a snapshot, this points to the disk
1432 # that the snapshot was created from.
1433 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1434 # `[email protected]` or
1435 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1436 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1437 # operation, this field will be populated.
1438 {
1439 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1440 # Engine returns NO_RESULTS_ON_PAGE if there
1441 # are no results in the response.
1442 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1443 # value format. For example:
1444 #
1445 # &quot;data&quot;: [
1446 # {
1447 # &quot;key&quot;: &quot;scope&quot;,
1448 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1449 # }
1450 {
1451 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1452 # returned. For example, for warnings where there are no results in a list
1453 # request for a particular zone, this key might be scope and
1454 # the key value might be the zone name. Other examples might be a key
1455 # indicating a deprecated resource and a suggested replacement, or a
1456 # warning about invalid network settings (for example, if an instance
1457 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1458 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1459 },
1460 ],
1461 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1462 },
1463 ],
1464 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1465 # applicable when performing per-zone operations.
1466 }</pre>
1467 </div>
1468
1469 <div class="method">
1470 <code class="details" id="deleteRoutePolicy">deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)</code>
1471 <pre>Deletes Route Policy
1472
1473 Args:
1474 project: string, Project ID for this request. (required)
1475 region: string, Name of the region for this request. (required)
1476 router: string, Name of the Router resource where Route Policy is defined. (required)
1477 policy: string, The Policy name for this request. Name must conform to RFC1035
1478 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1479 that if you must retry your request, the server will know to ignore the
1480 request if it has already been completed.
1481
1482 For example, consider a situation where you make an initial request and
1483 the request times out. If you make the request again with the same
1484 request ID, the server can check if original operation with the same
1485 request ID was received, and if so, will ignore the second request. This
1486 prevents clients from accidentally creating duplicate commitments.
1487
1488 The request ID must be
1489 a valid UUID with the exception that zero UUID is not supported
1490 (00000000-0000-0000-0000-000000000000).
1491 x__xgafv: string, V1 error format.
1492 Allowed values
1493 1 - v1 error format
1494 2 - v2 error format
1495
1496 Returns:
1497 An object of the form:
1498
1499 { # Represents an Operation resource.
1500 #
1501 # Google Compute Engine has three Operation resources:
1502 #
1503 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1504 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1505 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1506 #
1507 # You can use an operation resource to manage asynchronous API requests.
1508 # For more information, readHandling
1509 # API responses.
1510 #
1511 # Operations can be global, regional or zonal.
1512 #
1513 # - For global operations, use the `globalOperations`
1514 # resource.
1515 # - For regional operations, use the
1516 # `regionOperations` resource.
1517 # - For zonal operations, use
1518 # the `zoneOperations` resource.
1519 #
1520 #
1521 #
1522 # For more information, read
1523 # Global, Regional, and Zonal Resources.
1524 #
1525 # Note that completed Operation resources have a limited
1526 # retention period.
1527 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1528 # Not present otherwise.
1529 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1530 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1531 # set when the operation is created.
1532 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1533 # text format.
1534 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1535 # this field will be populated.
1536 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1537 # operation.
1538 {
1539 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1540 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1541 # details. There is a set of defined message types to use for providing
1542 # details.The syntax depends on the error code. For example,
1543 # QuotaExceededInfo will have details when the error code is
1544 # QUOTA_EXCEEDED.
1545 {
1546 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1547 #
1548 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1549 # is not enabled:
1550 #
1551 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1552 # &quot;domain&quot;: &quot;googleapis.com&quot;
1553 # &quot;metadata&quot;: {
1554 # &quot;resource&quot;: &quot;projects/123&quot;,
1555 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1556 # }
1557 # }
1558 #
1559 # This response indicates that the pubsub.googleapis.com API is not enabled.
1560 #
1561 # Example of an error that is returned when attempting to create a Spanner
1562 # instance in a region that is out of stock:
1563 #
1564 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1565 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1566 # &quot;metadata&quot;: {
1567 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1568 # }
1569 # }
1570 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1571 # is typically the registered service name of the tool or product that
1572 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1573 # generated by some common infrastructure, the error domain must be a
1574 # globally unique value that identifies the infrastructure. For Google API
1575 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1576 &quot;metadatas&quot;: { # Additional structured details about this error.
1577 #
1578 # Keys must match a regular expression of `a-z+` but should
1579 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1580 # length. When identifying the current value of an exceeded limit, the units
1581 # should be contained in the key, not the value. For example, rather than
1582 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1583 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1584 # instances that can be created in a single (batch) request.
1585 &quot;a_key&quot;: &quot;A String&quot;,
1586 },
1587 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1588 # proximate cause of the error. Error reasons are unique within a particular
1589 # domain of errors. This should be at most 63 characters and match a
1590 # regular expression of `A-Z+[A-Z0-9]`, which represents
1591 # UPPER_SNAKE_CASE.
1592 },
1593 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1594 #
1595 # For example, if a quota check failed with an error indicating the calling
1596 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1597 # directly to the right place in the developer console to flip the bit.
1598 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1599 { # Describes a URL link.
1600 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1601 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1602 },
1603 ],
1604 },
1605 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1606 # which can be attached to an RPC error.
1607 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1608 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1609 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1610 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1611 },
1612 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1613 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1614 &quot;a_key&quot;: &quot;A String&quot;,
1615 },
1616 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1617 # type or metric.
1618 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1619 # or metric.
1620 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1621 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1622 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1623 },
1624 },
1625 ],
1626 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1627 # This property is optional.
1628 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1629 },
1630 ],
1631 },
1632 &quot;getVersionOperationMetadata&quot;: {
1633 &quot;inlineSbomInfo&quot;: {
1634 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1635 # appropriate identifiers.
1636 &quot;a_key&quot;: &quot;A String&quot;,
1637 },
1638 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1639 # identifiers.
1640 &quot;a_key&quot;: &quot;A String&quot;,
1641 },
1642 },
1643 },
1644 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1645 # message that was returned, such as `NOT FOUND`.
1646 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1647 # status code that was returned. For example, a `404` means the
1648 # resource was not found.
1649 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1650 # defined by the server.
1651 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1652 # This value is inRFC3339
1653 # text format.
1654 &quot;instancesBulkInsertOperationMetadata&quot;: {
1655 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1656 # Example key: zones/us-central1-a
1657 &quot;a_key&quot;: {
1658 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1659 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1660 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1661 # error.
1662 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1663 # if the flow is rolling forward or rolling back.
1664 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1665 },
1666 },
1667 },
1668 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1669 # Operation resources.
1670 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1671 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1672 # group of operations results from a `bulkInsert` API request.
1673 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1674 # `update`, or `delete`, and so on.
1675 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1676 # There is no requirement that this be linear or support any granularity of
1677 # operations. This should not be used to guess when the operation will be
1678 # complete. This number should monotonically increase as the operation
1679 # progresses.
1680 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1681 # applicable when performing regional operations.
1682 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1683 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1684 # this field will contain information on all underlying zonal actions and
1685 # their state.
1686 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1687 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1688 # Example key: zones/us-central1-a
1689 &quot;a_key&quot;: {
1690 &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
1691 # populated.
1692 # different programming environments, including REST APIs and RPC APIs. It is
1693 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1694 # three pieces of data: error code, error message, and error details.
1695 #
1696 # You can find out more about this error model and how to work with it in the
1697 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1698 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1699 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1700 # message types for APIs to use.
1701 {
1702 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1703 },
1704 ],
1705 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1706 # user-facing error message should be localized and sent in the
1707 # google.rpc.Status.details field, or localized by the client.
1708 },
1709 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1710 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1711 },
1712 },
1713 },
1714 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1715 # This value is inRFC3339
1716 # text format.
1717 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1718 # following:
1719 # `PENDING`, `RUNNING`, or `DONE`.
1720 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1721 # operation.
1722 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1723 # of the target resource.
1724 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1725 # operations related to creating a snapshot, this points to the disk
1726 # that the snapshot was created from.
1727 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1728 # `[email protected]` or
1729 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1730 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1731 # operation, this field will be populated.
1732 {
1733 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1734 # Engine returns NO_RESULTS_ON_PAGE if there
1735 # are no results in the response.
1736 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1737 # value format. For example:
1738 #
1739 # &quot;data&quot;: [
1740 # {
1741 # &quot;key&quot;: &quot;scope&quot;,
1742 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1743 # }
1744 {
1745 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1746 # returned. For example, for warnings where there are no results in a list
1747 # request for a particular zone, this key might be scope and
1748 # the key value might be the zone name. Other examples might be a key
1749 # indicating a deprecated resource and a suggested replacement, or a
1750 # warning about invalid network settings (for example, if an instance
1751 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1752 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1753 },
1754 ],
1755 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1756 },
1757 ],
1758 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1759 # applicable when performing per-zone operations.
1760 }</pre>
1761 </div>
1762
1763 <div class="method">
1764 <code class="details" id="get">get(project, region, router, x__xgafv=None)</code>
1765 <pre>Returns the specified Router resource.
1766
1767 Args:
1768 project: string, Project ID for this request. (required)
1769 region: string, Name of the region for this request. (required)
1770 router: string, Name of the Router resource to return. (required)
1771 x__xgafv: string, V1 error format.
1772 Allowed values
1773 1 - v1 error format
1774 2 - v2 error format
1775
1776 Returns:
1777 An object of the form:
1778
1779 { # Represents a Cloud Router resource.
1780 #
1781 # For more information about Cloud Router, read theCloud
1782 # Router overview.
1783 &quot;bgp&quot;: { # BGP information specific to this router.
1784 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
1785 # The options are DEFAULT or CUSTOM.
1786 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
1787 # This field can only be populated if advertise_mode is CUSTOM and
1788 # is advertised to all peers of the router.
1789 # These groups will be advertised in addition to any specified prefixes.
1790 # Leave this field blank to advertise no custom groups.
1791 &quot;A String&quot;,
1792 ],
1793 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
1794 # This field can only be populated if advertise_mode is CUSTOM and
1795 # is advertised to all peers of the router.
1796 # These IP ranges will be advertised in addition to any specified groups.
1797 # Leave this field blank to advertise no custom IP ranges.
1798 { # Description-tagged IP ranges for the router to advertise.
1799 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
1800 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
1801 },
1802 ],
1803 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
1804 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
1805 # value will be fixed for this router resource. All VPN tunnels that link
1806 # to this router will have the same local ASN.
1807 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
1808 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
1809 # least /30, even if the BGP sessions are over IPv6. It must not overlap
1810 # with any IPv4 BGP session ranges.
1811 #
1812 #
1813 # Other vendors commonly call this &quot;router ID&quot;.
1814 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
1815 # sent to the peer.
1816 #
1817 #
1818 # Hold time is three times the interval at which keepalive messages are
1819 # sent, and the hold time is the maximum number of seconds allowed to
1820 # elapse between successive keepalive messages that BGP receives from a
1821 # peer.
1822 #
1823 #
1824 # BGP will use the smaller of either the local hold time value or the
1825 # peer&#x27;s hold time value as the hold time for the BGP connection between
1826 # the two peers.
1827 #
1828 #
1829 # If set, this value must be between 20 and 60. The default is 20.
1830 },
1831 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
1832 # establish BGP peering. This information must specify the peer ASN and
1833 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
1834 {
1835 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
1836 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
1837 # which currently supports the following option:
1838 #
1839 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
1840 # excludes any routes learned for subnets that use
1841 # VPC Network Peering.
1842 #
1843 #
1844 # Note that this field can only be populated if advertise_mode is CUSTOM
1845 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
1846 # These groups are advertised in addition to any specified prefixes.
1847 # Leave this field blank to advertise no custom groups.
1848 &quot;A String&quot;,
1849 ],
1850 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
1851 # This field can only be populated if advertise_mode is CUSTOM and
1852 # overrides the list defined for the router (in the &quot;bgp&quot; message).
1853 # These IP ranges are advertised in addition to any specified groups.
1854 # Leave this field blank to advertise no custom IP ranges.
1855 { # Description-tagged IP ranges for the router to advertise.
1856 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
1857 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
1858 },
1859 ],
1860 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
1861 # than one matching route of maximum length, the routes with the lowest
1862 # priority value win.
1863 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
1864 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
1865 # received from the peer router. The actual value is negotiated between
1866 # the two routers and is equal to the greater of this value and the
1867 # transmit interval of the other router.
1868 #
1869 #
1870 # If set, this value must be between 1000 and 30000.
1871 #
1872 #
1873 # The default is 1000.
1874 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
1875 # transmitted to the peer router. The actual value is negotiated between
1876 # the two routers and is equal to the greater of this value and the
1877 # corresponding receive interval of the other router.
1878 #
1879 #
1880 # If set, this value must be between 1000 and 30000.
1881 #
1882 #
1883 # The default is 1000.
1884 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
1885 # before BFD declares that a peer is unavailable.
1886 #
1887 #
1888 # If set, the value must be a value between 5 and 16.
1889 #
1890 #
1891 # The default is 5.
1892 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
1893 #
1894 #
1895 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
1896 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
1897 # peer router to initiate the BFD session for this BGP peer. If set to
1898 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
1899 },
1900 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
1901 # session.
1902 {
1903 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
1904 # CIDR-formatted prefix. If an IP address is provided without a subnet
1905 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
1906 # range, and, for IPv6, `/128`.
1907 },
1908 ],
1909 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
1910 # value is applied to all custom learned route ranges for the session.
1911 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
1912 # value, Google Cloud assigns a priority of `100` to the ranges.
1913 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
1914 #
1915 #
1916 # If set to FALSE, any active session with the peer is terminated and
1917 # all associated routing information is removed. If set to TRUE, the
1918 # peer connection can be established with routing information. The default
1919 # is TRUE.
1920 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
1921 # the peerIpAddress is version 4.
1922 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
1923 # peerIpAddress is version 6.
1924 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
1925 # evaluated. The name must correspond to an existing policy that has
1926 # ROUTE_POLICY_TYPE_EXPORT type.
1927 &quot;A String&quot;,
1928 ],
1929 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
1930 # evaluated. The name must correspond to an existing policy that has
1931 # ROUTE_POLICY_TYPE_IMPORT type.
1932 &quot;A String&quot;,
1933 ],
1934 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
1935 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
1936 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
1937 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
1938 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
1939 #
1940 # - MANAGED_BY_USER is the default value and can be managed by you
1941 # or other users
1942 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
1943 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
1944 # PARTNER. Google automatically creates, updates, and deletes this type of
1945 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
1946 # or deleted.
1947 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
1948 # name of one of the entries in the Router.md5_authentication_keys. The
1949 # field must comply with RFC1035.
1950 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
1951 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
1952 # characters long and match the regular expression
1953 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
1954 # lowercase letter, and all following characters must be a dash, lowercase
1955 # letter, or digit, except the last character, which cannot be a dash.
1956 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
1957 # a different value.
1958 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
1959 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
1960 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
1961 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
1962 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
1963 # Appliances. The VM instance must be located in zones contained in the
1964 # same region as this Cloud Router.
1965 # The VM instance is the peer side of the BGP session.
1966 },
1967 ],
1968 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1969 # text format.
1970 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1971 # create the resource.
1972 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
1973 # attachments (interconnectAttachments).
1974 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1975 # defined by the server.
1976 &quot;interfaces&quot;: [ # Router interfaces.
1977 # To create a BGP peer that uses a router interface,
1978 # the interface must have one of the following fields specified:
1979 #
1980 # - linkedVpnTunnel
1981 # - linkedInterconnectAttachment
1982 # - subnetwork
1983 #
1984 #
1985 # You can create a router interface without any of these fields specified.
1986 # However, you cannot create a BGP peer that uses that interface.
1987 {
1988 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
1989 #
1990 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
1991 # be a CIDR-formatted string, for example, 169.254.0.1/30.
1992 # Note: Do not truncate the IP address, as it represents the IP address of
1993 # the interface.
1994 # - For Internet Protocol version 6 (IPv6), the value
1995 # must be a unique local address (ULA) range from fdff:1::/64
1996 # with a mask length of 126 or less. This value should be a CIDR-formatted
1997 # string, for example, fdff:1::1/112. Within the router&#x27;s
1998 # VPC, this IPv6 prefix will be reserved exclusively for this connection
1999 # and cannot be used for any other purpose.
2000 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
2001 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
2002 # as the router. Each interface can have one linked resource, which can be
2003 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
2004 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
2005 # router. Each interface can have one linked resource, which can be
2006 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
2007 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
2008 #
2009 # - MANAGED_BY_USER is the default value and can be managed directly
2010 # by users.
2011 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
2012 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
2013 # of type PARTNER. Google automatically creates, updates, and deletes
2014 # this type of interface when the PARTNER InterconnectAttachment is
2015 # created, updated, or deleted.
2016 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
2017 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
2018 # characters long and match the regular expression
2019 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
2020 # lowercase letter, and all following characters must be a dash, lowercase
2021 # letter, or digit, except the last character, which cannot be a dash.
2022 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
2023 # BGP sessions to a VM instance acting as a third-party
2024 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
2025 # an SD-WAN VM.
2026 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
2027 # you are creating. The redundantInterface must belong to the same Cloud
2028 # Router as the interface here. To establish the BGP session to a Router
2029 # Appliance VM, you must create two BGP peers. The two BGP peers must be
2030 # attached to two separate interfaces that are redundant with each other.
2031 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
2032 # be 1-63 characters long and match the regular expression
2033 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
2034 # lowercase letter, and all following characters must be a dash, lowercase
2035 # letter, or digit, except the last character, which cannot be a dash.
2036 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
2037 # must be in the same region as the Cloud Router.
2038 # When you establish a BGP session to a VM instance using this interface,
2039 # the VM instance must belong to the same subnetwork as the subnetwork
2040 # specified here.
2041 },
2042 ],
2043 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
2044 # routers.
2045 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
2046 {
2047 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
2048 #
2049 # For patch and update calls, it can be skipped to
2050 # copy the value from the previous configuration. This is allowed if the
2051 # key with the same name existed before the operation. Maximum length is 80
2052 # characters. Can only contain printable ASCII characters.
2053 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
2054 #
2055 # Must be unique within a router. Must be referenced by exactly
2056 # one bgpPeer. Must comply withRFC1035.
2057 },
2058 ],
2059 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2060 # The name must be 1-63 characters long, and comply withRFC1035.
2061 # Specifically, the name must be 1-63 characters long and match the regular
2062 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2063 # character must be a lowercase letter, and all following characters must
2064 # be a dash, lowercase letter, or digit, except the last character, which
2065 # cannot be a dash.
2066 &quot;nats&quot;: [ # A list of NAT services created in this router.
2067 { # Represents a Nat resource. It enables the VMs within the specified
2068 # subnetworks to access Internet without external IP addresses. It specifies
2069 # a list of subnetworks (and the ranges within) that want to use NAT.
2070 # Customers can also provide the external IPs that would be used for NAT. GCP
2071 # would auto-allocate ephemeral IPs if no external IPs are provided.
2072 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
2073 # Must be one of: PREMIUM, STANDARD.
2074 # If not specified, then the current
2075 # project-level default tier is used.
2076 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
2077 # must be valid static external IPs that have been assigned to the NAT.
2078 # These IPs should be used for updating/patching a NAT only.
2079 &quot;A String&quot;,
2080 ],
2081 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
2082 # state. This value is equal to tcp_time_wait_timeout_sec.
2083 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
2084 # 120s. The field is output only.
2085 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
2086 #
2087 #
2088 # If not specified, it is disabled by default.
2089 #
2090 #
2091 # If set to true,
2092 #
2093 # - Dynamic Port Allocation will be enabled on this NAT
2094 # config.
2095 # - enableEndpointIndependentMapping cannot be set to true.
2096 # - If minPorts is set, minPortsPerVm must be set to a
2097 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
2098 # minimum of 32 ports will be allocated to a VM from this NAT
2099 # config.
2100 &quot;enableEndpointIndependentMapping&quot;: True or False,
2101 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
2102 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
2103 &quot;A String&quot;,
2104 ],
2105 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
2106 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
2107 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
2108 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
2109 # logs are exported for all connections handled by this NAT.
2110 # This option can take one of the following values:
2111 #
2112 # - ERRORS_ONLY: Export logs only for connection failures.
2113 # - TRANSLATIONS_ONLY: Export logs only for successful
2114 # connections.
2115 # - ALL: Export logs for all connections, successful and
2116 # unsuccessful.
2117 },
2118 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
2119 # Dynamic Port Allocation is enabled.
2120 #
2121 #
2122 # If Dynamic Port Allocation is not enabled, this field has no effect.
2123 #
2124 #
2125 # If Dynamic Port Allocation is enabled, and this field is set, it must be
2126 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
2127 # is not set.
2128 #
2129 #
2130 # If Dynamic Port Allocation is enabled and this field is not set,
2131 # a maximum of 65536 ports will be allocated to a VM from this NAT
2132 # config.
2133 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
2134 # set, a default number of ports is allocated to a VM. This is rounded
2135 # up to the nearest power of 2. For example, if the value of this field is
2136 # 50, at least 64 ports are allocated to a VM.
2137 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
2138 # The name must be 1-63 characters long and comply withRFC1035.
2139 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
2140 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
2141 # selected for the SubnetworkIpRangeToNat64Option above.
2142 { # Specifies a subnetwork to enable NAT64.
2143 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
2144 },
2145 ],
2146 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
2147 # values:
2148 #
2149 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
2150 # customers. When there are not enough specified Nat IPs, the Nat service
2151 # fails for new VMs.
2152 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
2153 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
2154 # be empty.
2155 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
2156 # addresses must be valid static external IP addresses assigned to the
2157 # project.
2158 &quot;A String&quot;,
2159 ],
2160 &quot;rules&quot;: [ # A list of rules associated with this NAT.
2161 {
2162 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
2163 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
2164 # addresses must be valid static external IP addresses assigned to the
2165 # project.
2166 # This field is used for public NAT.
2167 &quot;A String&quot;,
2168 ],
2169 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
2170 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
2171 # This field is used for private NAT.
2172 &quot;A String&quot;,
2173 ],
2174 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
2175 # must be valid static external IPs that have been assigned to the NAT.
2176 # These IPs should be used for updating/patching a NAT rule only.
2177 # This field is used for public NAT.
2178 &quot;A String&quot;,
2179 ],
2180 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
2181 # drained. This is only supported on patch/update, and these
2182 # subnetworks must have previously been used as active ranges in this
2183 # NAT Rule.
2184 # This field is used for private NAT.
2185 &quot;A String&quot;,
2186 ],
2187 },
2188 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
2189 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
2190 # from a VM is evaluated against. If it evaluates to true, the
2191 # corresponding `action` is enforced.
2192 #
2193 # The following examples are valid match expressions for public NAT:
2194 #
2195 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
2196 # &#x27;2.2.0.0/16&#x27;)`
2197 #
2198 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
2199 #
2200 # The following example is a valid match expression for private NAT:
2201 #
2202 # `nexthop.hub ==
2203 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
2204 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
2205 # must be a positive value between 0 and 65000, and
2206 # must be unique among rules within a NAT.
2207 },
2208 ],
2209 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
2210 #
2211 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
2212 # Subnetwork are allowed to Nat.
2213 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
2214 # in every Subnetwork are allowed to Nat.
2215 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
2216 # (specified in the field subnetwork below)
2217 #
2218 #
2219 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
2220 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
2221 # should not be any other Router.Nat section in any Router for this network
2222 # in this region.
2223 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
2224 # values:
2225 #
2226 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
2227 # every Subnetwork are allowed to Nat.
2228 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
2229 # (specified in the field nat64_subnetwork below)
2230 #
2231 #
2232 # The default is NAT64_OPTION_UNSPECIFIED.
2233 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
2234 # Router.Nat section in this region can also enable NAT64 for any
2235 # Subnetworks in this network. Other Router.Nat sections can still be
2236 # present to enable NAT44 only.
2237 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
2238 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
2239 # SubnetworkIpRangeToNatOption above.
2240 { # Defines the IP ranges that want to use NAT for a subnetwork.
2241 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
2242 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
2243 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
2244 # is one of the values in source_ip_ranges_to_nat.
2245 &quot;A String&quot;,
2246 ],
2247 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
2248 # options of a single value are valid except
2249 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
2250 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
2251 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
2252 # Default: [ALL_IP_RANGES]
2253 &quot;A String&quot;,
2254 ],
2255 },
2256 ],
2257 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
2258 # if not set.
2259 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
2260 # Defaults to 120s if not set.
2261 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
2262 # not set.
2263 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
2264 # translation. If unspecified, it defaults to PUBLIC.
2265 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
2266 },
2267 ],
2268 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
2269 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
2270 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2271 # as part of resource payload.
2272 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2273 # The field is allowed for INSERT
2274 # only. The keys/values to set on the resource should be specified in
2275 # either ID { : } or Namespaced format
2276 # { : }.
2277 # For example the following are valid inputs:
2278 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2279 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2280 # Note:
2281 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2282 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2283 # * Inconsistent format is not supported. For instance:
2284 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
2285 &quot;a_key&quot;: &quot;A String&quot;,
2286 },
2287 },
2288 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
2289 # You must specify this field as part of the HTTP request URL. It is
2290 # not settable as a field in the request body.
2291 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2292 }</pre>
2293 </div>
2294
2295 <div class="method">
2296 <code class="details" id="getNamedSet">getNamedSet(project, region, router, namedSet=None, x__xgafv=None)</code>
2297 <pre>Returns specified Named Set
2298
2299 Args:
2300 project: string, Project ID for this request. (required)
2301 region: string, Name of the region for this request. (required)
2302 router: string, Name of the Router resource to query for the named set. The name should
2303 conform to RFC1035. (required)
2304 namedSet: string, The Named Set name for this request. Name must conform to RFC1035
2305 x__xgafv: string, V1 error format.
2306 Allowed values
2307 1 - v1 error format
2308 2 - v2 error format
2309
2310 Returns:
2311 An object of the form:
2312
2313 {
2314 &quot;etag&quot;: &quot;A String&quot;, # end_interface: MixerGetResponseWithEtagBuilder
2315 &quot;resource&quot;: {
2316 &quot;description&quot;: &quot;A String&quot;, # An optional description of named set.
2317 &quot;elements&quot;: [ # CEL expressions that are comparable to constructs of this set&#x27;s type
2318 # (see Policy Language).
2319 { # Represents a textual expression in the Common Expression Language (CEL)
2320 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2321 # are documented at https://github.com/google/cel-spec.
2322 #
2323 # Example (Comparison):
2324 #
2325 # title: &quot;Summary size limit&quot;
2326 # description: &quot;Determines if a summary is less than 100 chars&quot;
2327 # expression: &quot;document.summary.size() &lt; 100&quot;
2328 #
2329 # Example (Equality):
2330 #
2331 # title: &quot;Requestor is owner&quot;
2332 # description: &quot;Determines if requestor is the document owner&quot;
2333 # expression: &quot;document.owner == request.auth.claims.email&quot;
2334 #
2335 # Example (Logic):
2336 #
2337 # title: &quot;Public documents&quot;
2338 # description: &quot;Determine whether the document should be publicly visible&quot;
2339 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2340 #
2341 # Example (Data Manipulation):
2342 #
2343 # title: &quot;Notification string&quot;
2344 # description: &quot;Create a notification string with a timestamp.&quot;
2345 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2346 #
2347 # The exact variables and functions that may be referenced within an expression
2348 # are determined by the service that evaluates it. See the service
2349 # documentation for additional information.
2350 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2351 # describes the expression, e.g. when hovered over it in a UI.
2352 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2353 # syntax.
2354 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2355 # reporting, e.g. a file name and a position in the file.
2356 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2357 # its purpose. This can be used e.g. in UIs which allow to enter the
2358 # expression.
2359 },
2360 ],
2361 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Named Set being applied to this Router, which is
2362 # essentially a hash of the Named Set used for optimistic locking.
2363 # The fingerprint is initially generated by Compute Engine and changes
2364 # after every request to modify or update the Named Set. You must always
2365 # provide an up-to-date fingerprint hash in order to update or change
2366 # labels.
2367 #
2368 # To see the latest fingerprint, make a getNamedSet() request
2369 # to retrieve a Named Set.
2370 &quot;name&quot;: &quot;A String&quot;, # This set&#x27;s name, which must be a resource ID segment and unique within all
2371 # named sets owned by the Router. Name should conform to RFC1035.
2372 &quot;type&quot;: &quot;A String&quot;, # This named set&#x27;s type
2373 },
2374 }</pre>
2375 </div>
2376
2377 <div class="method">
2378 <code class="details" id="getNatIpInfo">getNatIpInfo(project, region, router, natName=None, x__xgafv=None)</code>
2379 <pre>Retrieves runtime NAT IP information.
2380
2381 Args:
2382 project: string, Project ID for this request. (required)
2383 region: string, Name of the region for this request. (required)
2384 router: string, Name of the Router resource to query for Nat IP information. The name
2385 should conform to RFC1035. (required)
2386 natName: string, Name of the nat service to filter the NAT IP information.
2387 If it is omitted, all nats for this router will be returned.
2388 Name should conform to RFC1035.
2389 x__xgafv: string, V1 error format.
2390 Allowed values
2391 1 - v1 error format
2392 2 - v2 error format
2393
2394 Returns:
2395 An object of the form:
2396
2397 {
2398 &quot;result&quot;: [ # [Output Only] A list of NAT IP information.
2399 { # Contains NAT IP information of a NAT config (i.e. usage status, mode).
2400 &quot;natIpInfoMappings&quot;: [ # Output only. A list of all NAT IPs assigned to this NAT config.
2401 { # Contains information of a NAT IP.
2402 &quot;mode&quot;: &quot;A String&quot;, # Output only. Specifies whether NAT IP is auto or manual.
2403 &quot;natIp&quot;: &quot;A String&quot;, # Output only. NAT IP address. For example: 203.0.113.11.
2404 &quot;usage&quot;: &quot;A String&quot;, # Output only. Specifies whether NAT IP is currently serving at least one endpoint or
2405 # not.
2406 },
2407 ],
2408 &quot;natName&quot;: &quot;A String&quot;, # Output only. Name of the NAT config which the NAT IP belongs to.
2409 },
2410 ],
2411 }</pre>
2412 </div>
2413
2414 <div class="method">
2415 <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>
2416 <pre>Retrieves runtime Nat mapping information of VM endpoints.
2417
2418 Args:
2419 project: string, Project ID for this request. (required)
2420 region: string, Name of the region for this request. (required)
2421 router: string, Name of the Router resource to query for Nat Mapping information of
2422 VM endpoints. (required)
2423 filter: string, A filter expression that filters resources listed in the response. Most
2424 Compute resources support two types of filter expressions:
2425 expressions that support regular expressions and expressions that follow
2426 API improvement proposal AIP-160.
2427 These two types of filter expressions cannot be mixed in one request.
2428
2429 If you want to use AIP-160, your expression must specify the field name, an
2430 operator, and the value that you want to use for filtering. The value
2431 must be a string, a number, or a boolean. The operator
2432 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2433
2434 For example, if you are filtering Compute Engine instances, you can
2435 exclude instances named `example-instance` by specifying
2436 `name != example-instance`.
2437
2438 The `:*` comparison can be used to test whether a key has been defined.
2439 For example, to find all objects with `owner` label use:
2440 ```
2441 labels.owner:*
2442 ```
2443
2444 You can also filter nested fields. For example, you could specify
2445 `scheduling.automaticRestart = false` to include instances only
2446 if they are not scheduled for automatic restarts. You can use filtering
2447 on nested fields to filter based onresource labels.
2448
2449 To filter on multiple expressions, provide each separate expression within
2450 parentheses. For example:
2451 ```
2452 (scheduling.automaticRestart = true)
2453 (cpuPlatform = &quot;Intel Skylake&quot;)
2454 ```
2455 By default, each expression is an `AND` expression. However, you
2456 can include `AND` and `OR` expressions explicitly.
2457 For example:
2458 ```
2459 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2460 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2461 (scheduling.automaticRestart = true)
2462 ```
2463
2464 If you want to use a regular expression, use the `eq` (equal) or `ne`
2465 (not equal) operator against a single un-parenthesized expression with or
2466 without quotes or against multiple parenthesized expressions. Examples:
2467
2468 `fieldname eq unquoted literal`
2469 `fieldname eq &#x27;single quoted literal&#x27;`
2470 `fieldname eq &quot;double quoted literal&quot;`
2471 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2472
2473 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2474 The literal value must match the entire field.
2475
2476 For example, to filter for instances that do not end with name &quot;instance&quot;,
2477 you would use `name ne .*instance`.
2478
2479 You cannot combine constraints on multiple fields using regular
2480 expressions.
2481 maxResults: integer, The maximum number of results per page that should be returned.
2482 If the number of available results is larger than `maxResults`,
2483 Compute Engine returns a `nextPageToken` that can be used to get
2484 the next page of results in subsequent list requests. Acceptable values are
2485 `0` to `500`, inclusive. (Default: `500`)
2486 natName: string, Name of the nat service to filter the Nat Mapping information.
2487 If it is omitted, all nats for this router will be returned.
2488 Name should conform to RFC1035.
2489 orderBy: string, Sorts list results by a certain order. By default, results
2490 are returned in alphanumerical order based on the resource name.
2491
2492 You can also sort results in descending order based on the creation
2493 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2494 results based on the `creationTimestamp` field in
2495 reverse chronological order (newest result first). Use this to sort
2496 resources like operations so that the newest operation is returned first.
2497
2498 Currently, only sorting by `name` or
2499 `creationTimestamp desc` is supported.
2500 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2501 `nextPageToken` returned by a previous list request to get
2502 the next page of results.
2503 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2504 of failure. The default value is false.
2505
2506 For example, when partial success behavior is enabled, aggregatedList for a
2507 single zone scope either returns all resources in the zone or no resources,
2508 with an error code.
2509 x__xgafv: string, V1 error format.
2510 Allowed values
2511 1 - v1 error format
2512 2 - v2 error format
2513
2514 Returns:
2515 An object of the form:
2516
2517 { # Contains a list of VmEndpointNatMappings.
2518 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2519 # defined by the server.
2520 &quot;kind&quot;: &quot;compute#vmEndpointNatMappingsList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#vmEndpointNatMappingsList for lists of Nat mappings of
2521 # VM endpoints.
2522 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2523 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2524 # the query parameter pageToken in the next list request.
2525 # Subsequent list requests will have their own nextPageToken to
2526 # continue paging through the results.
2527 &quot;result&quot;: [ # [Output Only] A list of Nat mapping information of VM endpoints.
2528 { # Contain information of Nat mapping for a VM endpoint (i.e., NIC).
2529 &quot;instanceName&quot;: &quot;A String&quot;, # Output only. Name of the VM instance which the endpoint belongs to
2530 &quot;interfaceNatMappings&quot;: [
2531 { # Contain information of Nat mapping for an interface of this endpoint.
2532 &quot;drainNatIpPortRanges&quot;: [ # Output only. List of all drain IP:port-range mappings assigned to this interface.
2533 # These ranges are inclusive, that is, both the first and the last
2534 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2535 # &quot;1.1.1.1:2234-2234&quot;].
2536 &quot;A String&quot;,
2537 ],
2538 &quot;natIpPortRanges&quot;: [ # Output only. A list of all IP:port-range mappings assigned to this interface.
2539 # These ranges are inclusive, that is, both the first and the last
2540 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2541 # &quot;1.1.1.1:2234-2234&quot;].
2542 &quot;A String&quot;,
2543 ],
2544 &quot;numTotalDrainNatPorts&quot;: 42, # Output only. Total number of drain ports across all NAT IPs allocated to this
2545 # interface. It equals to the aggregated port number in the field
2546 # drain_nat_ip_port_ranges.
2547 &quot;numTotalNatPorts&quot;: 42, # Output only. Total number of ports across all NAT IPs allocated to this interface.
2548 # It equals to the aggregated port number in the field nat_ip_port_ranges.
2549 &quot;ruleMappings&quot;: [ # Output only. Information about mappings provided by rules in this NAT.
2550 { # Contains information of NAT Mappings provided by a NAT Rule.
2551 &quot;drainNatIpPortRanges&quot;: [ # Output only. List of all drain IP:port-range mappings assigned to this interface
2552 # by this rule.
2553 # These ranges are inclusive, that is, both the first and the last
2554 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2555 # &quot;1.1.1.1:2234-2234&quot;].
2556 &quot;A String&quot;,
2557 ],
2558 &quot;natIpPortRanges&quot;: [ # Output only. A list of all IP:port-range mappings assigned to this interface by this
2559 # rule.
2560 # These ranges are inclusive, that is, both the first and the last
2561 # ports can be used for NAT. Example: [&quot;2.2.2.2:12345-12355&quot;,
2562 # &quot;1.1.1.1:2234-2234&quot;].
2563 &quot;A String&quot;,
2564 ],
2565 &quot;numTotalDrainNatPorts&quot;: 42, # Output only. Total number of drain ports across all NAT IPs allocated to this
2566 # interface by this rule.
2567 # It equals the aggregated port number in the field
2568 # drain_nat_ip_port_ranges.
2569 &quot;numTotalNatPorts&quot;: 42, # Output only. Total number of ports across all NAT IPs allocated to this interface
2570 # by this rule.
2571 # It equals the aggregated port number in the field nat_ip_port_ranges.
2572 &quot;ruleNumber&quot;: 42, # Output only. Rule number of the NAT Rule.
2573 },
2574 ],
2575 &quot;sourceAliasIpRange&quot;: &quot;A String&quot;, # Output only. Alias IP range for this interface endpoint.
2576 # It will be a private (RFC 1918) IP range.
2577 # Examples: &quot;10.33.4.55/32&quot;, or &quot;192.168.5.0/24&quot;.
2578 &quot;sourceVirtualIp&quot;: &quot;A String&quot;, # Output only. Primary IP of the VM for this NIC.
2579 },
2580 ],
2581 },
2582 ],
2583 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2584 &quot;warning&quot;: { # [Output Only] Informational warning message.
2585 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2586 # Engine returns NO_RESULTS_ON_PAGE if there
2587 # are no results in the response.
2588 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2589 # value format. For example:
2590 #
2591 # &quot;data&quot;: [
2592 # {
2593 # &quot;key&quot;: &quot;scope&quot;,
2594 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2595 # }
2596 {
2597 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2598 # returned. For example, for warnings where there are no results in a list
2599 # request for a particular zone, this key might be scope and
2600 # the key value might be the zone name. Other examples might be a key
2601 # indicating a deprecated resource and a suggested replacement, or a
2602 # warning about invalid network settings (for example, if an instance
2603 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2604 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2605 },
2606 ],
2607 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2608 },
2609 }</pre>
2610 </div>
2611
2612 <div class="method">
2613 <code class="details" id="getNatMappingInfo_next">getNatMappingInfo_next()</code>
2614 <pre>Retrieves the next page of results.
2615
2616 Args:
2617 previous_request: The request for the previous page. (required)
2618 previous_response: The response from the request for the previous page. (required)
2619
2620 Returns:
2621 A request object that you can call &#x27;execute()&#x27; on to request the next
2622 page. Returns None if there are no more items in the collection.
2623 </pre>
2624 </div>
2625
2626 <div class="method">
2627 <code class="details" id="getRoutePolicy">getRoutePolicy(project, region, router, policy=None, x__xgafv=None)</code>
2628 <pre>Returns specified Route Policy
2629
2630 Args:
2631 project: string, Project ID for this request. (required)
2632 region: string, Name of the region for this request. (required)
2633 router: string, Name of the Router resource to query for the route policy. The name should
2634 conform to RFC1035. (required)
2635 policy: string, The Policy name for this request. Name must conform to RFC1035
2636 x__xgafv: string, V1 error format.
2637 Allowed values
2638 1 - v1 error format
2639 2 - v2 error format
2640
2641 Returns:
2642 An object of the form:
2643
2644 {
2645 &quot;resource&quot;: {
2646 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
2647 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
2648 # essentially a hash of the Route Policy used for optimistic locking.
2649 # The fingerprint is initially generated by Compute Engine and changes
2650 # after every request to modify or update Route Policy. You must always
2651 # provide an up-to-date fingerprint hash in order to update or change
2652 # labels.
2653 #
2654 # To see the latest fingerprint, make a getRoutePolicy() request
2655 # to retrieve a Route Policy.
2656 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
2657 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
2658 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
2659 # in order of priority). Order of policies is not retained and might change
2660 # when getting policy later.
2661 {
2662 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
2663 { # Represents a textual expression in the Common Expression Language (CEL)
2664 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2665 # are documented at https://github.com/google/cel-spec.
2666 #
2667 # Example (Comparison):
2668 #
2669 # title: &quot;Summary size limit&quot;
2670 # description: &quot;Determines if a summary is less than 100 chars&quot;
2671 # expression: &quot;document.summary.size() &lt; 100&quot;
2672 #
2673 # Example (Equality):
2674 #
2675 # title: &quot;Requestor is owner&quot;
2676 # description: &quot;Determines if requestor is the document owner&quot;
2677 # expression: &quot;document.owner == request.auth.claims.email&quot;
2678 #
2679 # Example (Logic):
2680 #
2681 # title: &quot;Public documents&quot;
2682 # description: &quot;Determine whether the document should be publicly visible&quot;
2683 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2684 #
2685 # Example (Data Manipulation):
2686 #
2687 # title: &quot;Notification string&quot;
2688 # description: &quot;Create a notification string with a timestamp.&quot;
2689 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2690 #
2691 # The exact variables and functions that may be referenced within an expression
2692 # are determined by the service that evaluates it. See the service
2693 # documentation for additional information.
2694 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2695 # describes the expression, e.g. when hovered over it in a UI.
2696 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2697 # syntax.
2698 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2699 # reporting, e.g. a file name and a position in the file.
2700 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2701 # its purpose. This can be used e.g. in UIs which allow to enter the
2702 # expression.
2703 },
2704 ],
2705 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
2706 # applies. When not set, the term applies to all
2707 # routes.
2708 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2709 # are documented at https://github.com/google/cel-spec.
2710 #
2711 # Example (Comparison):
2712 #
2713 # title: &quot;Summary size limit&quot;
2714 # description: &quot;Determines if a summary is less than 100 chars&quot;
2715 # expression: &quot;document.summary.size() &lt; 100&quot;
2716 #
2717 # Example (Equality):
2718 #
2719 # title: &quot;Requestor is owner&quot;
2720 # description: &quot;Determines if requestor is the document owner&quot;
2721 # expression: &quot;document.owner == request.auth.claims.email&quot;
2722 #
2723 # Example (Logic):
2724 #
2725 # title: &quot;Public documents&quot;
2726 # description: &quot;Determine whether the document should be publicly visible&quot;
2727 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2728 #
2729 # Example (Data Manipulation):
2730 #
2731 # title: &quot;Notification string&quot;
2732 # description: &quot;Create a notification string with a timestamp.&quot;
2733 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2734 #
2735 # The exact variables and functions that may be referenced within an expression
2736 # are determined by the service that evaluates it. See the service
2737 # documentation for additional information.
2738 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2739 # describes the expression, e.g. when hovered over it in a UI.
2740 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2741 # syntax.
2742 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2743 # reporting, e.g. a file name and a position in the file.
2744 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2745 # its purpose. This can be used e.g. in UIs which allow to enter the
2746 # expression.
2747 },
2748 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
2749 # (inclusive) and 2^31 (exclusive), and unique within the list.
2750 },
2751 ],
2752 &quot;type&quot;: &quot;A String&quot;,
2753 },
2754 }</pre>
2755 </div>
2756
2757 <div class="method">
2758 <code class="details" id="getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</code>
2759 <pre>Retrieves runtime information of the specified router.
2760
2761 Args:
2762 project: string, Project ID for this request. (required)
2763 region: string, Name of the region for this request. (required)
2764 router: string, Name of the Router resource to query. (required)
2765 x__xgafv: string, V1 error format.
2766 Allowed values
2767 1 - v1 error format
2768 2 - v2 error format
2769
2770 Returns:
2771 An object of the form:
2772
2773 {
2774 &quot;kind&quot;: &quot;compute#routerStatusResponse&quot;, # Output only. Type of resource.
2775 &quot;result&quot;: {
2776 &quot;bestRoutes&quot;: [ # A list of the best dynamic routes for this Cloud Router&#x27;s Virtual Private
2777 # Cloud (VPC) network in the same region as this Cloud Router.
2778 #
2779 # Lists all of the best routes per prefix that are programmed into this
2780 # region&#x27;s VPC data plane.
2781 #
2782 # When global dynamic routing mode is turned on in the VPC network, this list
2783 # can include cross-region dynamic routes from Cloud Routers in other
2784 # regions.
2785 { # Represents a Route resource.
2786 #
2787 # A route defines a path from VM instances in the VPC network to a specific
2788 # destination. This destination can be inside or outside the VPC network.
2789 # For more information, read theRoutes overview.
2790 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
2791 {
2792 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
2793 42,
2794 ],
2795 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
2796 # values:
2797 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
2798 # in has traversed
2799 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
2800 # systems that the route has traversed
2801 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
2802 # ordered set of Member Autonomous Systems in the local confederation that
2803 # the route has traversed
2804 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
2805 # Member Autonomous Systems in the local confederation that the route has
2806 # traversed
2807 },
2808 ],
2809 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2810 # text format.
2811 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
2812 # create the resource.
2813 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
2814 # IPv4 and IPv6 are supported.
2815 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
2816 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
2817 # compressed format.
2818 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2819 # defined by the server.
2820 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
2821 # Route resources.
2822 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2823 # The name must be 1-63 characters long, and comply withRFC1035.
2824 # Specifically, the name must be 1-63 characters long and match the regular
2825 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
2826 # lowercase letter, and all following characters (except for the last
2827 # character) must be a dash, lowercase letter, or digit. The last character
2828 # must be a lowercase letter or digit.
2829 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
2830 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
2831 # You can only specify the internet gateway using a full or
2832 # partial valid URL: projects/project/global/gateways/default-internet-gateway
2833 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
2834 # that will handle matching packets.
2835 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
2836 # packets or the IP address of the forwarding Rule.
2837 # For example, the following are all valid URLs:
2838 #
2839 #
2840 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
2841 # - regions/region/forwardingRules/forwardingRule
2842 #
2843 #
2844 # If an IP address is provided, must specify an IPv4 address in dot-decimal
2845 # notation or an IPv6 address in RFC 4291 format. For example, the following
2846 # are all valid IP addresses:
2847 #
2848 #
2849 # - 10.128.0.56
2850 # - 2001:db8::2d9:51:0:0
2851 # - 2001:db8:0:0:2d9:51:0:0
2852 #
2853 #
2854 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
2855 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
2856 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
2857 # this as a full or partial URL.
2858 # For example:
2859 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
2860 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
2861 # calculates based on factors such as network performance, distance, and
2862 # available bandwidth between regions.
2863 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
2864 # for the route.
2865 # This field will only be populated for dynamic routes generated by
2866 # Cloud Router with a linked interconnectAttachment or the static route
2867 # generated by each L2 Interconnect Attachment.
2868 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
2869 # Both IPv6 address and IPv4 addresses are supported.
2870 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
2871 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
2872 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
2873 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
2874 # IPv4-mapped IPv6 address.
2875 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
2876 # the desirability of a particular route in a network.
2877 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
2878 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
2879 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
2880 # or INCOMPLETE.
2881 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
2882 # which should conform to RFC1035.
2883 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
2884 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2885 # as part of resource payload.
2886 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2887 # Tag keys and values have the same definition as resource
2888 # manager tags. The field is allowed for INSERT
2889 # only. The keys/values to set on the resource should be specified in
2890 # either ID { : } or Namespaced format
2891 # { : }.
2892 # For example the following are valid inputs:
2893 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2894 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2895 # Note:
2896 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2897 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2898 &quot;a_key&quot;: &quot;A String&quot;,
2899 },
2900 },
2901 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
2902 # where there is more than one matching route of equal prefix length. In
2903 # cases where multiple routes have equal prefix length, the one with the
2904 # lowest-numbered priority value wins. The default value is `1000`. The
2905 # priority value must be from `0` to `65535`, inclusive.
2906 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
2907 # dynamic routes learned by Cloud Routers. It is also applicable to routes
2908 # undergoing migration.
2909 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
2910 # values:
2911 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
2912 # another Cloud Router and will readvertise to one of its BGP peers
2913 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
2914 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
2915 # - &#x27;STATIC&#x27; for a static route
2916 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
2917 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
2918 &quot;A String&quot;,
2919 ],
2920 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
2921 # route, this field will be populated with warning messages.
2922 {
2923 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2924 # Engine returns NO_RESULTS_ON_PAGE if there
2925 # are no results in the response.
2926 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2927 # value format. For example:
2928 #
2929 # &quot;data&quot;: [
2930 # {
2931 # &quot;key&quot;: &quot;scope&quot;,
2932 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2933 # }
2934 {
2935 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2936 # returned. For example, for warnings where there are no results in a list
2937 # request for a particular zone, this key might be scope and
2938 # the key value might be the zone name. Other examples might be a key
2939 # indicating a deprecated resource and a suggested replacement, or a
2940 # warning about invalid network settings (for example, if an instance
2941 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2942 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2943 },
2944 ],
2945 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2946 },
2947 ],
2948 },
2949 ],
2950 &quot;bestRoutesForRouter&quot;: [ # A list of the best BGP routes learned by this Cloud Router.
2951 #
2952 # It is possible that routes listed might not be programmed into the data
2953 # plane, if the Google Cloud control plane finds a more optimal route for a
2954 # prefix than a route learned by this Cloud Router.
2955 { # Represents a Route resource.
2956 #
2957 # A route defines a path from VM instances in the VPC network to a specific
2958 # destination. This destination can be inside or outside the VPC network.
2959 # For more information, read theRoutes overview.
2960 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
2961 {
2962 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
2963 42,
2964 ],
2965 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
2966 # values:
2967 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
2968 # in has traversed
2969 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
2970 # systems that the route has traversed
2971 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
2972 # ordered set of Member Autonomous Systems in the local confederation that
2973 # the route has traversed
2974 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
2975 # Member Autonomous Systems in the local confederation that the route has
2976 # traversed
2977 },
2978 ],
2979 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2980 # text format.
2981 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
2982 # create the resource.
2983 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
2984 # IPv4 and IPv6 are supported.
2985 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
2986 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
2987 # compressed format.
2988 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2989 # defined by the server.
2990 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
2991 # Route resources.
2992 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2993 # The name must be 1-63 characters long, and comply withRFC1035.
2994 # Specifically, the name must be 1-63 characters long and match the regular
2995 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
2996 # lowercase letter, and all following characters (except for the last
2997 # character) must be a dash, lowercase letter, or digit. The last character
2998 # must be a lowercase letter or digit.
2999 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
3000 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
3001 # You can only specify the internet gateway using a full or
3002 # partial valid URL: projects/project/global/gateways/default-internet-gateway
3003 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
3004 # that will handle matching packets.
3005 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
3006 # packets or the IP address of the forwarding Rule.
3007 # For example, the following are all valid URLs:
3008 #
3009 #
3010 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3011 # - regions/region/forwardingRules/forwardingRule
3012 #
3013 #
3014 # If an IP address is provided, must specify an IPv4 address in dot-decimal
3015 # notation or an IPv6 address in RFC 4291 format. For example, the following
3016 # are all valid IP addresses:
3017 #
3018 #
3019 # - 10.128.0.56
3020 # - 2001:db8::2d9:51:0:0
3021 # - 2001:db8:0:0:2d9:51:0:0
3022 #
3023 #
3024 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
3025 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
3026 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
3027 # this as a full or partial URL.
3028 # For example:
3029 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
3030 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
3031 # calculates based on factors such as network performance, distance, and
3032 # available bandwidth between regions.
3033 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
3034 # for the route.
3035 # This field will only be populated for dynamic routes generated by
3036 # Cloud Router with a linked interconnectAttachment or the static route
3037 # generated by each L2 Interconnect Attachment.
3038 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
3039 # Both IPv6 address and IPv4 addresses are supported.
3040 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
3041 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
3042 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
3043 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
3044 # IPv4-mapped IPv6 address.
3045 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
3046 # the desirability of a particular route in a network.
3047 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
3048 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
3049 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
3050 # or INCOMPLETE.
3051 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
3052 # which should conform to RFC1035.
3053 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
3054 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3055 # as part of resource payload.
3056 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3057 # Tag keys and values have the same definition as resource
3058 # manager tags. The field is allowed for INSERT
3059 # only. The keys/values to set on the resource should be specified in
3060 # either ID { : } or Namespaced format
3061 # { : }.
3062 # For example the following are valid inputs:
3063 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3064 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3065 # Note:
3066 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3067 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3068 &quot;a_key&quot;: &quot;A String&quot;,
3069 },
3070 },
3071 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
3072 # where there is more than one matching route of equal prefix length. In
3073 # cases where multiple routes have equal prefix length, the one with the
3074 # lowest-numbered priority value wins. The default value is `1000`. The
3075 # priority value must be from `0` to `65535`, inclusive.
3076 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
3077 # dynamic routes learned by Cloud Routers. It is also applicable to routes
3078 # undergoing migration.
3079 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
3080 # values:
3081 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
3082 # another Cloud Router and will readvertise to one of its BGP peers
3083 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
3084 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
3085 # - &#x27;STATIC&#x27; for a static route
3086 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
3087 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
3088 &quot;A String&quot;,
3089 ],
3090 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
3091 # route, this field will be populated with warning messages.
3092 {
3093 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3094 # Engine returns NO_RESULTS_ON_PAGE if there
3095 # are no results in the response.
3096 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3097 # value format. For example:
3098 #
3099 # &quot;data&quot;: [
3100 # {
3101 # &quot;key&quot;: &quot;scope&quot;,
3102 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3103 # }
3104 {
3105 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3106 # returned. For example, for warnings where there are no results in a list
3107 # request for a particular zone, this key might be scope and
3108 # the key value might be the zone name. Other examples might be a key
3109 # indicating a deprecated resource and a suggested replacement, or a
3110 # warning about invalid network settings (for example, if an instance
3111 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3112 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3113 },
3114 ],
3115 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3116 },
3117 ],
3118 },
3119 ],
3120 &quot;bgpPeerStatus&quot;: [
3121 {
3122 &quot;advertisedRoutes&quot;: [ # Routes that were advertised to the remote BGP peer
3123 { # Represents a Route resource.
3124 #
3125 # A route defines a path from VM instances in the VPC network to a specific
3126 # destination. This destination can be inside or outside the VPC network.
3127 # For more information, read theRoutes overview.
3128 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
3129 {
3130 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
3131 42,
3132 ],
3133 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
3134 # values:
3135 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
3136 # in has traversed
3137 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
3138 # systems that the route has traversed
3139 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
3140 # ordered set of Member Autonomous Systems in the local confederation that
3141 # the route has traversed
3142 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
3143 # Member Autonomous Systems in the local confederation that the route has
3144 # traversed
3145 },
3146 ],
3147 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3148 # text format.
3149 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
3150 # create the resource.
3151 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
3152 # IPv4 and IPv6 are supported.
3153 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
3154 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
3155 # compressed format.
3156 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3157 # defined by the server.
3158 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
3159 # Route resources.
3160 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3161 # The name must be 1-63 characters long, and comply withRFC1035.
3162 # Specifically, the name must be 1-63 characters long and match the regular
3163 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
3164 # lowercase letter, and all following characters (except for the last
3165 # character) must be a dash, lowercase letter, or digit. The last character
3166 # must be a lowercase letter or digit.
3167 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
3168 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
3169 # You can only specify the internet gateway using a full or
3170 # partial valid URL: projects/project/global/gateways/default-internet-gateway
3171 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
3172 # that will handle matching packets.
3173 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
3174 # packets or the IP address of the forwarding Rule.
3175 # For example, the following are all valid URLs:
3176 #
3177 #
3178 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
3179 # - regions/region/forwardingRules/forwardingRule
3180 #
3181 #
3182 # If an IP address is provided, must specify an IPv4 address in dot-decimal
3183 # notation or an IPv6 address in RFC 4291 format. For example, the following
3184 # are all valid IP addresses:
3185 #
3186 #
3187 # - 10.128.0.56
3188 # - 2001:db8::2d9:51:0:0
3189 # - 2001:db8:0:0:2d9:51:0:0
3190 #
3191 #
3192 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
3193 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
3194 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
3195 # this as a full or partial URL.
3196 # For example:
3197 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
3198 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
3199 # calculates based on factors such as network performance, distance, and
3200 # available bandwidth between regions.
3201 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
3202 # for the route.
3203 # This field will only be populated for dynamic routes generated by
3204 # Cloud Router with a linked interconnectAttachment or the static route
3205 # generated by each L2 Interconnect Attachment.
3206 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
3207 # Both IPv6 address and IPv4 addresses are supported.
3208 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
3209 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
3210 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
3211 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
3212 # IPv4-mapped IPv6 address.
3213 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
3214 # the desirability of a particular route in a network.
3215 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
3216 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
3217 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
3218 # or INCOMPLETE.
3219 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
3220 # which should conform to RFC1035.
3221 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
3222 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3223 # as part of resource payload.
3224 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3225 # Tag keys and values have the same definition as resource
3226 # manager tags. The field is allowed for INSERT
3227 # only. The keys/values to set on the resource should be specified in
3228 # either ID { : } or Namespaced format
3229 # { : }.
3230 # For example the following are valid inputs:
3231 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3232 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3233 # Note:
3234 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3235 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3236 &quot;a_key&quot;: &quot;A String&quot;,
3237 },
3238 },
3239 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
3240 # where there is more than one matching route of equal prefix length. In
3241 # cases where multiple routes have equal prefix length, the one with the
3242 # lowest-numbered priority value wins. The default value is `1000`. The
3243 # priority value must be from `0` to `65535`, inclusive.
3244 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
3245 # dynamic routes learned by Cloud Routers. It is also applicable to routes
3246 # undergoing migration.
3247 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
3248 # values:
3249 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
3250 # another Cloud Router and will readvertise to one of its BGP peers
3251 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
3252 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
3253 # - &#x27;STATIC&#x27; for a static route
3254 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
3255 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
3256 &quot;A String&quot;,
3257 ],
3258 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
3259 # route, this field will be populated with warning messages.
3260 {
3261 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3262 # Engine returns NO_RESULTS_ON_PAGE if there
3263 # are no results in the response.
3264 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3265 # value format. For example:
3266 #
3267 # &quot;data&quot;: [
3268 # {
3269 # &quot;key&quot;: &quot;scope&quot;,
3270 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3271 # }
3272 {
3273 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3274 # returned. For example, for warnings where there are no results in a list
3275 # request for a particular zone, this key might be scope and
3276 # the key value might be the zone name. Other examples might be a key
3277 # indicating a deprecated resource and a suggested replacement, or a
3278 # warning about invalid network settings (for example, if an instance
3279 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3280 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3281 },
3282 ],
3283 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3284 },
3285 ],
3286 },
3287 ],
3288 &quot;bfdStatus&quot;: { # Next free: 15
3289 &quot;bfdSessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
3290 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
3291 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
3292 # peer router to initiate the BFD session for this BGP peer. If set to
3293 # DISABLED, BFD is disabled for this BGP peer.
3294 &quot;configUpdateTimestampMicros&quot;: &quot;A String&quot;, # Unix timestamp of the most recent config update.
3295 &quot;controlPacketCounts&quot;: { # Control packet counts for the current BFD session.
3296 &quot;numRx&quot;: 42, # Number of packets received since the beginning of the current BFD
3297 # session.
3298 &quot;numRxRejected&quot;: 42, # Number of packets received that were rejected because of errors since the
3299 # beginning of the current BFD session.
3300 &quot;numRxSuccessful&quot;: 42, # Number of packets received that were successfully processed since the
3301 # beginning of the current BFD session.
3302 &quot;numTx&quot;: 42, # Number of packets transmitted since the beginning of the current BFD
3303 # session.
3304 },
3305 &quot;controlPacketIntervals&quot;: [ # Inter-packet time interval statistics for control packets.
3306 { # Next free: 7
3307 &quot;avgMs&quot;: &quot;A String&quot;, # Average observed inter-packet interval in milliseconds.
3308 &quot;duration&quot;: &quot;A String&quot;, # From how long ago in the past these intervals were observed.
3309 &quot;maxMs&quot;: &quot;A String&quot;, # Maximum observed inter-packet interval in milliseconds.
3310 &quot;minMs&quot;: &quot;A String&quot;, # Minimum observed inter-packet interval in milliseconds.
3311 &quot;numIntervals&quot;: &quot;A String&quot;, # Number of inter-packet intervals from which these statistics were derived.
3312 &quot;type&quot;: &quot;A String&quot;, # The type of packets for which inter-packet intervals were computed.
3313 },
3314 ],
3315 &quot;localDiagnostic&quot;: &quot;A String&quot;, # The diagnostic code specifies the local system&#x27;s reason for the last change
3316 # in session state. This allows remote systems to determine the reason that
3317 # the previous session failed, for example. These diagnostic codes are
3318 # specified in section 4.1 ofRFC5880
3319 &quot;localState&quot;: &quot;A String&quot;, # The current BFD session state as seen by the transmitting system. These
3320 # states are specified in section 4.1 ofRFC5880
3321 &quot;negotiatedLocalControlTxIntervalMs&quot;: 42, # Negotiated transmit interval for control packets.
3322 &quot;rxPacket&quot;: { # The most recent Rx control packet for this BFD session.
3323 &quot;authenticationPresent&quot;: True or False, # The Authentication Present bit of the BFD packet. This is specified in
3324 # section 4.1 ofRFC5880
3325 &quot;controlPlaneIndependent&quot;: True or False, # The Control Plane Independent bit of the BFD packet. This is specified in
3326 # section 4.1 ofRFC5880
3327 &quot;demand&quot;: True or False, # The demand bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3328 &quot;diagnostic&quot;: &quot;A String&quot;, # The diagnostic code specifies the local system&#x27;s reason for the last change
3329 # in session state. This allows remote systems to determine the reason that
3330 # the previous session failed, for example. These diagnostic codes are
3331 # specified in section 4.1 ofRFC5880
3332 &quot;final&quot;: True or False, # The Final bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3333 &quot;length&quot;: 42, # The length of the BFD Control packet in bytes. This is specified in section
3334 # 4.1 ofRFC5880
3335 &quot;minEchoRxIntervalMs&quot;: 42, # The Required Min Echo RX Interval value in the BFD packet. This is
3336 # specified in section 4.1 ofRFC5880
3337 &quot;minRxIntervalMs&quot;: 42, # The Required Min RX Interval value in the BFD packet. This is specified in
3338 # section 4.1 ofRFC5880
3339 &quot;minTxIntervalMs&quot;: 42, # The Desired Min TX Interval value in the BFD packet. This is specified in
3340 # section 4.1 ofRFC5880
3341 &quot;multiplier&quot;: 42, # The detection time multiplier of the BFD packet. This is specified in
3342 # section 4.1 ofRFC5880
3343 &quot;multipoint&quot;: True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3344 &quot;myDiscriminator&quot;: 42, # The My Discriminator value in the BFD packet. This is specified in section
3345 # 4.1 ofRFC5880
3346 &quot;poll&quot;: True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3347 &quot;state&quot;: &quot;A String&quot;, # The current BFD session state as seen by the transmitting system. These
3348 # states are specified in section 4.1 ofRFC5880
3349 &quot;version&quot;: 42, # The version number of the BFD protocol, as specified in section 4.1 ofRFC5880.
3350 &quot;yourDiscriminator&quot;: 42, # The Your Discriminator value in the BFD packet. This is specified in
3351 # section 4.1 ofRFC5880
3352 },
3353 &quot;txPacket&quot;: { # The most recent Tx control packet for this BFD session.
3354 &quot;authenticationPresent&quot;: True or False, # The Authentication Present bit of the BFD packet. This is specified in
3355 # section 4.1 ofRFC5880
3356 &quot;controlPlaneIndependent&quot;: True or False, # The Control Plane Independent bit of the BFD packet. This is specified in
3357 # section 4.1 ofRFC5880
3358 &quot;demand&quot;: True or False, # The demand bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3359 &quot;diagnostic&quot;: &quot;A String&quot;, # The diagnostic code specifies the local system&#x27;s reason for the last change
3360 # in session state. This allows remote systems to determine the reason that
3361 # the previous session failed, for example. These diagnostic codes are
3362 # specified in section 4.1 ofRFC5880
3363 &quot;final&quot;: True or False, # The Final bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3364 &quot;length&quot;: 42, # The length of the BFD Control packet in bytes. This is specified in section
3365 # 4.1 ofRFC5880
3366 &quot;minEchoRxIntervalMs&quot;: 42, # The Required Min Echo RX Interval value in the BFD packet. This is
3367 # specified in section 4.1 ofRFC5880
3368 &quot;minRxIntervalMs&quot;: 42, # The Required Min RX Interval value in the BFD packet. This is specified in
3369 # section 4.1 ofRFC5880
3370 &quot;minTxIntervalMs&quot;: 42, # The Desired Min TX Interval value in the BFD packet. This is specified in
3371 # section 4.1 ofRFC5880
3372 &quot;multiplier&quot;: 42, # The detection time multiplier of the BFD packet. This is specified in
3373 # section 4.1 ofRFC5880
3374 &quot;multipoint&quot;: True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3375 &quot;myDiscriminator&quot;: 42, # The My Discriminator value in the BFD packet. This is specified in section
3376 # 4.1 ofRFC5880
3377 &quot;poll&quot;: True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 ofRFC5880
3378 &quot;state&quot;: &quot;A String&quot;, # The current BFD session state as seen by the transmitting system. These
3379 # states are specified in section 4.1 ofRFC5880
3380 &quot;version&quot;: 42, # The version number of the BFD protocol, as specified in section 4.1 ofRFC5880.
3381 &quot;yourDiscriminator&quot;: 42, # The Your Discriminator value in the BFD packet. This is specified in
3382 # section 4.1 ofRFC5880
3383 },
3384 &quot;uptimeMs&quot;: &quot;A String&quot;, # Session uptime in milliseconds. Value will be 0 if session is not up.
3385 },
3386 &quot;enableIpv4&quot;: True or False, # Output only. Enable IPv4 traffic over BGP Peer.
3387 # It is enabled by default if the peerIpAddress is version 4.
3388 &quot;enableIpv6&quot;: True or False, # Output only. Enable IPv6 traffic over BGP Peer.
3389 # It is enabled by default if the peerIpAddress is version 6.
3390 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. IP address of the local BGP interface.
3391 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv4 address of the local BGP interface.
3392 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv6 address of the local BGP interface.
3393 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # Output only. URL of the VPN tunnel that this BGP peer controls.
3394 &quot;md5AuthEnabled&quot;: True or False, # Informs whether MD5 authentication is enabled on this BGP peer.
3395 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of this BGP peer. Unique within the Routers resource.
3396 &quot;numLearnedRoutes&quot;: 42, # Output only. Number of routes learned from the remote BGP Peer.
3397 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. IP address of the remote BGP interface.
3398 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv4 address of the remote BGP interface.
3399 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # Output only. IPv6 address of the remote BGP interface.
3400 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # Output only. [Output only] URI of the VM instance that is used as third-party router
3401 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
3402 # Appliances.
3403 # The VM instance is the peer side of the BGP session.
3404 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the BGP session. For a list of possible values for this
3405 # field, seeBGP session states.
3406 &quot;status&quot;: &quot;A String&quot;, # Output only. Status of the BGP peer: {UP, DOWN}
3407 &quot;statusReason&quot;: &quot;A String&quot;, # Indicates why particular status was returned.
3408 &quot;uptime&quot;: &quot;A String&quot;, # Output only. Time this session has been up.
3409 # Format:
3410 # 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
3411 &quot;uptimeSeconds&quot;: &quot;A String&quot;, # Output only. Time this session has been up, in seconds.
3412 # Format:
3413 # 145
3414 },
3415 ],
3416 &quot;natStatus&quot;: [
3417 { # Status of a NAT contained in this router.
3418 &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;]
3419 &quot;A String&quot;,
3420 ],
3421 &quot;drainAutoAllocatedNatIps&quot;: [ # Output only. A list of IPs auto-allocated for NAT that are in drain mode.
3422 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3423 &quot;A String&quot;,
3424 ],
3425 &quot;drainUserAllocatedNatIps&quot;: [ # Output only. A list of IPs user-allocated for NAT that are in drain mode.
3426 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3427 &quot;A String&quot;,
3428 ],
3429 &quot;minExtraNatIpsNeeded&quot;: 42, # Output only. The number of extra IPs to allocate. This will be greater than 0 only if
3430 # user-specified IPs are NOT enough to allow all configured VMs to use NAT.
3431 # This value is meaningful only when auto-allocation of NAT IPs is *not*
3432 # used.
3433 &quot;name&quot;: &quot;A String&quot;, # Output only. Unique name of this NAT.
3434 &quot;numVmEndpointsWithNatMappings&quot;: 42, # Output only. Number of VM endpoints (i.e., Nics) that can use NAT.
3435 &quot;ruleStatus&quot;: [ # Status of rules in this NAT.
3436 { # Status of a NAT Rule contained in this NAT.
3437 &quot;activeNatIps&quot;: [ # Output only. A list of active IPs for NAT.
3438 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3439 &quot;A String&quot;,
3440 ],
3441 &quot;drainNatIps&quot;: [ # Output only. A list of IPs for NAT that are in drain mode.
3442 # Example: [&quot;1.1.1.1&quot;, &quot;179.12.26.133&quot;].
3443 &quot;A String&quot;,
3444 ],
3445 &quot;minExtraIpsNeeded&quot;: 42, # Output only. The number of extra IPs to allocate. This will be greater than 0 only
3446 # if the existing IPs in this NAT Rule are NOT enough to allow all
3447 # configured VMs to use NAT.
3448 &quot;numVmEndpointsWithNatMappings&quot;: 42, # Output only. Number of VM endpoints (i.e., NICs) that have NAT Mappings from this
3449 # NAT Rule.
3450 &quot;ruleNumber&quot;: 42, # Output only. Rule number of the rule.
3451 },
3452 ],
3453 &quot;userAllocatedNatIpResources&quot;: [ # Output only. A list of fully qualified URLs of reserved IP address resources.
3454 &quot;A String&quot;,
3455 ],
3456 &quot;userAllocatedNatIps&quot;: [ # Output only. A list of IPs user-allocated for NAT.
3457 # They will be raw IP strings like &quot;179.12.26.133&quot;.
3458 &quot;A String&quot;,
3459 ],
3460 },
3461 ],
3462 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
3463 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
3464 },
3465 }</pre>
3466 </div>
3467
3468 <div class="method">
3469 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
3470 <pre>Creates a Router resource in the specified project and region using
3471 the data included in the request.
3472
3473 Args:
3474 project: string, Project ID for this request. (required)
3475 region: string, Name of the region for this request. (required)
3476 body: object, The request body.
3477 The object takes the form of:
3478
3479 { # Represents a Cloud Router resource.
3480 #
3481 # For more information about Cloud Router, read theCloud
3482 # Router overview.
3483 &quot;bgp&quot;: { # BGP information specific to this router.
3484 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
3485 # The options are DEFAULT or CUSTOM.
3486 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
3487 # This field can only be populated if advertise_mode is CUSTOM and
3488 # is advertised to all peers of the router.
3489 # These groups will be advertised in addition to any specified prefixes.
3490 # Leave this field blank to advertise no custom groups.
3491 &quot;A String&quot;,
3492 ],
3493 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
3494 # This field can only be populated if advertise_mode is CUSTOM and
3495 # is advertised to all peers of the router.
3496 # These IP ranges will be advertised in addition to any specified groups.
3497 # Leave this field blank to advertise no custom IP ranges.
3498 { # Description-tagged IP ranges for the router to advertise.
3499 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
3500 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
3501 },
3502 ],
3503 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
3504 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
3505 # value will be fixed for this router resource. All VPN tunnels that link
3506 # to this router will have the same local ASN.
3507 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
3508 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
3509 # least /30, even if the BGP sessions are over IPv6. It must not overlap
3510 # with any IPv4 BGP session ranges.
3511 #
3512 #
3513 # Other vendors commonly call this &quot;router ID&quot;.
3514 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
3515 # sent to the peer.
3516 #
3517 #
3518 # Hold time is three times the interval at which keepalive messages are
3519 # sent, and the hold time is the maximum number of seconds allowed to
3520 # elapse between successive keepalive messages that BGP receives from a
3521 # peer.
3522 #
3523 #
3524 # BGP will use the smaller of either the local hold time value or the
3525 # peer&#x27;s hold time value as the hold time for the BGP connection between
3526 # the two peers.
3527 #
3528 #
3529 # If set, this value must be between 20 and 60. The default is 20.
3530 },
3531 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
3532 # establish BGP peering. This information must specify the peer ASN and
3533 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
3534 {
3535 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
3536 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
3537 # which currently supports the following option:
3538 #
3539 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
3540 # excludes any routes learned for subnets that use
3541 # VPC Network Peering.
3542 #
3543 #
3544 # Note that this field can only be populated if advertise_mode is CUSTOM
3545 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
3546 # These groups are advertised in addition to any specified prefixes.
3547 # Leave this field blank to advertise no custom groups.
3548 &quot;A String&quot;,
3549 ],
3550 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
3551 # This field can only be populated if advertise_mode is CUSTOM and
3552 # overrides the list defined for the router (in the &quot;bgp&quot; message).
3553 # These IP ranges are advertised in addition to any specified groups.
3554 # Leave this field blank to advertise no custom IP ranges.
3555 { # Description-tagged IP ranges for the router to advertise.
3556 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
3557 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
3558 },
3559 ],
3560 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
3561 # than one matching route of maximum length, the routes with the lowest
3562 # priority value win.
3563 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
3564 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
3565 # received from the peer router. The actual value is negotiated between
3566 # the two routers and is equal to the greater of this value and the
3567 # transmit interval of the other router.
3568 #
3569 #
3570 # If set, this value must be between 1000 and 30000.
3571 #
3572 #
3573 # The default is 1000.
3574 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
3575 # transmitted to the peer router. The actual value is negotiated between
3576 # the two routers and is equal to the greater of this value and the
3577 # corresponding receive interval of the other router.
3578 #
3579 #
3580 # If set, this value must be between 1000 and 30000.
3581 #
3582 #
3583 # The default is 1000.
3584 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
3585 # before BFD declares that a peer is unavailable.
3586 #
3587 #
3588 # If set, the value must be a value between 5 and 16.
3589 #
3590 #
3591 # The default is 5.
3592 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
3593 #
3594 #
3595 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
3596 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
3597 # peer router to initiate the BFD session for this BGP peer. If set to
3598 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
3599 },
3600 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
3601 # session.
3602 {
3603 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
3604 # CIDR-formatted prefix. If an IP address is provided without a subnet
3605 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
3606 # range, and, for IPv6, `/128`.
3607 },
3608 ],
3609 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
3610 # value is applied to all custom learned route ranges for the session.
3611 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
3612 # value, Google Cloud assigns a priority of `100` to the ranges.
3613 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
3614 #
3615 #
3616 # If set to FALSE, any active session with the peer is terminated and
3617 # all associated routing information is removed. If set to TRUE, the
3618 # peer connection can be established with routing information. The default
3619 # is TRUE.
3620 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
3621 # the peerIpAddress is version 4.
3622 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
3623 # peerIpAddress is version 6.
3624 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
3625 # evaluated. The name must correspond to an existing policy that has
3626 # ROUTE_POLICY_TYPE_EXPORT type.
3627 &quot;A String&quot;,
3628 ],
3629 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
3630 # evaluated. The name must correspond to an existing policy that has
3631 # ROUTE_POLICY_TYPE_IMPORT type.
3632 &quot;A String&quot;,
3633 ],
3634 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
3635 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
3636 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
3637 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
3638 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
3639 #
3640 # - MANAGED_BY_USER is the default value and can be managed by you
3641 # or other users
3642 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
3643 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
3644 # PARTNER. Google automatically creates, updates, and deletes this type of
3645 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
3646 # or deleted.
3647 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
3648 # name of one of the entries in the Router.md5_authentication_keys. The
3649 # field must comply with RFC1035.
3650 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
3651 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
3652 # characters long and match the regular expression
3653 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
3654 # lowercase letter, and all following characters must be a dash, lowercase
3655 # letter, or digit, except the last character, which cannot be a dash.
3656 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
3657 # a different value.
3658 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
3659 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
3660 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
3661 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
3662 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
3663 # Appliances. The VM instance must be located in zones contained in the
3664 # same region as this Cloud Router.
3665 # The VM instance is the peer side of the BGP session.
3666 },
3667 ],
3668 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3669 # text format.
3670 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3671 # create the resource.
3672 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
3673 # attachments (interconnectAttachments).
3674 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
3675 # defined by the server.
3676 &quot;interfaces&quot;: [ # Router interfaces.
3677 # To create a BGP peer that uses a router interface,
3678 # the interface must have one of the following fields specified:
3679 #
3680 # - linkedVpnTunnel
3681 # - linkedInterconnectAttachment
3682 # - subnetwork
3683 #
3684 #
3685 # You can create a router interface without any of these fields specified.
3686 # However, you cannot create a BGP peer that uses that interface.
3687 {
3688 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
3689 #
3690 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
3691 # be a CIDR-formatted string, for example, 169.254.0.1/30.
3692 # Note: Do not truncate the IP address, as it represents the IP address of
3693 # the interface.
3694 # - For Internet Protocol version 6 (IPv6), the value
3695 # must be a unique local address (ULA) range from fdff:1::/64
3696 # with a mask length of 126 or less. This value should be a CIDR-formatted
3697 # string, for example, fdff:1::1/112. Within the router&#x27;s
3698 # VPC, this IPv6 prefix will be reserved exclusively for this connection
3699 # and cannot be used for any other purpose.
3700 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
3701 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
3702 # as the router. Each interface can have one linked resource, which can be
3703 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
3704 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
3705 # router. Each interface can have one linked resource, which can be
3706 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
3707 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
3708 #
3709 # - MANAGED_BY_USER is the default value and can be managed directly
3710 # by users.
3711 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
3712 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
3713 # of type PARTNER. Google automatically creates, updates, and deletes
3714 # this type of interface when the PARTNER InterconnectAttachment is
3715 # created, updated, or deleted.
3716 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
3717 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
3718 # characters long and match the regular expression
3719 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
3720 # lowercase letter, and all following characters must be a dash, lowercase
3721 # letter, or digit, except the last character, which cannot be a dash.
3722 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
3723 # BGP sessions to a VM instance acting as a third-party
3724 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
3725 # an SD-WAN VM.
3726 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
3727 # you are creating. The redundantInterface must belong to the same Cloud
3728 # Router as the interface here. To establish the BGP session to a Router
3729 # Appliance VM, you must create two BGP peers. The two BGP peers must be
3730 # attached to two separate interfaces that are redundant with each other.
3731 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
3732 # be 1-63 characters long and match the regular expression
3733 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
3734 # lowercase letter, and all following characters must be a dash, lowercase
3735 # letter, or digit, except the last character, which cannot be a dash.
3736 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
3737 # must be in the same region as the Cloud Router.
3738 # When you establish a BGP session to a VM instance using this interface,
3739 # the VM instance must belong to the same subnetwork as the subnetwork
3740 # specified here.
3741 },
3742 ],
3743 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
3744 # routers.
3745 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
3746 {
3747 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
3748 #
3749 # For patch and update calls, it can be skipped to
3750 # copy the value from the previous configuration. This is allowed if the
3751 # key with the same name existed before the operation. Maximum length is 80
3752 # characters. Can only contain printable ASCII characters.
3753 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
3754 #
3755 # Must be unique within a router. Must be referenced by exactly
3756 # one bgpPeer. Must comply withRFC1035.
3757 },
3758 ],
3759 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3760 # The name must be 1-63 characters long, and comply withRFC1035.
3761 # Specifically, the name must be 1-63 characters long and match the regular
3762 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3763 # character must be a lowercase letter, and all following characters must
3764 # be a dash, lowercase letter, or digit, except the last character, which
3765 # cannot be a dash.
3766 &quot;nats&quot;: [ # A list of NAT services created in this router.
3767 { # Represents a Nat resource. It enables the VMs within the specified
3768 # subnetworks to access Internet without external IP addresses. It specifies
3769 # a list of subnetworks (and the ranges within) that want to use NAT.
3770 # Customers can also provide the external IPs that would be used for NAT. GCP
3771 # would auto-allocate ephemeral IPs if no external IPs are provided.
3772 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
3773 # Must be one of: PREMIUM, STANDARD.
3774 # If not specified, then the current
3775 # project-level default tier is used.
3776 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
3777 # must be valid static external IPs that have been assigned to the NAT.
3778 # These IPs should be used for updating/patching a NAT only.
3779 &quot;A String&quot;,
3780 ],
3781 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
3782 # state. This value is equal to tcp_time_wait_timeout_sec.
3783 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
3784 # 120s. The field is output only.
3785 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
3786 #
3787 #
3788 # If not specified, it is disabled by default.
3789 #
3790 #
3791 # If set to true,
3792 #
3793 # - Dynamic Port Allocation will be enabled on this NAT
3794 # config.
3795 # - enableEndpointIndependentMapping cannot be set to true.
3796 # - If minPorts is set, minPortsPerVm must be set to a
3797 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
3798 # minimum of 32 ports will be allocated to a VM from this NAT
3799 # config.
3800 &quot;enableEndpointIndependentMapping&quot;: True or False,
3801 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
3802 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
3803 &quot;A String&quot;,
3804 ],
3805 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
3806 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
3807 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
3808 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
3809 # logs are exported for all connections handled by this NAT.
3810 # This option can take one of the following values:
3811 #
3812 # - ERRORS_ONLY: Export logs only for connection failures.
3813 # - TRANSLATIONS_ONLY: Export logs only for successful
3814 # connections.
3815 # - ALL: Export logs for all connections, successful and
3816 # unsuccessful.
3817 },
3818 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
3819 # Dynamic Port Allocation is enabled.
3820 #
3821 #
3822 # If Dynamic Port Allocation is not enabled, this field has no effect.
3823 #
3824 #
3825 # If Dynamic Port Allocation is enabled, and this field is set, it must be
3826 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
3827 # is not set.
3828 #
3829 #
3830 # If Dynamic Port Allocation is enabled and this field is not set,
3831 # a maximum of 65536 ports will be allocated to a VM from this NAT
3832 # config.
3833 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
3834 # set, a default number of ports is allocated to a VM. This is rounded
3835 # up to the nearest power of 2. For example, if the value of this field is
3836 # 50, at least 64 ports are allocated to a VM.
3837 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
3838 # The name must be 1-63 characters long and comply withRFC1035.
3839 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
3840 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
3841 # selected for the SubnetworkIpRangeToNat64Option above.
3842 { # Specifies a subnetwork to enable NAT64.
3843 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
3844 },
3845 ],
3846 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
3847 # values:
3848 #
3849 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
3850 # customers. When there are not enough specified Nat IPs, the Nat service
3851 # fails for new VMs.
3852 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
3853 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
3854 # be empty.
3855 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
3856 # addresses must be valid static external IP addresses assigned to the
3857 # project.
3858 &quot;A String&quot;,
3859 ],
3860 &quot;rules&quot;: [ # A list of rules associated with this NAT.
3861 {
3862 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
3863 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
3864 # addresses must be valid static external IP addresses assigned to the
3865 # project.
3866 # This field is used for public NAT.
3867 &quot;A String&quot;,
3868 ],
3869 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
3870 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
3871 # This field is used for private NAT.
3872 &quot;A String&quot;,
3873 ],
3874 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
3875 # must be valid static external IPs that have been assigned to the NAT.
3876 # These IPs should be used for updating/patching a NAT rule only.
3877 # This field is used for public NAT.
3878 &quot;A String&quot;,
3879 ],
3880 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
3881 # drained. This is only supported on patch/update, and these
3882 # subnetworks must have previously been used as active ranges in this
3883 # NAT Rule.
3884 # This field is used for private NAT.
3885 &quot;A String&quot;,
3886 ],
3887 },
3888 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
3889 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
3890 # from a VM is evaluated against. If it evaluates to true, the
3891 # corresponding `action` is enforced.
3892 #
3893 # The following examples are valid match expressions for public NAT:
3894 #
3895 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
3896 # &#x27;2.2.0.0/16&#x27;)`
3897 #
3898 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
3899 #
3900 # The following example is a valid match expression for private NAT:
3901 #
3902 # `nexthop.hub ==
3903 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
3904 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
3905 # must be a positive value between 0 and 65000, and
3906 # must be unique among rules within a NAT.
3907 },
3908 ],
3909 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
3910 #
3911 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
3912 # Subnetwork are allowed to Nat.
3913 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
3914 # in every Subnetwork are allowed to Nat.
3915 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
3916 # (specified in the field subnetwork below)
3917 #
3918 #
3919 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
3920 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
3921 # should not be any other Router.Nat section in any Router for this network
3922 # in this region.
3923 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
3924 # values:
3925 #
3926 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
3927 # every Subnetwork are allowed to Nat.
3928 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
3929 # (specified in the field nat64_subnetwork below)
3930 #
3931 #
3932 # The default is NAT64_OPTION_UNSPECIFIED.
3933 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
3934 # Router.Nat section in this region can also enable NAT64 for any
3935 # Subnetworks in this network. Other Router.Nat sections can still be
3936 # present to enable NAT44 only.
3937 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
3938 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
3939 # SubnetworkIpRangeToNatOption above.
3940 { # Defines the IP ranges that want to use NAT for a subnetwork.
3941 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
3942 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
3943 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
3944 # is one of the values in source_ip_ranges_to_nat.
3945 &quot;A String&quot;,
3946 ],
3947 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
3948 # options of a single value are valid except
3949 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
3950 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
3951 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
3952 # Default: [ALL_IP_RANGES]
3953 &quot;A String&quot;,
3954 ],
3955 },
3956 ],
3957 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
3958 # if not set.
3959 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
3960 # Defaults to 120s if not set.
3961 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
3962 # not set.
3963 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
3964 # translation. If unspecified, it defaults to PUBLIC.
3965 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
3966 },
3967 ],
3968 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
3969 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
3970 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3971 # as part of resource payload.
3972 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3973 # The field is allowed for INSERT
3974 # only. The keys/values to set on the resource should be specified in
3975 # either ID { : } or Namespaced format
3976 # { : }.
3977 # For example the following are valid inputs:
3978 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3979 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3980 # Note:
3981 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3982 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3983 # * Inconsistent format is not supported. For instance:
3984 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
3985 &quot;a_key&quot;: &quot;A String&quot;,
3986 },
3987 },
3988 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
3989 # You must specify this field as part of the HTTP request URL. It is
3990 # not settable as a field in the request body.
3991 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3992 }
3993
3994 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3995 that if you must retry your request, the server will know to ignore the
3996 request if it has already been completed.
3997
3998 For example, consider a situation where you make an initial request and
3999 the request times out. If you make the request again with the same
4000 request ID, the server can check if original operation with the same
4001 request ID was received, and if so, will ignore the second request. This
4002 prevents clients from accidentally creating duplicate commitments.
4003
4004 The request ID must be
4005 a valid UUID with the exception that zero UUID is not supported
4006 (00000000-0000-0000-0000-000000000000).
4007 x__xgafv: string, V1 error format.
4008 Allowed values
4009 1 - v1 error format
4010 2 - v2 error format
4011
4012 Returns:
4013 An object of the form:
4014
4015 { # Represents an Operation resource.
4016 #
4017 # Google Compute Engine has three Operation resources:
4018 #
4019 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
4020 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
4021 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
4022 #
4023 # You can use an operation resource to manage asynchronous API requests.
4024 # For more information, readHandling
4025 # API responses.
4026 #
4027 # Operations can be global, regional or zonal.
4028 #
4029 # - For global operations, use the `globalOperations`
4030 # resource.
4031 # - For regional operations, use the
4032 # `regionOperations` resource.
4033 # - For zonal operations, use
4034 # the `zoneOperations` resource.
4035 #
4036 #
4037 #
4038 # For more information, read
4039 # Global, Regional, and Zonal Resources.
4040 #
4041 # Note that completed Operation resources have a limited
4042 # retention period.
4043 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4044 # Not present otherwise.
4045 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4046 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4047 # set when the operation is created.
4048 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4049 # text format.
4050 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4051 # this field will be populated.
4052 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4053 # operation.
4054 {
4055 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4056 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4057 # details. There is a set of defined message types to use for providing
4058 # details.The syntax depends on the error code. For example,
4059 # QuotaExceededInfo will have details when the error code is
4060 # QUOTA_EXCEEDED.
4061 {
4062 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4063 #
4064 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4065 # is not enabled:
4066 #
4067 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4068 # &quot;domain&quot;: &quot;googleapis.com&quot;
4069 # &quot;metadata&quot;: {
4070 # &quot;resource&quot;: &quot;projects/123&quot;,
4071 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4072 # }
4073 # }
4074 #
4075 # This response indicates that the pubsub.googleapis.com API is not enabled.
4076 #
4077 # Example of an error that is returned when attempting to create a Spanner
4078 # instance in a region that is out of stock:
4079 #
4080 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4081 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4082 # &quot;metadata&quot;: {
4083 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4084 # }
4085 # }
4086 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4087 # is typically the registered service name of the tool or product that
4088 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4089 # generated by some common infrastructure, the error domain must be a
4090 # globally unique value that identifies the infrastructure. For Google API
4091 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4092 &quot;metadatas&quot;: { # Additional structured details about this error.
4093 #
4094 # Keys must match a regular expression of `a-z+` but should
4095 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4096 # length. When identifying the current value of an exceeded limit, the units
4097 # should be contained in the key, not the value. For example, rather than
4098 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4099 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4100 # instances that can be created in a single (batch) request.
4101 &quot;a_key&quot;: &quot;A String&quot;,
4102 },
4103 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4104 # proximate cause of the error. Error reasons are unique within a particular
4105 # domain of errors. This should be at most 63 characters and match a
4106 # regular expression of `A-Z+[A-Z0-9]`, which represents
4107 # UPPER_SNAKE_CASE.
4108 },
4109 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4110 #
4111 # For example, if a quota check failed with an error indicating the calling
4112 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4113 # directly to the right place in the developer console to flip the bit.
4114 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4115 { # Describes a URL link.
4116 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4117 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4118 },
4119 ],
4120 },
4121 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4122 # which can be attached to an RPC error.
4123 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4124 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4125 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4126 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4127 },
4128 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4129 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4130 &quot;a_key&quot;: &quot;A String&quot;,
4131 },
4132 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4133 # type or metric.
4134 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4135 # or metric.
4136 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4137 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4138 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4139 },
4140 },
4141 ],
4142 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4143 # This property is optional.
4144 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4145 },
4146 ],
4147 },
4148 &quot;getVersionOperationMetadata&quot;: {
4149 &quot;inlineSbomInfo&quot;: {
4150 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4151 # appropriate identifiers.
4152 &quot;a_key&quot;: &quot;A String&quot;,
4153 },
4154 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4155 # identifiers.
4156 &quot;a_key&quot;: &quot;A String&quot;,
4157 },
4158 },
4159 },
4160 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4161 # message that was returned, such as `NOT FOUND`.
4162 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4163 # status code that was returned. For example, a `404` means the
4164 # resource was not found.
4165 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4166 # defined by the server.
4167 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4168 # This value is inRFC3339
4169 # text format.
4170 &quot;instancesBulkInsertOperationMetadata&quot;: {
4171 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4172 # Example key: zones/us-central1-a
4173 &quot;a_key&quot;: {
4174 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4175 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4176 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4177 # error.
4178 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4179 # if the flow is rolling forward or rolling back.
4180 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4181 },
4182 },
4183 },
4184 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4185 # Operation resources.
4186 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4187 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4188 # group of operations results from a `bulkInsert` API request.
4189 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4190 # `update`, or `delete`, and so on.
4191 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4192 # There is no requirement that this be linear or support any granularity of
4193 # operations. This should not be used to guess when the operation will be
4194 # complete. This number should monotonically increase as the operation
4195 # progresses.
4196 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4197 # applicable when performing regional operations.
4198 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4199 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4200 # this field will contain information on all underlying zonal actions and
4201 # their state.
4202 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4203 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4204 # Example key: zones/us-central1-a
4205 &quot;a_key&quot;: {
4206 &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
4207 # populated.
4208 # different programming environments, including REST APIs and RPC APIs. It is
4209 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4210 # three pieces of data: error code, error message, and error details.
4211 #
4212 # You can find out more about this error model and how to work with it in the
4213 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4214 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4215 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4216 # message types for APIs to use.
4217 {
4218 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4219 },
4220 ],
4221 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4222 # user-facing error message should be localized and sent in the
4223 # google.rpc.Status.details field, or localized by the client.
4224 },
4225 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4226 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4227 },
4228 },
4229 },
4230 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4231 # This value is inRFC3339
4232 # text format.
4233 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4234 # following:
4235 # `PENDING`, `RUNNING`, or `DONE`.
4236 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4237 # operation.
4238 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4239 # of the target resource.
4240 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4241 # operations related to creating a snapshot, this points to the disk
4242 # that the snapshot was created from.
4243 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4244 # `[email protected]` or
4245 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4246 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4247 # operation, this field will be populated.
4248 {
4249 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4250 # Engine returns NO_RESULTS_ON_PAGE if there
4251 # are no results in the response.
4252 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4253 # value format. For example:
4254 #
4255 # &quot;data&quot;: [
4256 # {
4257 # &quot;key&quot;: &quot;scope&quot;,
4258 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4259 # }
4260 {
4261 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4262 # returned. For example, for warnings where there are no results in a list
4263 # request for a particular zone, this key might be scope and
4264 # the key value might be the zone name. Other examples might be a key
4265 # indicating a deprecated resource and a suggested replacement, or a
4266 # warning about invalid network settings (for example, if an instance
4267 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4268 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4269 },
4270 ],
4271 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4272 },
4273 ],
4274 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4275 # applicable when performing per-zone operations.
4276 }</pre>
4277 </div>
4278
4279 <div class="method">
4280 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4281 <pre>Retrieves a list of Router resources available to the specified project.
4282
4283 Args:
4284 project: string, Project ID for this request. (required)
4285 region: string, Name of the region for this request. (required)
4286 filter: string, A filter expression that filters resources listed in the response. Most
4287 Compute resources support two types of filter expressions:
4288 expressions that support regular expressions and expressions that follow
4289 API improvement proposal AIP-160.
4290 These two types of filter expressions cannot be mixed in one request.
4291
4292 If you want to use AIP-160, your expression must specify the field name, an
4293 operator, and the value that you want to use for filtering. The value
4294 must be a string, a number, or a boolean. The operator
4295 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4296
4297 For example, if you are filtering Compute Engine instances, you can
4298 exclude instances named `example-instance` by specifying
4299 `name != example-instance`.
4300
4301 The `:*` comparison can be used to test whether a key has been defined.
4302 For example, to find all objects with `owner` label use:
4303 ```
4304 labels.owner:*
4305 ```
4306
4307 You can also filter nested fields. For example, you could specify
4308 `scheduling.automaticRestart = false` to include instances only
4309 if they are not scheduled for automatic restarts. You can use filtering
4310 on nested fields to filter based onresource labels.
4311
4312 To filter on multiple expressions, provide each separate expression within
4313 parentheses. For example:
4314 ```
4315 (scheduling.automaticRestart = true)
4316 (cpuPlatform = &quot;Intel Skylake&quot;)
4317 ```
4318 By default, each expression is an `AND` expression. However, you
4319 can include `AND` and `OR` expressions explicitly.
4320 For example:
4321 ```
4322 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4323 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4324 (scheduling.automaticRestart = true)
4325 ```
4326
4327 If you want to use a regular expression, use the `eq` (equal) or `ne`
4328 (not equal) operator against a single un-parenthesized expression with or
4329 without quotes or against multiple parenthesized expressions. Examples:
4330
4331 `fieldname eq unquoted literal`
4332 `fieldname eq &#x27;single quoted literal&#x27;`
4333 `fieldname eq &quot;double quoted literal&quot;`
4334 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4335
4336 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4337 The literal value must match the entire field.
4338
4339 For example, to filter for instances that do not end with name &quot;instance&quot;,
4340 you would use `name ne .*instance`.
4341
4342 You cannot combine constraints on multiple fields using regular
4343 expressions.
4344 maxResults: integer, The maximum number of results per page that should be returned.
4345 If the number of available results is larger than `maxResults`,
4346 Compute Engine returns a `nextPageToken` that can be used to get
4347 the next page of results in subsequent list requests. Acceptable values are
4348 `0` to `500`, inclusive. (Default: `500`)
4349 orderBy: string, Sorts list results by a certain order. By default, results
4350 are returned in alphanumerical order based on the resource name.
4351
4352 You can also sort results in descending order based on the creation
4353 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4354 results based on the `creationTimestamp` field in
4355 reverse chronological order (newest result first). Use this to sort
4356 resources like operations so that the newest operation is returned first.
4357
4358 Currently, only sorting by `name` or
4359 `creationTimestamp desc` is supported.
4360 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4361 `nextPageToken` returned by a previous list request to get
4362 the next page of results.
4363 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4364 of failure. The default value is false.
4365
4366 For example, when partial success behavior is enabled, aggregatedList for a
4367 single zone scope either returns all resources in the zone or no resources,
4368 with an error code.
4369 x__xgafv: string, V1 error format.
4370 Allowed values
4371 1 - v1 error format
4372 2 - v2 error format
4373
4374 Returns:
4375 An object of the form:
4376
4377 { # Contains a list of Router resources.
4378 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4379 &quot;items&quot;: [ # A list of Router resources.
4380 { # Represents a Cloud Router resource.
4381 #
4382 # For more information about Cloud Router, read theCloud
4383 # Router overview.
4384 &quot;bgp&quot;: { # BGP information specific to this router.
4385 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
4386 # The options are DEFAULT or CUSTOM.
4387 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
4388 # This field can only be populated if advertise_mode is CUSTOM and
4389 # is advertised to all peers of the router.
4390 # These groups will be advertised in addition to any specified prefixes.
4391 # Leave this field blank to advertise no custom groups.
4392 &quot;A String&quot;,
4393 ],
4394 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
4395 # This field can only be populated if advertise_mode is CUSTOM and
4396 # is advertised to all peers of the router.
4397 # These IP ranges will be advertised in addition to any specified groups.
4398 # Leave this field blank to advertise no custom IP ranges.
4399 { # Description-tagged IP ranges for the router to advertise.
4400 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
4401 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
4402 },
4403 ],
4404 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
4405 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
4406 # value will be fixed for this router resource. All VPN tunnels that link
4407 # to this router will have the same local ASN.
4408 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
4409 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
4410 # least /30, even if the BGP sessions are over IPv6. It must not overlap
4411 # with any IPv4 BGP session ranges.
4412 #
4413 #
4414 # Other vendors commonly call this &quot;router ID&quot;.
4415 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
4416 # sent to the peer.
4417 #
4418 #
4419 # Hold time is three times the interval at which keepalive messages are
4420 # sent, and the hold time is the maximum number of seconds allowed to
4421 # elapse between successive keepalive messages that BGP receives from a
4422 # peer.
4423 #
4424 #
4425 # BGP will use the smaller of either the local hold time value or the
4426 # peer&#x27;s hold time value as the hold time for the BGP connection between
4427 # the two peers.
4428 #
4429 #
4430 # If set, this value must be between 20 and 60. The default is 20.
4431 },
4432 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
4433 # establish BGP peering. This information must specify the peer ASN and
4434 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
4435 {
4436 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
4437 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
4438 # which currently supports the following option:
4439 #
4440 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
4441 # excludes any routes learned for subnets that use
4442 # VPC Network Peering.
4443 #
4444 #
4445 # Note that this field can only be populated if advertise_mode is CUSTOM
4446 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
4447 # These groups are advertised in addition to any specified prefixes.
4448 # Leave this field blank to advertise no custom groups.
4449 &quot;A String&quot;,
4450 ],
4451 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
4452 # This field can only be populated if advertise_mode is CUSTOM and
4453 # overrides the list defined for the router (in the &quot;bgp&quot; message).
4454 # These IP ranges are advertised in addition to any specified groups.
4455 # Leave this field blank to advertise no custom IP ranges.
4456 { # Description-tagged IP ranges for the router to advertise.
4457 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
4458 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
4459 },
4460 ],
4461 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
4462 # than one matching route of maximum length, the routes with the lowest
4463 # priority value win.
4464 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
4465 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
4466 # received from the peer router. The actual value is negotiated between
4467 # the two routers and is equal to the greater of this value and the
4468 # transmit interval of the other router.
4469 #
4470 #
4471 # If set, this value must be between 1000 and 30000.
4472 #
4473 #
4474 # The default is 1000.
4475 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
4476 # transmitted to the peer router. The actual value is negotiated between
4477 # the two routers and is equal to the greater of this value and the
4478 # corresponding receive interval of the other router.
4479 #
4480 #
4481 # If set, this value must be between 1000 and 30000.
4482 #
4483 #
4484 # The default is 1000.
4485 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
4486 # before BFD declares that a peer is unavailable.
4487 #
4488 #
4489 # If set, the value must be a value between 5 and 16.
4490 #
4491 #
4492 # The default is 5.
4493 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
4494 #
4495 #
4496 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
4497 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
4498 # peer router to initiate the BFD session for this BGP peer. If set to
4499 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
4500 },
4501 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
4502 # session.
4503 {
4504 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
4505 # CIDR-formatted prefix. If an IP address is provided without a subnet
4506 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
4507 # range, and, for IPv6, `/128`.
4508 },
4509 ],
4510 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
4511 # value is applied to all custom learned route ranges for the session.
4512 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
4513 # value, Google Cloud assigns a priority of `100` to the ranges.
4514 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
4515 #
4516 #
4517 # If set to FALSE, any active session with the peer is terminated and
4518 # all associated routing information is removed. If set to TRUE, the
4519 # peer connection can be established with routing information. The default
4520 # is TRUE.
4521 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
4522 # the peerIpAddress is version 4.
4523 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
4524 # peerIpAddress is version 6.
4525 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
4526 # evaluated. The name must correspond to an existing policy that has
4527 # ROUTE_POLICY_TYPE_EXPORT type.
4528 &quot;A String&quot;,
4529 ],
4530 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
4531 # evaluated. The name must correspond to an existing policy that has
4532 # ROUTE_POLICY_TYPE_IMPORT type.
4533 &quot;A String&quot;,
4534 ],
4535 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
4536 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
4537 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
4538 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
4539 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
4540 #
4541 # - MANAGED_BY_USER is the default value and can be managed by you
4542 # or other users
4543 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
4544 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
4545 # PARTNER. Google automatically creates, updates, and deletes this type of
4546 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
4547 # or deleted.
4548 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
4549 # name of one of the entries in the Router.md5_authentication_keys. The
4550 # field must comply with RFC1035.
4551 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
4552 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
4553 # characters long and match the regular expression
4554 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4555 # lowercase letter, and all following characters must be a dash, lowercase
4556 # letter, or digit, except the last character, which cannot be a dash.
4557 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
4558 # a different value.
4559 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
4560 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
4561 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
4562 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
4563 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
4564 # Appliances. The VM instance must be located in zones contained in the
4565 # same region as this Cloud Router.
4566 # The VM instance is the peer side of the BGP session.
4567 },
4568 ],
4569 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4570 # text format.
4571 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4572 # create the resource.
4573 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
4574 # attachments (interconnectAttachments).
4575 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4576 # defined by the server.
4577 &quot;interfaces&quot;: [ # Router interfaces.
4578 # To create a BGP peer that uses a router interface,
4579 # the interface must have one of the following fields specified:
4580 #
4581 # - linkedVpnTunnel
4582 # - linkedInterconnectAttachment
4583 # - subnetwork
4584 #
4585 #
4586 # You can create a router interface without any of these fields specified.
4587 # However, you cannot create a BGP peer that uses that interface.
4588 {
4589 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
4590 #
4591 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
4592 # be a CIDR-formatted string, for example, 169.254.0.1/30.
4593 # Note: Do not truncate the IP address, as it represents the IP address of
4594 # the interface.
4595 # - For Internet Protocol version 6 (IPv6), the value
4596 # must be a unique local address (ULA) range from fdff:1::/64
4597 # with a mask length of 126 or less. This value should be a CIDR-formatted
4598 # string, for example, fdff:1::1/112. Within the router&#x27;s
4599 # VPC, this IPv6 prefix will be reserved exclusively for this connection
4600 # and cannot be used for any other purpose.
4601 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
4602 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
4603 # as the router. Each interface can have one linked resource, which can be
4604 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
4605 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
4606 # router. Each interface can have one linked resource, which can be
4607 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
4608 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
4609 #
4610 # - MANAGED_BY_USER is the default value and can be managed directly
4611 # by users.
4612 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
4613 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
4614 # of type PARTNER. Google automatically creates, updates, and deletes
4615 # this type of interface when the PARTNER InterconnectAttachment is
4616 # created, updated, or deleted.
4617 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
4618 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
4619 # characters long and match the regular expression
4620 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4621 # lowercase letter, and all following characters must be a dash, lowercase
4622 # letter, or digit, except the last character, which cannot be a dash.
4623 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
4624 # BGP sessions to a VM instance acting as a third-party
4625 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
4626 # an SD-WAN VM.
4627 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
4628 # you are creating. The redundantInterface must belong to the same Cloud
4629 # Router as the interface here. To establish the BGP session to a Router
4630 # Appliance VM, you must create two BGP peers. The two BGP peers must be
4631 # attached to two separate interfaces that are redundant with each other.
4632 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
4633 # be 1-63 characters long and match the regular expression
4634 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4635 # lowercase letter, and all following characters must be a dash, lowercase
4636 # letter, or digit, except the last character, which cannot be a dash.
4637 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
4638 # must be in the same region as the Cloud Router.
4639 # When you establish a BGP session to a VM instance using this interface,
4640 # the VM instance must belong to the same subnetwork as the subnetwork
4641 # specified here.
4642 },
4643 ],
4644 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
4645 # routers.
4646 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
4647 {
4648 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
4649 #
4650 # For patch and update calls, it can be skipped to
4651 # copy the value from the previous configuration. This is allowed if the
4652 # key with the same name existed before the operation. Maximum length is 80
4653 # characters. Can only contain printable ASCII characters.
4654 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
4655 #
4656 # Must be unique within a router. Must be referenced by exactly
4657 # one bgpPeer. Must comply withRFC1035.
4658 },
4659 ],
4660 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
4661 # The name must be 1-63 characters long, and comply withRFC1035.
4662 # Specifically, the name must be 1-63 characters long and match the regular
4663 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4664 # character must be a lowercase letter, and all following characters must
4665 # be a dash, lowercase letter, or digit, except the last character, which
4666 # cannot be a dash.
4667 &quot;nats&quot;: [ # A list of NAT services created in this router.
4668 { # Represents a Nat resource. It enables the VMs within the specified
4669 # subnetworks to access Internet without external IP addresses. It specifies
4670 # a list of subnetworks (and the ranges within) that want to use NAT.
4671 # Customers can also provide the external IPs that would be used for NAT. GCP
4672 # would auto-allocate ephemeral IPs if no external IPs are provided.
4673 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
4674 # Must be one of: PREMIUM, STANDARD.
4675 # If not specified, then the current
4676 # project-level default tier is used.
4677 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
4678 # must be valid static external IPs that have been assigned to the NAT.
4679 # These IPs should be used for updating/patching a NAT only.
4680 &quot;A String&quot;,
4681 ],
4682 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
4683 # state. This value is equal to tcp_time_wait_timeout_sec.
4684 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
4685 # 120s. The field is output only.
4686 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
4687 #
4688 #
4689 # If not specified, it is disabled by default.
4690 #
4691 #
4692 # If set to true,
4693 #
4694 # - Dynamic Port Allocation will be enabled on this NAT
4695 # config.
4696 # - enableEndpointIndependentMapping cannot be set to true.
4697 # - If minPorts is set, minPortsPerVm must be set to a
4698 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
4699 # minimum of 32 ports will be allocated to a VM from this NAT
4700 # config.
4701 &quot;enableEndpointIndependentMapping&quot;: True or False,
4702 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
4703 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
4704 &quot;A String&quot;,
4705 ],
4706 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
4707 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
4708 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
4709 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
4710 # logs are exported for all connections handled by this NAT.
4711 # This option can take one of the following values:
4712 #
4713 # - ERRORS_ONLY: Export logs only for connection failures.
4714 # - TRANSLATIONS_ONLY: Export logs only for successful
4715 # connections.
4716 # - ALL: Export logs for all connections, successful and
4717 # unsuccessful.
4718 },
4719 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
4720 # Dynamic Port Allocation is enabled.
4721 #
4722 #
4723 # If Dynamic Port Allocation is not enabled, this field has no effect.
4724 #
4725 #
4726 # If Dynamic Port Allocation is enabled, and this field is set, it must be
4727 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
4728 # is not set.
4729 #
4730 #
4731 # If Dynamic Port Allocation is enabled and this field is not set,
4732 # a maximum of 65536 ports will be allocated to a VM from this NAT
4733 # config.
4734 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
4735 # set, a default number of ports is allocated to a VM. This is rounded
4736 # up to the nearest power of 2. For example, if the value of this field is
4737 # 50, at least 64 ports are allocated to a VM.
4738 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
4739 # The name must be 1-63 characters long and comply withRFC1035.
4740 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
4741 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
4742 # selected for the SubnetworkIpRangeToNat64Option above.
4743 { # Specifies a subnetwork to enable NAT64.
4744 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
4745 },
4746 ],
4747 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
4748 # values:
4749 #
4750 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
4751 # customers. When there are not enough specified Nat IPs, the Nat service
4752 # fails for new VMs.
4753 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
4754 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
4755 # be empty.
4756 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
4757 # addresses must be valid static external IP addresses assigned to the
4758 # project.
4759 &quot;A String&quot;,
4760 ],
4761 &quot;rules&quot;: [ # A list of rules associated with this NAT.
4762 {
4763 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
4764 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
4765 # addresses must be valid static external IP addresses assigned to the
4766 # project.
4767 # This field is used for public NAT.
4768 &quot;A String&quot;,
4769 ],
4770 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
4771 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
4772 # This field is used for private NAT.
4773 &quot;A String&quot;,
4774 ],
4775 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
4776 # must be valid static external IPs that have been assigned to the NAT.
4777 # These IPs should be used for updating/patching a NAT rule only.
4778 # This field is used for public NAT.
4779 &quot;A String&quot;,
4780 ],
4781 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
4782 # drained. This is only supported on patch/update, and these
4783 # subnetworks must have previously been used as active ranges in this
4784 # NAT Rule.
4785 # This field is used for private NAT.
4786 &quot;A String&quot;,
4787 ],
4788 },
4789 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
4790 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
4791 # from a VM is evaluated against. If it evaluates to true, the
4792 # corresponding `action` is enforced.
4793 #
4794 # The following examples are valid match expressions for public NAT:
4795 #
4796 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
4797 # &#x27;2.2.0.0/16&#x27;)`
4798 #
4799 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
4800 #
4801 # The following example is a valid match expression for private NAT:
4802 #
4803 # `nexthop.hub ==
4804 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
4805 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
4806 # must be a positive value between 0 and 65000, and
4807 # must be unique among rules within a NAT.
4808 },
4809 ],
4810 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
4811 #
4812 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
4813 # Subnetwork are allowed to Nat.
4814 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
4815 # in every Subnetwork are allowed to Nat.
4816 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
4817 # (specified in the field subnetwork below)
4818 #
4819 #
4820 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
4821 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
4822 # should not be any other Router.Nat section in any Router for this network
4823 # in this region.
4824 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
4825 # values:
4826 #
4827 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
4828 # every Subnetwork are allowed to Nat.
4829 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
4830 # (specified in the field nat64_subnetwork below)
4831 #
4832 #
4833 # The default is NAT64_OPTION_UNSPECIFIED.
4834 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
4835 # Router.Nat section in this region can also enable NAT64 for any
4836 # Subnetworks in this network. Other Router.Nat sections can still be
4837 # present to enable NAT44 only.
4838 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
4839 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
4840 # SubnetworkIpRangeToNatOption above.
4841 { # Defines the IP ranges that want to use NAT for a subnetwork.
4842 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
4843 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
4844 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
4845 # is one of the values in source_ip_ranges_to_nat.
4846 &quot;A String&quot;,
4847 ],
4848 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
4849 # options of a single value are valid except
4850 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
4851 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
4852 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
4853 # Default: [ALL_IP_RANGES]
4854 &quot;A String&quot;,
4855 ],
4856 },
4857 ],
4858 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
4859 # if not set.
4860 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
4861 # Defaults to 120s if not set.
4862 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
4863 # not set.
4864 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
4865 # translation. If unspecified, it defaults to PUBLIC.
4866 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
4867 },
4868 ],
4869 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
4870 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
4871 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
4872 # as part of resource payload.
4873 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
4874 # The field is allowed for INSERT
4875 # only. The keys/values to set on the resource should be specified in
4876 # either ID { : } or Namespaced format
4877 # { : }.
4878 # For example the following are valid inputs:
4879 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
4880 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
4881 # Note:
4882 # * Invalid combinations of ID &amp; namespaced format is not supported. For
4883 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
4884 # * Inconsistent format is not supported. For instance:
4885 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
4886 &quot;a_key&quot;: &quot;A String&quot;,
4887 },
4888 },
4889 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
4890 # You must specify this field as part of the HTTP request URL. It is
4891 # not settable as a field in the request body.
4892 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4893 },
4894 ],
4895 &quot;kind&quot;: &quot;compute#routerList&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
4896 # routers.
4897 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
4898 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
4899 # the query parameter pageToken in the next list request.
4900 # Subsequent list requests will have their own nextPageToken to
4901 # continue paging through the results.
4902 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
4903 &quot;warning&quot;: { # [Output Only] Informational warning message.
4904 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4905 # Engine returns NO_RESULTS_ON_PAGE if there
4906 # are no results in the response.
4907 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4908 # value format. For example:
4909 #
4910 # &quot;data&quot;: [
4911 # {
4912 # &quot;key&quot;: &quot;scope&quot;,
4913 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4914 # }
4915 {
4916 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4917 # returned. For example, for warnings where there are no results in a list
4918 # request for a particular zone, this key might be scope and
4919 # the key value might be the zone name. Other examples might be a key
4920 # indicating a deprecated resource and a suggested replacement, or a
4921 # warning about invalid network settings (for example, if an instance
4922 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4923 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4924 },
4925 ],
4926 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4927 },
4928 }</pre>
4929 </div>
4930
4931 <div class="method">
4932 <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>
4933 <pre>Retrieves a list of router bgp routes available to the specified project.
4934
4935 Args:
4936 project: string, Project ID for this request. (required)
4937 region: string, Name of the region for this request. (required)
4938 router: string, Name or id of the resource for this request.
4939 Name should conform to RFC1035. (required)
4940 addressFamily: string, (Required) limit results to this address family (either IPv4 or IPv6)
4941 Allowed values
4942 IPV4 -
4943 IPV6 -
4944 UNSPECIFIED_IP_VERSION -
4945 destinationPrefix: string, Limit results to destinations that are subnets of this CIDR range
4946 filter: string, A filter expression that filters resources listed in the response. Most
4947 Compute resources support two types of filter expressions:
4948 expressions that support regular expressions and expressions that follow
4949 API improvement proposal AIP-160.
4950 These two types of filter expressions cannot be mixed in one request.
4951
4952 If you want to use AIP-160, your expression must specify the field name, an
4953 operator, and the value that you want to use for filtering. The value
4954 must be a string, a number, or a boolean. The operator
4955 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4956
4957 For example, if you are filtering Compute Engine instances, you can
4958 exclude instances named `example-instance` by specifying
4959 `name != example-instance`.
4960
4961 The `:*` comparison can be used to test whether a key has been defined.
4962 For example, to find all objects with `owner` label use:
4963 ```
4964 labels.owner:*
4965 ```
4966
4967 You can also filter nested fields. For example, you could specify
4968 `scheduling.automaticRestart = false` to include instances only
4969 if they are not scheduled for automatic restarts. You can use filtering
4970 on nested fields to filter based onresource labels.
4971
4972 To filter on multiple expressions, provide each separate expression within
4973 parentheses. For example:
4974 ```
4975 (scheduling.automaticRestart = true)
4976 (cpuPlatform = &quot;Intel Skylake&quot;)
4977 ```
4978 By default, each expression is an `AND` expression. However, you
4979 can include `AND` and `OR` expressions explicitly.
4980 For example:
4981 ```
4982 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4983 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4984 (scheduling.automaticRestart = true)
4985 ```
4986
4987 If you want to use a regular expression, use the `eq` (equal) or `ne`
4988 (not equal) operator against a single un-parenthesized expression with or
4989 without quotes or against multiple parenthesized expressions. Examples:
4990
4991 `fieldname eq unquoted literal`
4992 `fieldname eq &#x27;single quoted literal&#x27;`
4993 `fieldname eq &quot;double quoted literal&quot;`
4994 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4995
4996 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4997 The literal value must match the entire field.
4998
4999 For example, to filter for instances that do not end with name &quot;instance&quot;,
5000 you would use `name ne .*instance`.
5001
5002 You cannot combine constraints on multiple fields using regular
5003 expressions.
5004 maxResults: integer, The maximum number of results per page that should be returned.
5005 If the number of available results is larger than `maxResults`,
5006 Compute Engine returns a `nextPageToken` that can be used to get
5007 the next page of results in subsequent list requests. Acceptable values are
5008 `0` to `500`, inclusive. (Default: `500`)
5009 orderBy: string, Sorts list results by a certain order. By default, results
5010 are returned in alphanumerical order based on the resource name.
5011
5012 You can also sort results in descending order based on the creation
5013 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5014 results based on the `creationTimestamp` field in
5015 reverse chronological order (newest result first). Use this to sort
5016 resources like operations so that the newest operation is returned first.
5017
5018 Currently, only sorting by `name` or
5019 `creationTimestamp desc` is supported.
5020 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5021 `nextPageToken` returned by a previous list request to get
5022 the next page of results.
5023 peer: string, (Required) limit results to the BGP peer with the given name.
5024 Name should conform to RFC1035.
5025 policyApplied: boolean, When true, the method returns post-policy routes. Otherwise, it returns
5026 pre-policy routes.
5027 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5028 of failure. The default value is false.
5029
5030 For example, when partial success behavior is enabled, aggregatedList for a
5031 single zone scope either returns all resources in the zone or no resources,
5032 with an error code.
5033 routeType: string, (Required) limit results to this type of route (either LEARNED or
5034 ADVERTISED)
5035 Allowed values
5036 ADVERTISED -
5037 LEARNED -
5038 UNSPECIFIED_ROUTE_TYPE -
5039 x__xgafv: string, V1 error format.
5040 Allowed values
5041 1 - v1 error format
5042 2 - v2 error format
5043
5044 Returns:
5045 An object of the form:
5046
5047 {
5048 &quot;etag&quot;: &quot;A String&quot;,
5049 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5050 # defined by the server.
5051 &quot;kind&quot;: &quot;compute#routersListBgpRoutes&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#routersListBgpRoutes for lists of bgp routes.
5052 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5053 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5054 # the query parameter pageToken in the next list request.
5055 # Subsequent list requests will have their own nextPageToken to
5056 # continue paging through the results.
5057 &quot;result&quot;: [ # [Output Only] A list of bgp routes.
5058 {
5059 &quot;asPaths&quot;: [ # Output only. [Output only] AS-PATH for the route
5060 {
5061 &quot;asns&quot;: [ # Output only. [Output only] ASNs in the path segment. When type is SEQUENCE, these are
5062 # ordered.
5063 42,
5064 ],
5065 &quot;asns32&quot;: [ # Output only. [Output only] ASNs in the path segment. This field is for better
5066 # support of 32 bit ASNs as the other asns field suffers from overflow when
5067 # the ASN is larger. When type is SEQUENCE, these are ordered.
5068 42,
5069 ],
5070 &quot;type&quot;: &quot;A String&quot;, # Output only. [Output only] Type of AS-PATH segment (SEQUENCE or SET)
5071 },
5072 ],
5073 &quot;communities&quot;: [ # Output only. [Output only] BGP communities in human-readable A:B format.
5074 &quot;A String&quot;,
5075 ],
5076 &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
5077 # format
5078 &quot;pathId&quot;: 42, # If the BGP session supports multiple paths (RFC 7911), the path
5079 # identifier for this route.
5080 &quot;prefix&quot;: &quot;A String&quot;, # Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16.
5081 },
5082 &quot;med&quot;: 42, # Output only. [Output only] BGP multi-exit discriminator
5083 &quot;origin&quot;: &quot;A String&quot;, # Output only. [Output only] BGP origin (EGP, IGP or INCOMPLETE)
5084 },
5085 ],
5086 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5087 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
5088 &quot;A String&quot;,
5089 ],
5090 &quot;warning&quot;: { # [Output Only] Informational warning message.
5091 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5092 # Engine returns NO_RESULTS_ON_PAGE if there
5093 # are no results in the response.
5094 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5095 # value format. For example:
5096 #
5097 # &quot;data&quot;: [
5098 # {
5099 # &quot;key&quot;: &quot;scope&quot;,
5100 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5101 # }
5102 {
5103 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5104 # returned. For example, for warnings where there are no results in a list
5105 # request for a particular zone, this key might be scope and
5106 # the key value might be the zone name. Other examples might be a key
5107 # indicating a deprecated resource and a suggested replacement, or a
5108 # warning about invalid network settings (for example, if an instance
5109 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5110 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5111 },
5112 ],
5113 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5114 },
5115 }</pre>
5116 </div>
5117
5118 <div class="method">
5119 <code class="details" id="listBgpRoutes_next">listBgpRoutes_next()</code>
5120 <pre>Retrieves the next page of results.
5121
5122 Args:
5123 previous_request: The request for the previous page. (required)
5124 previous_response: The response from the request for the previous page. (required)
5125
5126 Returns:
5127 A request object that you can call &#x27;execute()&#x27; on to request the next
5128 page. Returns None if there are no more items in the collection.
5129 </pre>
5130 </div>
5131
5132 <div class="method">
5133 <code class="details" id="listNamedSets">listNamedSets(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5134 <pre>Retrieves a list of router named set subresources available to the
5135 specified project.
5136
5137 Args:
5138 project: string, Project ID for this request. (required)
5139 region: string, Name of the region for this request. (required)
5140 router: string, Name or id of the resource for this request.
5141 Name should conform to RFC1035. (required)
5142 filter: string, A filter expression that filters resources listed in the response. Most
5143 Compute resources support two types of filter expressions:
5144 expressions that support regular expressions and expressions that follow
5145 API improvement proposal AIP-160.
5146 These two types of filter expressions cannot be mixed in one request.
5147
5148 If you want to use AIP-160, your expression must specify the field name, an
5149 operator, and the value that you want to use for filtering. The value
5150 must be a string, a number, or a boolean. The operator
5151 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5152
5153 For example, if you are filtering Compute Engine instances, you can
5154 exclude instances named `example-instance` by specifying
5155 `name != example-instance`.
5156
5157 The `:*` comparison can be used to test whether a key has been defined.
5158 For example, to find all objects with `owner` label use:
5159 ```
5160 labels.owner:*
5161 ```
5162
5163 You can also filter nested fields. For example, you could specify
5164 `scheduling.automaticRestart = false` to include instances only
5165 if they are not scheduled for automatic restarts. You can use filtering
5166 on nested fields to filter based onresource labels.
5167
5168 To filter on multiple expressions, provide each separate expression within
5169 parentheses. For example:
5170 ```
5171 (scheduling.automaticRestart = true)
5172 (cpuPlatform = &quot;Intel Skylake&quot;)
5173 ```
5174 By default, each expression is an `AND` expression. However, you
5175 can include `AND` and `OR` expressions explicitly.
5176 For example:
5177 ```
5178 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5179 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5180 (scheduling.automaticRestart = true)
5181 ```
5182
5183 If you want to use a regular expression, use the `eq` (equal) or `ne`
5184 (not equal) operator against a single un-parenthesized expression with or
5185 without quotes or against multiple parenthesized expressions. Examples:
5186
5187 `fieldname eq unquoted literal`
5188 `fieldname eq &#x27;single quoted literal&#x27;`
5189 `fieldname eq &quot;double quoted literal&quot;`
5190 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5191
5192 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5193 The literal value must match the entire field.
5194
5195 For example, to filter for instances that do not end with name &quot;instance&quot;,
5196 you would use `name ne .*instance`.
5197
5198 You cannot combine constraints on multiple fields using regular
5199 expressions.
5200 maxResults: integer, The maximum number of results per page that should be returned.
5201 If the number of available results is larger than `maxResults`,
5202 Compute Engine returns a `nextPageToken` that can be used to get
5203 the next page of results in subsequent list requests. Acceptable values are
5204 `0` to `500`, inclusive. (Default: `500`)
5205 orderBy: string, Sorts list results by a certain order. By default, results
5206 are returned in alphanumerical order based on the resource name.
5207
5208 You can also sort results in descending order based on the creation
5209 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5210 results based on the `creationTimestamp` field in
5211 reverse chronological order (newest result first). Use this to sort
5212 resources like operations so that the newest operation is returned first.
5213
5214 Currently, only sorting by `name` or
5215 `creationTimestamp desc` is supported.
5216 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5217 `nextPageToken` returned by a previous list request to get
5218 the next page of results.
5219 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5220 of failure. The default value is false.
5221
5222 For example, when partial success behavior is enabled, aggregatedList for a
5223 single zone scope either returns all resources in the zone or no resources,
5224 with an error code.
5225 x__xgafv: string, V1 error format.
5226 Allowed values
5227 1 - v1 error format
5228 2 - v2 error format
5229
5230 Returns:
5231 An object of the form:
5232
5233 {
5234 &quot;etag&quot;: &quot;A String&quot;,
5235 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5236 # defined by the server.
5237 &quot;kind&quot;: &quot;compute#routersListNamedSets&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#routersListNamedSets for lists of named sets.
5238 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5239 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5240 # the query parameter pageToken in the next list request.
5241 # Subsequent list requests will have their own nextPageToken to
5242 # continue paging through the results.
5243 &quot;result&quot;: [ # [Output Only] A list of named sets.
5244 {
5245 &quot;description&quot;: &quot;A String&quot;, # An optional description of named set.
5246 &quot;elements&quot;: [ # CEL expressions that are comparable to constructs of this set&#x27;s type
5247 # (see Policy Language).
5248 { # Represents a textual expression in the Common Expression Language (CEL)
5249 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5250 # are documented at https://github.com/google/cel-spec.
5251 #
5252 # Example (Comparison):
5253 #
5254 # title: &quot;Summary size limit&quot;
5255 # description: &quot;Determines if a summary is less than 100 chars&quot;
5256 # expression: &quot;document.summary.size() &lt; 100&quot;
5257 #
5258 # Example (Equality):
5259 #
5260 # title: &quot;Requestor is owner&quot;
5261 # description: &quot;Determines if requestor is the document owner&quot;
5262 # expression: &quot;document.owner == request.auth.claims.email&quot;
5263 #
5264 # Example (Logic):
5265 #
5266 # title: &quot;Public documents&quot;
5267 # description: &quot;Determine whether the document should be publicly visible&quot;
5268 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5269 #
5270 # Example (Data Manipulation):
5271 #
5272 # title: &quot;Notification string&quot;
5273 # description: &quot;Create a notification string with a timestamp.&quot;
5274 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5275 #
5276 # The exact variables and functions that may be referenced within an expression
5277 # are determined by the service that evaluates it. See the service
5278 # documentation for additional information.
5279 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5280 # describes the expression, e.g. when hovered over it in a UI.
5281 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5282 # syntax.
5283 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5284 # reporting, e.g. a file name and a position in the file.
5285 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5286 # its purpose. This can be used e.g. in UIs which allow to enter the
5287 # expression.
5288 },
5289 ],
5290 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Named Set being applied to this Router, which is
5291 # essentially a hash of the Named Set used for optimistic locking.
5292 # The fingerprint is initially generated by Compute Engine and changes
5293 # after every request to modify or update the Named Set. You must always
5294 # provide an up-to-date fingerprint hash in order to update or change
5295 # labels.
5296 #
5297 # To see the latest fingerprint, make a getNamedSet() request
5298 # to retrieve a Named Set.
5299 &quot;name&quot;: &quot;A String&quot;, # This set&#x27;s name, which must be a resource ID segment and unique within all
5300 # named sets owned by the Router. Name should conform to RFC1035.
5301 &quot;type&quot;: &quot;A String&quot;, # This named set&#x27;s type
5302 },
5303 ],
5304 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5305 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
5306 &quot;A String&quot;,
5307 ],
5308 &quot;warning&quot;: { # [Output Only] Informational warning message.
5309 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5310 # Engine returns NO_RESULTS_ON_PAGE if there
5311 # are no results in the response.
5312 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5313 # value format. For example:
5314 #
5315 # &quot;data&quot;: [
5316 # {
5317 # &quot;key&quot;: &quot;scope&quot;,
5318 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5319 # }
5320 {
5321 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5322 # returned. For example, for warnings where there are no results in a list
5323 # request for a particular zone, this key might be scope and
5324 # the key value might be the zone name. Other examples might be a key
5325 # indicating a deprecated resource and a suggested replacement, or a
5326 # warning about invalid network settings (for example, if an instance
5327 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5328 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5329 },
5330 ],
5331 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5332 },
5333 }</pre>
5334 </div>
5335
5336 <div class="method">
5337 <code class="details" id="listNamedSets_next">listNamedSets_next()</code>
5338 <pre>Retrieves the next page of results.
5339
5340 Args:
5341 previous_request: The request for the previous page. (required)
5342 previous_response: The response from the request for the previous page. (required)
5343
5344 Returns:
5345 A request object that you can call &#x27;execute()&#x27; on to request the next
5346 page. Returns None if there are no more items in the collection.
5347 </pre>
5348 </div>
5349
5350 <div class="method">
5351 <code class="details" id="listRoutePolicies">listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5352 <pre>Retrieves a list of router route policy subresources available to the
5353 specified project.
5354
5355 Args:
5356 project: string, Project ID for this request. (required)
5357 region: string, Name of the region for this request. (required)
5358 router: string, Name or id of the resource for this request.
5359 Name should conform to RFC1035. (required)
5360 filter: string, A filter expression that filters resources listed in the response. Most
5361 Compute resources support two types of filter expressions:
5362 expressions that support regular expressions and expressions that follow
5363 API improvement proposal AIP-160.
5364 These two types of filter expressions cannot be mixed in one request.
5365
5366 If you want to use AIP-160, your expression must specify the field name, an
5367 operator, and the value that you want to use for filtering. The value
5368 must be a string, a number, or a boolean. The operator
5369 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5370
5371 For example, if you are filtering Compute Engine instances, you can
5372 exclude instances named `example-instance` by specifying
5373 `name != example-instance`.
5374
5375 The `:*` comparison can be used to test whether a key has been defined.
5376 For example, to find all objects with `owner` label use:
5377 ```
5378 labels.owner:*
5379 ```
5380
5381 You can also filter nested fields. For example, you could specify
5382 `scheduling.automaticRestart = false` to include instances only
5383 if they are not scheduled for automatic restarts. You can use filtering
5384 on nested fields to filter based onresource labels.
5385
5386 To filter on multiple expressions, provide each separate expression within
5387 parentheses. For example:
5388 ```
5389 (scheduling.automaticRestart = true)
5390 (cpuPlatform = &quot;Intel Skylake&quot;)
5391 ```
5392 By default, each expression is an `AND` expression. However, you
5393 can include `AND` and `OR` expressions explicitly.
5394 For example:
5395 ```
5396 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5397 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5398 (scheduling.automaticRestart = true)
5399 ```
5400
5401 If you want to use a regular expression, use the `eq` (equal) or `ne`
5402 (not equal) operator against a single un-parenthesized expression with or
5403 without quotes or against multiple parenthesized expressions. Examples:
5404
5405 `fieldname eq unquoted literal`
5406 `fieldname eq &#x27;single quoted literal&#x27;`
5407 `fieldname eq &quot;double quoted literal&quot;`
5408 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5409
5410 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5411 The literal value must match the entire field.
5412
5413 For example, to filter for instances that do not end with name &quot;instance&quot;,
5414 you would use `name ne .*instance`.
5415
5416 You cannot combine constraints on multiple fields using regular
5417 expressions.
5418 maxResults: integer, The maximum number of results per page that should be returned.
5419 If the number of available results is larger than `maxResults`,
5420 Compute Engine returns a `nextPageToken` that can be used to get
5421 the next page of results in subsequent list requests. Acceptable values are
5422 `0` to `500`, inclusive. (Default: `500`)
5423 orderBy: string, Sorts list results by a certain order. By default, results
5424 are returned in alphanumerical order based on the resource name.
5425
5426 You can also sort results in descending order based on the creation
5427 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5428 results based on the `creationTimestamp` field in
5429 reverse chronological order (newest result first). Use this to sort
5430 resources like operations so that the newest operation is returned first.
5431
5432 Currently, only sorting by `name` or
5433 `creationTimestamp desc` is supported.
5434 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5435 `nextPageToken` returned by a previous list request to get
5436 the next page of results.
5437 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5438 of failure. The default value is false.
5439
5440 For example, when partial success behavior is enabled, aggregatedList for a
5441 single zone scope either returns all resources in the zone or no resources,
5442 with an error code.
5443 x__xgafv: string, V1 error format.
5444 Allowed values
5445 1 - v1 error format
5446 2 - v2 error format
5447
5448 Returns:
5449 An object of the form:
5450
5451 {
5452 &quot;etag&quot;: &quot;A String&quot;,
5453 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5454 # defined by the server.
5455 &quot;kind&quot;: &quot;compute#routersListRoutePolicies&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#routersListRoutePolicies for lists of route policies.
5456 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5457 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5458 # the query parameter pageToken in the next list request.
5459 # Subsequent list requests will have their own nextPageToken to
5460 # continue paging through the results.
5461 &quot;result&quot;: [ # [Output Only] A list of route policies.
5462 {
5463 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
5464 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
5465 # essentially a hash of the Route Policy used for optimistic locking.
5466 # The fingerprint is initially generated by Compute Engine and changes
5467 # after every request to modify or update Route Policy. You must always
5468 # provide an up-to-date fingerprint hash in order to update or change
5469 # labels.
5470 #
5471 # To see the latest fingerprint, make a getRoutePolicy() request
5472 # to retrieve a Route Policy.
5473 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
5474 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
5475 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
5476 # in order of priority). Order of policies is not retained and might change
5477 # when getting policy later.
5478 {
5479 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
5480 { # Represents a textual expression in the Common Expression Language (CEL)
5481 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5482 # are documented at https://github.com/google/cel-spec.
5483 #
5484 # Example (Comparison):
5485 #
5486 # title: &quot;Summary size limit&quot;
5487 # description: &quot;Determines if a summary is less than 100 chars&quot;
5488 # expression: &quot;document.summary.size() &lt; 100&quot;
5489 #
5490 # Example (Equality):
5491 #
5492 # title: &quot;Requestor is owner&quot;
5493 # description: &quot;Determines if requestor is the document owner&quot;
5494 # expression: &quot;document.owner == request.auth.claims.email&quot;
5495 #
5496 # Example (Logic):
5497 #
5498 # title: &quot;Public documents&quot;
5499 # description: &quot;Determine whether the document should be publicly visible&quot;
5500 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5501 #
5502 # Example (Data Manipulation):
5503 #
5504 # title: &quot;Notification string&quot;
5505 # description: &quot;Create a notification string with a timestamp.&quot;
5506 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5507 #
5508 # The exact variables and functions that may be referenced within an expression
5509 # are determined by the service that evaluates it. See the service
5510 # documentation for additional information.
5511 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5512 # describes the expression, e.g. when hovered over it in a UI.
5513 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5514 # syntax.
5515 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5516 # reporting, e.g. a file name and a position in the file.
5517 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5518 # its purpose. This can be used e.g. in UIs which allow to enter the
5519 # expression.
5520 },
5521 ],
5522 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
5523 # applies. When not set, the term applies to all
5524 # routes.
5525 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5526 # are documented at https://github.com/google/cel-spec.
5527 #
5528 # Example (Comparison):
5529 #
5530 # title: &quot;Summary size limit&quot;
5531 # description: &quot;Determines if a summary is less than 100 chars&quot;
5532 # expression: &quot;document.summary.size() &lt; 100&quot;
5533 #
5534 # Example (Equality):
5535 #
5536 # title: &quot;Requestor is owner&quot;
5537 # description: &quot;Determines if requestor is the document owner&quot;
5538 # expression: &quot;document.owner == request.auth.claims.email&quot;
5539 #
5540 # Example (Logic):
5541 #
5542 # title: &quot;Public documents&quot;
5543 # description: &quot;Determine whether the document should be publicly visible&quot;
5544 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5545 #
5546 # Example (Data Manipulation):
5547 #
5548 # title: &quot;Notification string&quot;
5549 # description: &quot;Create a notification string with a timestamp.&quot;
5550 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5551 #
5552 # The exact variables and functions that may be referenced within an expression
5553 # are determined by the service that evaluates it. See the service
5554 # documentation for additional information.
5555 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5556 # describes the expression, e.g. when hovered over it in a UI.
5557 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5558 # syntax.
5559 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5560 # reporting, e.g. a file name and a position in the file.
5561 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5562 # its purpose. This can be used e.g. in UIs which allow to enter the
5563 # expression.
5564 },
5565 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
5566 # (inclusive) and 2^31 (exclusive), and unique within the list.
5567 },
5568 ],
5569 &quot;type&quot;: &quot;A String&quot;,
5570 },
5571 ],
5572 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5573 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
5574 &quot;A String&quot;,
5575 ],
5576 &quot;warning&quot;: { # [Output Only] Informational warning message.
5577 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5578 # Engine returns NO_RESULTS_ON_PAGE if there
5579 # are no results in the response.
5580 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5581 # value format. For example:
5582 #
5583 # &quot;data&quot;: [
5584 # {
5585 # &quot;key&quot;: &quot;scope&quot;,
5586 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5587 # }
5588 {
5589 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5590 # returned. For example, for warnings where there are no results in a list
5591 # request for a particular zone, this key might be scope and
5592 # the key value might be the zone name. Other examples might be a key
5593 # indicating a deprecated resource and a suggested replacement, or a
5594 # warning about invalid network settings (for example, if an instance
5595 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5596 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5597 },
5598 ],
5599 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5600 },
5601 }</pre>
5602 </div>
5603
5604 <div class="method">
5605 <code class="details" id="listRoutePolicies_next">listRoutePolicies_next()</code>
5606 <pre>Retrieves the next page of results.
5607
5608 Args:
5609 previous_request: The request for the previous page. (required)
5610 previous_response: The response from the request for the previous page. (required)
5611
5612 Returns:
5613 A request object that you can call &#x27;execute()&#x27; on to request the next
5614 page. Returns None if there are no more items in the collection.
5615 </pre>
5616 </div>
5617
5618 <div class="method">
5619 <code class="details" id="list_next">list_next()</code>
5620 <pre>Retrieves the next page of results.
5621
5622 Args:
5623 previous_request: The request for the previous page. (required)
5624 previous_response: The response from the request for the previous page. (required)
5625
5626 Returns:
5627 A request object that you can call &#x27;execute()&#x27; on to request the next
5628 page. Returns None if there are no more items in the collection.
5629 </pre>
5630 </div>
5631
5632 <div class="method">
5633 <code class="details" id="patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
5634 <pre>Patches the specified Router resource with the data included in the
5635 request. This method supportsPATCH
5636 semantics and usesJSON merge
5637 patch format and processing rules.
5638
5639 Args:
5640 project: string, Project ID for this request. (required)
5641 region: string, Name of the region for this request. (required)
5642 router: string, Name of the Router resource to patch. (required)
5643 body: object, The request body.
5644 The object takes the form of:
5645
5646 { # Represents a Cloud Router resource.
5647 #
5648 # For more information about Cloud Router, read theCloud
5649 # Router overview.
5650 &quot;bgp&quot;: { # BGP information specific to this router.
5651 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
5652 # The options are DEFAULT or CUSTOM.
5653 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
5654 # This field can only be populated if advertise_mode is CUSTOM and
5655 # is advertised to all peers of the router.
5656 # These groups will be advertised in addition to any specified prefixes.
5657 # Leave this field blank to advertise no custom groups.
5658 &quot;A String&quot;,
5659 ],
5660 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
5661 # This field can only be populated if advertise_mode is CUSTOM and
5662 # is advertised to all peers of the router.
5663 # These IP ranges will be advertised in addition to any specified groups.
5664 # Leave this field blank to advertise no custom IP ranges.
5665 { # Description-tagged IP ranges for the router to advertise.
5666 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
5667 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
5668 },
5669 ],
5670 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
5671 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
5672 # value will be fixed for this router resource. All VPN tunnels that link
5673 # to this router will have the same local ASN.
5674 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
5675 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
5676 # least /30, even if the BGP sessions are over IPv6. It must not overlap
5677 # with any IPv4 BGP session ranges.
5678 #
5679 #
5680 # Other vendors commonly call this &quot;router ID&quot;.
5681 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
5682 # sent to the peer.
5683 #
5684 #
5685 # Hold time is three times the interval at which keepalive messages are
5686 # sent, and the hold time is the maximum number of seconds allowed to
5687 # elapse between successive keepalive messages that BGP receives from a
5688 # peer.
5689 #
5690 #
5691 # BGP will use the smaller of either the local hold time value or the
5692 # peer&#x27;s hold time value as the hold time for the BGP connection between
5693 # the two peers.
5694 #
5695 #
5696 # If set, this value must be between 20 and 60. The default is 20.
5697 },
5698 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
5699 # establish BGP peering. This information must specify the peer ASN and
5700 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
5701 {
5702 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
5703 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
5704 # which currently supports the following option:
5705 #
5706 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
5707 # excludes any routes learned for subnets that use
5708 # VPC Network Peering.
5709 #
5710 #
5711 # Note that this field can only be populated if advertise_mode is CUSTOM
5712 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
5713 # These groups are advertised in addition to any specified prefixes.
5714 # Leave this field blank to advertise no custom groups.
5715 &quot;A String&quot;,
5716 ],
5717 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
5718 # This field can only be populated if advertise_mode is CUSTOM and
5719 # overrides the list defined for the router (in the &quot;bgp&quot; message).
5720 # These IP ranges are advertised in addition to any specified groups.
5721 # Leave this field blank to advertise no custom IP ranges.
5722 { # Description-tagged IP ranges for the router to advertise.
5723 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
5724 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
5725 },
5726 ],
5727 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
5728 # than one matching route of maximum length, the routes with the lowest
5729 # priority value win.
5730 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
5731 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
5732 # received from the peer router. The actual value is negotiated between
5733 # the two routers and is equal to the greater of this value and the
5734 # transmit interval of the other router.
5735 #
5736 #
5737 # If set, this value must be between 1000 and 30000.
5738 #
5739 #
5740 # The default is 1000.
5741 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
5742 # transmitted to the peer router. The actual value is negotiated between
5743 # the two routers and is equal to the greater of this value and the
5744 # corresponding receive interval of the other router.
5745 #
5746 #
5747 # If set, this value must be between 1000 and 30000.
5748 #
5749 #
5750 # The default is 1000.
5751 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
5752 # before BFD declares that a peer is unavailable.
5753 #
5754 #
5755 # If set, the value must be a value between 5 and 16.
5756 #
5757 #
5758 # The default is 5.
5759 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
5760 #
5761 #
5762 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
5763 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
5764 # peer router to initiate the BFD session for this BGP peer. If set to
5765 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
5766 },
5767 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
5768 # session.
5769 {
5770 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
5771 # CIDR-formatted prefix. If an IP address is provided without a subnet
5772 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
5773 # range, and, for IPv6, `/128`.
5774 },
5775 ],
5776 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
5777 # value is applied to all custom learned route ranges for the session.
5778 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
5779 # value, Google Cloud assigns a priority of `100` to the ranges.
5780 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
5781 #
5782 #
5783 # If set to FALSE, any active session with the peer is terminated and
5784 # all associated routing information is removed. If set to TRUE, the
5785 # peer connection can be established with routing information. The default
5786 # is TRUE.
5787 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
5788 # the peerIpAddress is version 4.
5789 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
5790 # peerIpAddress is version 6.
5791 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
5792 # evaluated. The name must correspond to an existing policy that has
5793 # ROUTE_POLICY_TYPE_EXPORT type.
5794 &quot;A String&quot;,
5795 ],
5796 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
5797 # evaluated. The name must correspond to an existing policy that has
5798 # ROUTE_POLICY_TYPE_IMPORT type.
5799 &quot;A String&quot;,
5800 ],
5801 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
5802 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
5803 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
5804 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
5805 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
5806 #
5807 # - MANAGED_BY_USER is the default value and can be managed by you
5808 # or other users
5809 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
5810 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
5811 # PARTNER. Google automatically creates, updates, and deletes this type of
5812 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
5813 # or deleted.
5814 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
5815 # name of one of the entries in the Router.md5_authentication_keys. The
5816 # field must comply with RFC1035.
5817 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
5818 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
5819 # characters long and match the regular expression
5820 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
5821 # lowercase letter, and all following characters must be a dash, lowercase
5822 # letter, or digit, except the last character, which cannot be a dash.
5823 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
5824 # a different value.
5825 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
5826 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
5827 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
5828 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
5829 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
5830 # Appliances. The VM instance must be located in zones contained in the
5831 # same region as this Cloud Router.
5832 # The VM instance is the peer side of the BGP session.
5833 },
5834 ],
5835 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5836 # text format.
5837 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5838 # create the resource.
5839 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
5840 # attachments (interconnectAttachments).
5841 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5842 # defined by the server.
5843 &quot;interfaces&quot;: [ # Router interfaces.
5844 # To create a BGP peer that uses a router interface,
5845 # the interface must have one of the following fields specified:
5846 #
5847 # - linkedVpnTunnel
5848 # - linkedInterconnectAttachment
5849 # - subnetwork
5850 #
5851 #
5852 # You can create a router interface without any of these fields specified.
5853 # However, you cannot create a BGP peer that uses that interface.
5854 {
5855 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
5856 #
5857 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
5858 # be a CIDR-formatted string, for example, 169.254.0.1/30.
5859 # Note: Do not truncate the IP address, as it represents the IP address of
5860 # the interface.
5861 # - For Internet Protocol version 6 (IPv6), the value
5862 # must be a unique local address (ULA) range from fdff:1::/64
5863 # with a mask length of 126 or less. This value should be a CIDR-formatted
5864 # string, for example, fdff:1::1/112. Within the router&#x27;s
5865 # VPC, this IPv6 prefix will be reserved exclusively for this connection
5866 # and cannot be used for any other purpose.
5867 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
5868 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
5869 # as the router. Each interface can have one linked resource, which can be
5870 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
5871 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
5872 # router. Each interface can have one linked resource, which can be
5873 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
5874 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
5875 #
5876 # - MANAGED_BY_USER is the default value and can be managed directly
5877 # by users.
5878 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
5879 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
5880 # of type PARTNER. Google automatically creates, updates, and deletes
5881 # this type of interface when the PARTNER InterconnectAttachment is
5882 # created, updated, or deleted.
5883 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
5884 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
5885 # characters long and match the regular expression
5886 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
5887 # lowercase letter, and all following characters must be a dash, lowercase
5888 # letter, or digit, except the last character, which cannot be a dash.
5889 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
5890 # BGP sessions to a VM instance acting as a third-party
5891 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
5892 # an SD-WAN VM.
5893 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
5894 # you are creating. The redundantInterface must belong to the same Cloud
5895 # Router as the interface here. To establish the BGP session to a Router
5896 # Appliance VM, you must create two BGP peers. The two BGP peers must be
5897 # attached to two separate interfaces that are redundant with each other.
5898 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
5899 # be 1-63 characters long and match the regular expression
5900 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
5901 # lowercase letter, and all following characters must be a dash, lowercase
5902 # letter, or digit, except the last character, which cannot be a dash.
5903 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
5904 # must be in the same region as the Cloud Router.
5905 # When you establish a BGP session to a VM instance using this interface,
5906 # the VM instance must belong to the same subnetwork as the subnetwork
5907 # specified here.
5908 },
5909 ],
5910 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
5911 # routers.
5912 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
5913 {
5914 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
5915 #
5916 # For patch and update calls, it can be skipped to
5917 # copy the value from the previous configuration. This is allowed if the
5918 # key with the same name existed before the operation. Maximum length is 80
5919 # characters. Can only contain printable ASCII characters.
5920 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
5921 #
5922 # Must be unique within a router. Must be referenced by exactly
5923 # one bgpPeer. Must comply withRFC1035.
5924 },
5925 ],
5926 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
5927 # The name must be 1-63 characters long, and comply withRFC1035.
5928 # Specifically, the name must be 1-63 characters long and match the regular
5929 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5930 # character must be a lowercase letter, and all following characters must
5931 # be a dash, lowercase letter, or digit, except the last character, which
5932 # cannot be a dash.
5933 &quot;nats&quot;: [ # A list of NAT services created in this router.
5934 { # Represents a Nat resource. It enables the VMs within the specified
5935 # subnetworks to access Internet without external IP addresses. It specifies
5936 # a list of subnetworks (and the ranges within) that want to use NAT.
5937 # Customers can also provide the external IPs that would be used for NAT. GCP
5938 # would auto-allocate ephemeral IPs if no external IPs are provided.
5939 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
5940 # Must be one of: PREMIUM, STANDARD.
5941 # If not specified, then the current
5942 # project-level default tier is used.
5943 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
5944 # must be valid static external IPs that have been assigned to the NAT.
5945 # These IPs should be used for updating/patching a NAT only.
5946 &quot;A String&quot;,
5947 ],
5948 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
5949 # state. This value is equal to tcp_time_wait_timeout_sec.
5950 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
5951 # 120s. The field is output only.
5952 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
5953 #
5954 #
5955 # If not specified, it is disabled by default.
5956 #
5957 #
5958 # If set to true,
5959 #
5960 # - Dynamic Port Allocation will be enabled on this NAT
5961 # config.
5962 # - enableEndpointIndependentMapping cannot be set to true.
5963 # - If minPorts is set, minPortsPerVm must be set to a
5964 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
5965 # minimum of 32 ports will be allocated to a VM from this NAT
5966 # config.
5967 &quot;enableEndpointIndependentMapping&quot;: True or False,
5968 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
5969 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
5970 &quot;A String&quot;,
5971 ],
5972 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
5973 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
5974 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
5975 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
5976 # logs are exported for all connections handled by this NAT.
5977 # This option can take one of the following values:
5978 #
5979 # - ERRORS_ONLY: Export logs only for connection failures.
5980 # - TRANSLATIONS_ONLY: Export logs only for successful
5981 # connections.
5982 # - ALL: Export logs for all connections, successful and
5983 # unsuccessful.
5984 },
5985 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
5986 # Dynamic Port Allocation is enabled.
5987 #
5988 #
5989 # If Dynamic Port Allocation is not enabled, this field has no effect.
5990 #
5991 #
5992 # If Dynamic Port Allocation is enabled, and this field is set, it must be
5993 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
5994 # is not set.
5995 #
5996 #
5997 # If Dynamic Port Allocation is enabled and this field is not set,
5998 # a maximum of 65536 ports will be allocated to a VM from this NAT
5999 # config.
6000 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
6001 # set, a default number of ports is allocated to a VM. This is rounded
6002 # up to the nearest power of 2. For example, if the value of this field is
6003 # 50, at least 64 ports are allocated to a VM.
6004 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
6005 # The name must be 1-63 characters long and comply withRFC1035.
6006 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
6007 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
6008 # selected for the SubnetworkIpRangeToNat64Option above.
6009 { # Specifies a subnetwork to enable NAT64.
6010 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
6011 },
6012 ],
6013 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
6014 # values:
6015 #
6016 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
6017 # customers. When there are not enough specified Nat IPs, the Nat service
6018 # fails for new VMs.
6019 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
6020 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
6021 # be empty.
6022 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
6023 # addresses must be valid static external IP addresses assigned to the
6024 # project.
6025 &quot;A String&quot;,
6026 ],
6027 &quot;rules&quot;: [ # A list of rules associated with this NAT.
6028 {
6029 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
6030 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
6031 # addresses must be valid static external IP addresses assigned to the
6032 # project.
6033 # This field is used for public NAT.
6034 &quot;A String&quot;,
6035 ],
6036 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
6037 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
6038 # This field is used for private NAT.
6039 &quot;A String&quot;,
6040 ],
6041 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
6042 # must be valid static external IPs that have been assigned to the NAT.
6043 # These IPs should be used for updating/patching a NAT rule only.
6044 # This field is used for public NAT.
6045 &quot;A String&quot;,
6046 ],
6047 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
6048 # drained. This is only supported on patch/update, and these
6049 # subnetworks must have previously been used as active ranges in this
6050 # NAT Rule.
6051 # This field is used for private NAT.
6052 &quot;A String&quot;,
6053 ],
6054 },
6055 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
6056 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
6057 # from a VM is evaluated against. If it evaluates to true, the
6058 # corresponding `action` is enforced.
6059 #
6060 # The following examples are valid match expressions for public NAT:
6061 #
6062 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
6063 # &#x27;2.2.0.0/16&#x27;)`
6064 #
6065 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
6066 #
6067 # The following example is a valid match expression for private NAT:
6068 #
6069 # `nexthop.hub ==
6070 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
6071 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
6072 # must be a positive value between 0 and 65000, and
6073 # must be unique among rules within a NAT.
6074 },
6075 ],
6076 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
6077 #
6078 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
6079 # Subnetwork are allowed to Nat.
6080 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
6081 # in every Subnetwork are allowed to Nat.
6082 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
6083 # (specified in the field subnetwork below)
6084 #
6085 #
6086 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
6087 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
6088 # should not be any other Router.Nat section in any Router for this network
6089 # in this region.
6090 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
6091 # values:
6092 #
6093 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
6094 # every Subnetwork are allowed to Nat.
6095 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
6096 # (specified in the field nat64_subnetwork below)
6097 #
6098 #
6099 # The default is NAT64_OPTION_UNSPECIFIED.
6100 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
6101 # Router.Nat section in this region can also enable NAT64 for any
6102 # Subnetworks in this network. Other Router.Nat sections can still be
6103 # present to enable NAT44 only.
6104 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
6105 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
6106 # SubnetworkIpRangeToNatOption above.
6107 { # Defines the IP ranges that want to use NAT for a subnetwork.
6108 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
6109 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
6110 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
6111 # is one of the values in source_ip_ranges_to_nat.
6112 &quot;A String&quot;,
6113 ],
6114 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
6115 # options of a single value are valid except
6116 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
6117 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
6118 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
6119 # Default: [ALL_IP_RANGES]
6120 &quot;A String&quot;,
6121 ],
6122 },
6123 ],
6124 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
6125 # if not set.
6126 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
6127 # Defaults to 120s if not set.
6128 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
6129 # not set.
6130 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
6131 # translation. If unspecified, it defaults to PUBLIC.
6132 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
6133 },
6134 ],
6135 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
6136 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
6137 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
6138 # as part of resource payload.
6139 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
6140 # The field is allowed for INSERT
6141 # only. The keys/values to set on the resource should be specified in
6142 # either ID { : } or Namespaced format
6143 # { : }.
6144 # For example the following are valid inputs:
6145 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
6146 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
6147 # Note:
6148 # * Invalid combinations of ID &amp; namespaced format is not supported. For
6149 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
6150 # * Inconsistent format is not supported. For instance:
6151 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
6152 &quot;a_key&quot;: &quot;A String&quot;,
6153 },
6154 },
6155 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
6156 # You must specify this field as part of the HTTP request URL. It is
6157 # not settable as a field in the request body.
6158 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6159 }
6160
6161 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6162 that if you must retry your request, the server will know to ignore the
6163 request if it has already been completed.
6164
6165 For example, consider a situation where you make an initial request and
6166 the request times out. If you make the request again with the same
6167 request ID, the server can check if original operation with the same
6168 request ID was received, and if so, will ignore the second request. This
6169 prevents clients from accidentally creating duplicate commitments.
6170
6171 The request ID must be
6172 a valid UUID with the exception that zero UUID is not supported
6173 (00000000-0000-0000-0000-000000000000).
6174 x__xgafv: string, V1 error format.
6175 Allowed values
6176 1 - v1 error format
6177 2 - v2 error format
6178
6179 Returns:
6180 An object of the form:
6181
6182 { # Represents an Operation resource.
6183 #
6184 # Google Compute Engine has three Operation resources:
6185 #
6186 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6187 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6188 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6189 #
6190 # You can use an operation resource to manage asynchronous API requests.
6191 # For more information, readHandling
6192 # API responses.
6193 #
6194 # Operations can be global, regional or zonal.
6195 #
6196 # - For global operations, use the `globalOperations`
6197 # resource.
6198 # - For regional operations, use the
6199 # `regionOperations` resource.
6200 # - For zonal operations, use
6201 # the `zoneOperations` resource.
6202 #
6203 #
6204 #
6205 # For more information, read
6206 # Global, Regional, and Zonal Resources.
6207 #
6208 # Note that completed Operation resources have a limited
6209 # retention period.
6210 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6211 # Not present otherwise.
6212 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6213 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6214 # set when the operation is created.
6215 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6216 # text format.
6217 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6218 # this field will be populated.
6219 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6220 # operation.
6221 {
6222 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6223 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6224 # details. There is a set of defined message types to use for providing
6225 # details.The syntax depends on the error code. For example,
6226 # QuotaExceededInfo will have details when the error code is
6227 # QUOTA_EXCEEDED.
6228 {
6229 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6230 #
6231 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6232 # is not enabled:
6233 #
6234 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6235 # &quot;domain&quot;: &quot;googleapis.com&quot;
6236 # &quot;metadata&quot;: {
6237 # &quot;resource&quot;: &quot;projects/123&quot;,
6238 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6239 # }
6240 # }
6241 #
6242 # This response indicates that the pubsub.googleapis.com API is not enabled.
6243 #
6244 # Example of an error that is returned when attempting to create a Spanner
6245 # instance in a region that is out of stock:
6246 #
6247 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6248 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6249 # &quot;metadata&quot;: {
6250 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6251 # }
6252 # }
6253 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6254 # is typically the registered service name of the tool or product that
6255 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6256 # generated by some common infrastructure, the error domain must be a
6257 # globally unique value that identifies the infrastructure. For Google API
6258 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6259 &quot;metadatas&quot;: { # Additional structured details about this error.
6260 #
6261 # Keys must match a regular expression of `a-z+` but should
6262 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6263 # length. When identifying the current value of an exceeded limit, the units
6264 # should be contained in the key, not the value. For example, rather than
6265 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6266 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6267 # instances that can be created in a single (batch) request.
6268 &quot;a_key&quot;: &quot;A String&quot;,
6269 },
6270 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6271 # proximate cause of the error. Error reasons are unique within a particular
6272 # domain of errors. This should be at most 63 characters and match a
6273 # regular expression of `A-Z+[A-Z0-9]`, which represents
6274 # UPPER_SNAKE_CASE.
6275 },
6276 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6277 #
6278 # For example, if a quota check failed with an error indicating the calling
6279 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6280 # directly to the right place in the developer console to flip the bit.
6281 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6282 { # Describes a URL link.
6283 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6284 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6285 },
6286 ],
6287 },
6288 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6289 # which can be attached to an RPC error.
6290 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6291 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6292 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6293 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6294 },
6295 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6296 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6297 &quot;a_key&quot;: &quot;A String&quot;,
6298 },
6299 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6300 # type or metric.
6301 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6302 # or metric.
6303 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6304 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6305 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6306 },
6307 },
6308 ],
6309 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6310 # This property is optional.
6311 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6312 },
6313 ],
6314 },
6315 &quot;getVersionOperationMetadata&quot;: {
6316 &quot;inlineSbomInfo&quot;: {
6317 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6318 # appropriate identifiers.
6319 &quot;a_key&quot;: &quot;A String&quot;,
6320 },
6321 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6322 # identifiers.
6323 &quot;a_key&quot;: &quot;A String&quot;,
6324 },
6325 },
6326 },
6327 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6328 # message that was returned, such as `NOT FOUND`.
6329 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6330 # status code that was returned. For example, a `404` means the
6331 # resource was not found.
6332 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6333 # defined by the server.
6334 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6335 # This value is inRFC3339
6336 # text format.
6337 &quot;instancesBulkInsertOperationMetadata&quot;: {
6338 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6339 # Example key: zones/us-central1-a
6340 &quot;a_key&quot;: {
6341 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6342 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6343 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6344 # error.
6345 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6346 # if the flow is rolling forward or rolling back.
6347 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6348 },
6349 },
6350 },
6351 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6352 # Operation resources.
6353 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6354 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6355 # group of operations results from a `bulkInsert` API request.
6356 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6357 # `update`, or `delete`, and so on.
6358 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6359 # There is no requirement that this be linear or support any granularity of
6360 # operations. This should not be used to guess when the operation will be
6361 # complete. This number should monotonically increase as the operation
6362 # progresses.
6363 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6364 # applicable when performing regional operations.
6365 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6366 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6367 # this field will contain information on all underlying zonal actions and
6368 # their state.
6369 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6370 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6371 # Example key: zones/us-central1-a
6372 &quot;a_key&quot;: {
6373 &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
6374 # populated.
6375 # different programming environments, including REST APIs and RPC APIs. It is
6376 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6377 # three pieces of data: error code, error message, and error details.
6378 #
6379 # You can find out more about this error model and how to work with it in the
6380 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6381 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6382 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6383 # message types for APIs to use.
6384 {
6385 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6386 },
6387 ],
6388 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6389 # user-facing error message should be localized and sent in the
6390 # google.rpc.Status.details field, or localized by the client.
6391 },
6392 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6393 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6394 },
6395 },
6396 },
6397 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6398 # This value is inRFC3339
6399 # text format.
6400 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6401 # following:
6402 # `PENDING`, `RUNNING`, or `DONE`.
6403 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6404 # operation.
6405 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6406 # of the target resource.
6407 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6408 # operations related to creating a snapshot, this points to the disk
6409 # that the snapshot was created from.
6410 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6411 # `[email protected]` or
6412 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6413 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6414 # operation, this field will be populated.
6415 {
6416 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6417 # Engine returns NO_RESULTS_ON_PAGE if there
6418 # are no results in the response.
6419 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6420 # value format. For example:
6421 #
6422 # &quot;data&quot;: [
6423 # {
6424 # &quot;key&quot;: &quot;scope&quot;,
6425 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6426 # }
6427 {
6428 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6429 # returned. For example, for warnings where there are no results in a list
6430 # request for a particular zone, this key might be scope and
6431 # the key value might be the zone name. Other examples might be a key
6432 # indicating a deprecated resource and a suggested replacement, or a
6433 # warning about invalid network settings (for example, if an instance
6434 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6435 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6436 },
6437 ],
6438 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6439 },
6440 ],
6441 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6442 # applicable when performing per-zone operations.
6443 }</pre>
6444 </div>
6445
6446 <div class="method">
6447 <code class="details" id="patchNamedSet">patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
6448 <pre>Patches Named Set
6449
6450 Args:
6451 project: string, Project ID for this request. (required)
6452 region: string, Name of the region for this request. (required)
6453 router: string, Name of the Router resource where Named Set is defined. (required)
6454 body: object, The request body.
6455 The object takes the form of:
6456
6457 {
6458 &quot;description&quot;: &quot;A String&quot;, # An optional description of named set.
6459 &quot;elements&quot;: [ # CEL expressions that are comparable to constructs of this set&#x27;s type
6460 # (see Policy Language).
6461 { # Represents a textual expression in the Common Expression Language (CEL)
6462 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6463 # are documented at https://github.com/google/cel-spec.
6464 #
6465 # Example (Comparison):
6466 #
6467 # title: &quot;Summary size limit&quot;
6468 # description: &quot;Determines if a summary is less than 100 chars&quot;
6469 # expression: &quot;document.summary.size() &lt; 100&quot;
6470 #
6471 # Example (Equality):
6472 #
6473 # title: &quot;Requestor is owner&quot;
6474 # description: &quot;Determines if requestor is the document owner&quot;
6475 # expression: &quot;document.owner == request.auth.claims.email&quot;
6476 #
6477 # Example (Logic):
6478 #
6479 # title: &quot;Public documents&quot;
6480 # description: &quot;Determine whether the document should be publicly visible&quot;
6481 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6482 #
6483 # Example (Data Manipulation):
6484 #
6485 # title: &quot;Notification string&quot;
6486 # description: &quot;Create a notification string with a timestamp.&quot;
6487 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6488 #
6489 # The exact variables and functions that may be referenced within an expression
6490 # are determined by the service that evaluates it. See the service
6491 # documentation for additional information.
6492 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6493 # describes the expression, e.g. when hovered over it in a UI.
6494 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6495 # syntax.
6496 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6497 # reporting, e.g. a file name and a position in the file.
6498 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6499 # its purpose. This can be used e.g. in UIs which allow to enter the
6500 # expression.
6501 },
6502 ],
6503 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Named Set being applied to this Router, which is
6504 # essentially a hash of the Named Set used for optimistic locking.
6505 # The fingerprint is initially generated by Compute Engine and changes
6506 # after every request to modify or update the Named Set. You must always
6507 # provide an up-to-date fingerprint hash in order to update or change
6508 # labels.
6509 #
6510 # To see the latest fingerprint, make a getNamedSet() request
6511 # to retrieve a Named Set.
6512 &quot;name&quot;: &quot;A String&quot;, # This set&#x27;s name, which must be a resource ID segment and unique within all
6513 # named sets owned by the Router. Name should conform to RFC1035.
6514 &quot;type&quot;: &quot;A String&quot;, # This named set&#x27;s type
6515 }
6516
6517 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6518 that if you must retry your request, the server will know to ignore the
6519 request if it has already been completed.
6520
6521 For example, consider a situation where you make an initial request and
6522 the request times out. If you make the request again with the same
6523 request ID, the server can check if original operation with the same
6524 request ID was received, and if so, will ignore the second request. This
6525 prevents clients from accidentally creating duplicate commitments.
6526
6527 The request ID must be
6528 a valid UUID with the exception that zero UUID is not supported
6529 (00000000-0000-0000-0000-000000000000).
6530 x__xgafv: string, V1 error format.
6531 Allowed values
6532 1 - v1 error format
6533 2 - v2 error format
6534
6535 Returns:
6536 An object of the form:
6537
6538 { # Represents an Operation resource.
6539 #
6540 # Google Compute Engine has three Operation resources:
6541 #
6542 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6543 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6544 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6545 #
6546 # You can use an operation resource to manage asynchronous API requests.
6547 # For more information, readHandling
6548 # API responses.
6549 #
6550 # Operations can be global, regional or zonal.
6551 #
6552 # - For global operations, use the `globalOperations`
6553 # resource.
6554 # - For regional operations, use the
6555 # `regionOperations` resource.
6556 # - For zonal operations, use
6557 # the `zoneOperations` resource.
6558 #
6559 #
6560 #
6561 # For more information, read
6562 # Global, Regional, and Zonal Resources.
6563 #
6564 # Note that completed Operation resources have a limited
6565 # retention period.
6566 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6567 # Not present otherwise.
6568 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6569 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6570 # set when the operation is created.
6571 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6572 # text format.
6573 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6574 # this field will be populated.
6575 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6576 # operation.
6577 {
6578 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6579 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6580 # details. There is a set of defined message types to use for providing
6581 # details.The syntax depends on the error code. For example,
6582 # QuotaExceededInfo will have details when the error code is
6583 # QUOTA_EXCEEDED.
6584 {
6585 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6586 #
6587 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6588 # is not enabled:
6589 #
6590 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6591 # &quot;domain&quot;: &quot;googleapis.com&quot;
6592 # &quot;metadata&quot;: {
6593 # &quot;resource&quot;: &quot;projects/123&quot;,
6594 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6595 # }
6596 # }
6597 #
6598 # This response indicates that the pubsub.googleapis.com API is not enabled.
6599 #
6600 # Example of an error that is returned when attempting to create a Spanner
6601 # instance in a region that is out of stock:
6602 #
6603 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6604 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6605 # &quot;metadata&quot;: {
6606 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6607 # }
6608 # }
6609 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6610 # is typically the registered service name of the tool or product that
6611 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6612 # generated by some common infrastructure, the error domain must be a
6613 # globally unique value that identifies the infrastructure. For Google API
6614 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6615 &quot;metadatas&quot;: { # Additional structured details about this error.
6616 #
6617 # Keys must match a regular expression of `a-z+` but should
6618 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6619 # length. When identifying the current value of an exceeded limit, the units
6620 # should be contained in the key, not the value. For example, rather than
6621 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6622 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6623 # instances that can be created in a single (batch) request.
6624 &quot;a_key&quot;: &quot;A String&quot;,
6625 },
6626 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6627 # proximate cause of the error. Error reasons are unique within a particular
6628 # domain of errors. This should be at most 63 characters and match a
6629 # regular expression of `A-Z+[A-Z0-9]`, which represents
6630 # UPPER_SNAKE_CASE.
6631 },
6632 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6633 #
6634 # For example, if a quota check failed with an error indicating the calling
6635 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6636 # directly to the right place in the developer console to flip the bit.
6637 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6638 { # Describes a URL link.
6639 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6640 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6641 },
6642 ],
6643 },
6644 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6645 # which can be attached to an RPC error.
6646 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6647 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6648 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6649 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6650 },
6651 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6652 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6653 &quot;a_key&quot;: &quot;A String&quot;,
6654 },
6655 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6656 # type or metric.
6657 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6658 # or metric.
6659 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6660 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6661 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6662 },
6663 },
6664 ],
6665 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6666 # This property is optional.
6667 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6668 },
6669 ],
6670 },
6671 &quot;getVersionOperationMetadata&quot;: {
6672 &quot;inlineSbomInfo&quot;: {
6673 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6674 # appropriate identifiers.
6675 &quot;a_key&quot;: &quot;A String&quot;,
6676 },
6677 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6678 # identifiers.
6679 &quot;a_key&quot;: &quot;A String&quot;,
6680 },
6681 },
6682 },
6683 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6684 # message that was returned, such as `NOT FOUND`.
6685 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6686 # status code that was returned. For example, a `404` means the
6687 # resource was not found.
6688 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6689 # defined by the server.
6690 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6691 # This value is inRFC3339
6692 # text format.
6693 &quot;instancesBulkInsertOperationMetadata&quot;: {
6694 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6695 # Example key: zones/us-central1-a
6696 &quot;a_key&quot;: {
6697 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6698 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6699 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6700 # error.
6701 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6702 # if the flow is rolling forward or rolling back.
6703 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6704 },
6705 },
6706 },
6707 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6708 # Operation resources.
6709 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6710 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6711 # group of operations results from a `bulkInsert` API request.
6712 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6713 # `update`, or `delete`, and so on.
6714 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6715 # There is no requirement that this be linear or support any granularity of
6716 # operations. This should not be used to guess when the operation will be
6717 # complete. This number should monotonically increase as the operation
6718 # progresses.
6719 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6720 # applicable when performing regional operations.
6721 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6722 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6723 # this field will contain information on all underlying zonal actions and
6724 # their state.
6725 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6726 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6727 # Example key: zones/us-central1-a
6728 &quot;a_key&quot;: {
6729 &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
6730 # populated.
6731 # different programming environments, including REST APIs and RPC APIs. It is
6732 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6733 # three pieces of data: error code, error message, and error details.
6734 #
6735 # You can find out more about this error model and how to work with it in the
6736 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6737 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6738 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6739 # message types for APIs to use.
6740 {
6741 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6742 },
6743 ],
6744 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6745 # user-facing error message should be localized and sent in the
6746 # google.rpc.Status.details field, or localized by the client.
6747 },
6748 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6749 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6750 },
6751 },
6752 },
6753 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6754 # This value is inRFC3339
6755 # text format.
6756 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6757 # following:
6758 # `PENDING`, `RUNNING`, or `DONE`.
6759 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6760 # operation.
6761 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6762 # of the target resource.
6763 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6764 # operations related to creating a snapshot, this points to the disk
6765 # that the snapshot was created from.
6766 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6767 # `[email protected]` or
6768 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6769 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6770 # operation, this field will be populated.
6771 {
6772 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6773 # Engine returns NO_RESULTS_ON_PAGE if there
6774 # are no results in the response.
6775 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6776 # value format. For example:
6777 #
6778 # &quot;data&quot;: [
6779 # {
6780 # &quot;key&quot;: &quot;scope&quot;,
6781 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6782 # }
6783 {
6784 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6785 # returned. For example, for warnings where there are no results in a list
6786 # request for a particular zone, this key might be scope and
6787 # the key value might be the zone name. Other examples might be a key
6788 # indicating a deprecated resource and a suggested replacement, or a
6789 # warning about invalid network settings (for example, if an instance
6790 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6791 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6792 },
6793 ],
6794 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6795 },
6796 ],
6797 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6798 # applicable when performing per-zone operations.
6799 }</pre>
6800 </div>
6801
6802 <div class="method">
6803 <code class="details" id="patchRoutePolicy">patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
6804 <pre>Patches Route Policy
6805
6806 Args:
6807 project: string, Project ID for this request. (required)
6808 region: string, Name of the region for this request. (required)
6809 router: string, Name of the Router resource where Route Policy is defined. (required)
6810 body: object, The request body.
6811 The object takes the form of:
6812
6813 {
6814 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
6815 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
6816 # essentially a hash of the Route Policy used for optimistic locking.
6817 # The fingerprint is initially generated by Compute Engine and changes
6818 # after every request to modify or update Route Policy. You must always
6819 # provide an up-to-date fingerprint hash in order to update or change
6820 # labels.
6821 #
6822 # To see the latest fingerprint, make a getRoutePolicy() request
6823 # to retrieve a Route Policy.
6824 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
6825 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
6826 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
6827 # in order of priority). Order of policies is not retained and might change
6828 # when getting policy later.
6829 {
6830 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
6831 { # Represents a textual expression in the Common Expression Language (CEL)
6832 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6833 # are documented at https://github.com/google/cel-spec.
6834 #
6835 # Example (Comparison):
6836 #
6837 # title: &quot;Summary size limit&quot;
6838 # description: &quot;Determines if a summary is less than 100 chars&quot;
6839 # expression: &quot;document.summary.size() &lt; 100&quot;
6840 #
6841 # Example (Equality):
6842 #
6843 # title: &quot;Requestor is owner&quot;
6844 # description: &quot;Determines if requestor is the document owner&quot;
6845 # expression: &quot;document.owner == request.auth.claims.email&quot;
6846 #
6847 # Example (Logic):
6848 #
6849 # title: &quot;Public documents&quot;
6850 # description: &quot;Determine whether the document should be publicly visible&quot;
6851 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6852 #
6853 # Example (Data Manipulation):
6854 #
6855 # title: &quot;Notification string&quot;
6856 # description: &quot;Create a notification string with a timestamp.&quot;
6857 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6858 #
6859 # The exact variables and functions that may be referenced within an expression
6860 # are determined by the service that evaluates it. See the service
6861 # documentation for additional information.
6862 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6863 # describes the expression, e.g. when hovered over it in a UI.
6864 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6865 # syntax.
6866 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6867 # reporting, e.g. a file name and a position in the file.
6868 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6869 # its purpose. This can be used e.g. in UIs which allow to enter the
6870 # expression.
6871 },
6872 ],
6873 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
6874 # applies. When not set, the term applies to all
6875 # routes.
6876 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6877 # are documented at https://github.com/google/cel-spec.
6878 #
6879 # Example (Comparison):
6880 #
6881 # title: &quot;Summary size limit&quot;
6882 # description: &quot;Determines if a summary is less than 100 chars&quot;
6883 # expression: &quot;document.summary.size() &lt; 100&quot;
6884 #
6885 # Example (Equality):
6886 #
6887 # title: &quot;Requestor is owner&quot;
6888 # description: &quot;Determines if requestor is the document owner&quot;
6889 # expression: &quot;document.owner == request.auth.claims.email&quot;
6890 #
6891 # Example (Logic):
6892 #
6893 # title: &quot;Public documents&quot;
6894 # description: &quot;Determine whether the document should be publicly visible&quot;
6895 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6896 #
6897 # Example (Data Manipulation):
6898 #
6899 # title: &quot;Notification string&quot;
6900 # description: &quot;Create a notification string with a timestamp.&quot;
6901 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6902 #
6903 # The exact variables and functions that may be referenced within an expression
6904 # are determined by the service that evaluates it. See the service
6905 # documentation for additional information.
6906 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6907 # describes the expression, e.g. when hovered over it in a UI.
6908 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6909 # syntax.
6910 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6911 # reporting, e.g. a file name and a position in the file.
6912 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6913 # its purpose. This can be used e.g. in UIs which allow to enter the
6914 # expression.
6915 },
6916 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
6917 # (inclusive) and 2^31 (exclusive), and unique within the list.
6918 },
6919 ],
6920 &quot;type&quot;: &quot;A String&quot;,
6921 }
6922
6923 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6924 that if you must retry your request, the server will know to ignore the
6925 request if it has already been completed.
6926
6927 For example, consider a situation where you make an initial request and
6928 the request times out. If you make the request again with the same
6929 request ID, the server can check if original operation with the same
6930 request ID was received, and if so, will ignore the second request. This
6931 prevents clients from accidentally creating duplicate commitments.
6932
6933 The request ID must be
6934 a valid UUID with the exception that zero UUID is not supported
6935 (00000000-0000-0000-0000-000000000000).
6936 x__xgafv: string, V1 error format.
6937 Allowed values
6938 1 - v1 error format
6939 2 - v2 error format
6940
6941 Returns:
6942 An object of the form:
6943
6944 { # Represents an Operation resource.
6945 #
6946 # Google Compute Engine has three Operation resources:
6947 #
6948 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6949 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6950 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6951 #
6952 # You can use an operation resource to manage asynchronous API requests.
6953 # For more information, readHandling
6954 # API responses.
6955 #
6956 # Operations can be global, regional or zonal.
6957 #
6958 # - For global operations, use the `globalOperations`
6959 # resource.
6960 # - For regional operations, use the
6961 # `regionOperations` resource.
6962 # - For zonal operations, use
6963 # the `zoneOperations` resource.
6964 #
6965 #
6966 #
6967 # For more information, read
6968 # Global, Regional, and Zonal Resources.
6969 #
6970 # Note that completed Operation resources have a limited
6971 # retention period.
6972 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6973 # Not present otherwise.
6974 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6975 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6976 # set when the operation is created.
6977 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6978 # text format.
6979 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6980 # this field will be populated.
6981 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6982 # operation.
6983 {
6984 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6985 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6986 # details. There is a set of defined message types to use for providing
6987 # details.The syntax depends on the error code. For example,
6988 # QuotaExceededInfo will have details when the error code is
6989 # QUOTA_EXCEEDED.
6990 {
6991 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6992 #
6993 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6994 # is not enabled:
6995 #
6996 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6997 # &quot;domain&quot;: &quot;googleapis.com&quot;
6998 # &quot;metadata&quot;: {
6999 # &quot;resource&quot;: &quot;projects/123&quot;,
7000 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7001 # }
7002 # }
7003 #
7004 # This response indicates that the pubsub.googleapis.com API is not enabled.
7005 #
7006 # Example of an error that is returned when attempting to create a Spanner
7007 # instance in a region that is out of stock:
7008 #
7009 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7010 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7011 # &quot;metadata&quot;: {
7012 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7013 # }
7014 # }
7015 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7016 # is typically the registered service name of the tool or product that
7017 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7018 # generated by some common infrastructure, the error domain must be a
7019 # globally unique value that identifies the infrastructure. For Google API
7020 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7021 &quot;metadatas&quot;: { # Additional structured details about this error.
7022 #
7023 # Keys must match a regular expression of `a-z+` but should
7024 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7025 # length. When identifying the current value of an exceeded limit, the units
7026 # should be contained in the key, not the value. For example, rather than
7027 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7028 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7029 # instances that can be created in a single (batch) request.
7030 &quot;a_key&quot;: &quot;A String&quot;,
7031 },
7032 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7033 # proximate cause of the error. Error reasons are unique within a particular
7034 # domain of errors. This should be at most 63 characters and match a
7035 # regular expression of `A-Z+[A-Z0-9]`, which represents
7036 # UPPER_SNAKE_CASE.
7037 },
7038 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7039 #
7040 # For example, if a quota check failed with an error indicating the calling
7041 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7042 # directly to the right place in the developer console to flip the bit.
7043 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7044 { # Describes a URL link.
7045 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7046 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7047 },
7048 ],
7049 },
7050 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7051 # which can be attached to an RPC error.
7052 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7053 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7054 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7055 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7056 },
7057 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7058 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7059 &quot;a_key&quot;: &quot;A String&quot;,
7060 },
7061 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7062 # type or metric.
7063 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7064 # or metric.
7065 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7066 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7067 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7068 },
7069 },
7070 ],
7071 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7072 # This property is optional.
7073 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7074 },
7075 ],
7076 },
7077 &quot;getVersionOperationMetadata&quot;: {
7078 &quot;inlineSbomInfo&quot;: {
7079 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7080 # appropriate identifiers.
7081 &quot;a_key&quot;: &quot;A String&quot;,
7082 },
7083 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7084 # identifiers.
7085 &quot;a_key&quot;: &quot;A String&quot;,
7086 },
7087 },
7088 },
7089 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7090 # message that was returned, such as `NOT FOUND`.
7091 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7092 # status code that was returned. For example, a `404` means the
7093 # resource was not found.
7094 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7095 # defined by the server.
7096 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7097 # This value is inRFC3339
7098 # text format.
7099 &quot;instancesBulkInsertOperationMetadata&quot;: {
7100 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7101 # Example key: zones/us-central1-a
7102 &quot;a_key&quot;: {
7103 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7104 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7105 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7106 # error.
7107 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7108 # if the flow is rolling forward or rolling back.
7109 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7110 },
7111 },
7112 },
7113 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7114 # Operation resources.
7115 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7116 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7117 # group of operations results from a `bulkInsert` API request.
7118 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7119 # `update`, or `delete`, and so on.
7120 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7121 # There is no requirement that this be linear or support any granularity of
7122 # operations. This should not be used to guess when the operation will be
7123 # complete. This number should monotonically increase as the operation
7124 # progresses.
7125 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7126 # applicable when performing regional operations.
7127 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7128 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7129 # this field will contain information on all underlying zonal actions and
7130 # their state.
7131 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7132 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7133 # Example key: zones/us-central1-a
7134 &quot;a_key&quot;: {
7135 &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
7136 # populated.
7137 # different programming environments, including REST APIs and RPC APIs. It is
7138 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7139 # three pieces of data: error code, error message, and error details.
7140 #
7141 # You can find out more about this error model and how to work with it in the
7142 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7143 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7144 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7145 # message types for APIs to use.
7146 {
7147 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7148 },
7149 ],
7150 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7151 # user-facing error message should be localized and sent in the
7152 # google.rpc.Status.details field, or localized by the client.
7153 },
7154 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7155 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7156 },
7157 },
7158 },
7159 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7160 # This value is inRFC3339
7161 # text format.
7162 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7163 # following:
7164 # `PENDING`, `RUNNING`, or `DONE`.
7165 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7166 # operation.
7167 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7168 # of the target resource.
7169 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7170 # operations related to creating a snapshot, this points to the disk
7171 # that the snapshot was created from.
7172 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7173 # `[email protected]` or
7174 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7175 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7176 # operation, this field will be populated.
7177 {
7178 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7179 # Engine returns NO_RESULTS_ON_PAGE if there
7180 # are no results in the response.
7181 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7182 # value format. For example:
7183 #
7184 # &quot;data&quot;: [
7185 # {
7186 # &quot;key&quot;: &quot;scope&quot;,
7187 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7188 # }
7189 {
7190 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7191 # returned. For example, for warnings where there are no results in a list
7192 # request for a particular zone, this key might be scope and
7193 # the key value might be the zone name. Other examples might be a key
7194 # indicating a deprecated resource and a suggested replacement, or a
7195 # warning about invalid network settings (for example, if an instance
7196 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7197 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7198 },
7199 ],
7200 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7201 },
7202 ],
7203 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7204 # applicable when performing per-zone operations.
7205 }</pre>
7206 </div>
7207
7208 <div class="method">
7209 <code class="details" id="preview">preview(project, region, router, body=None, x__xgafv=None)</code>
7210 <pre>Preview fields auto-generated during router create andupdate operations.
7211 Calling this method does NOT create or update the router.
7212
7213 Args:
7214 project: string, Project ID for this request. (required)
7215 region: string, Name of the region for this request. (required)
7216 router: string, Name of the Router resource to query. (required)
7217 body: object, The request body.
7218 The object takes the form of:
7219
7220 { # Represents a Cloud Router resource.
7221 #
7222 # For more information about Cloud Router, read theCloud
7223 # Router overview.
7224 &quot;bgp&quot;: { # BGP information specific to this router.
7225 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
7226 # The options are DEFAULT or CUSTOM.
7227 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
7228 # This field can only be populated if advertise_mode is CUSTOM and
7229 # is advertised to all peers of the router.
7230 # These groups will be advertised in addition to any specified prefixes.
7231 # Leave this field blank to advertise no custom groups.
7232 &quot;A String&quot;,
7233 ],
7234 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
7235 # This field can only be populated if advertise_mode is CUSTOM and
7236 # is advertised to all peers of the router.
7237 # These IP ranges will be advertised in addition to any specified groups.
7238 # Leave this field blank to advertise no custom IP ranges.
7239 { # Description-tagged IP ranges for the router to advertise.
7240 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
7241 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
7242 },
7243 ],
7244 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
7245 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
7246 # value will be fixed for this router resource. All VPN tunnels that link
7247 # to this router will have the same local ASN.
7248 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
7249 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
7250 # least /30, even if the BGP sessions are over IPv6. It must not overlap
7251 # with any IPv4 BGP session ranges.
7252 #
7253 #
7254 # Other vendors commonly call this &quot;router ID&quot;.
7255 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
7256 # sent to the peer.
7257 #
7258 #
7259 # Hold time is three times the interval at which keepalive messages are
7260 # sent, and the hold time is the maximum number of seconds allowed to
7261 # elapse between successive keepalive messages that BGP receives from a
7262 # peer.
7263 #
7264 #
7265 # BGP will use the smaller of either the local hold time value or the
7266 # peer&#x27;s hold time value as the hold time for the BGP connection between
7267 # the two peers.
7268 #
7269 #
7270 # If set, this value must be between 20 and 60. The default is 20.
7271 },
7272 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
7273 # establish BGP peering. This information must specify the peer ASN and
7274 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
7275 {
7276 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
7277 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
7278 # which currently supports the following option:
7279 #
7280 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
7281 # excludes any routes learned for subnets that use
7282 # VPC Network Peering.
7283 #
7284 #
7285 # Note that this field can only be populated if advertise_mode is CUSTOM
7286 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
7287 # These groups are advertised in addition to any specified prefixes.
7288 # Leave this field blank to advertise no custom groups.
7289 &quot;A String&quot;,
7290 ],
7291 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
7292 # This field can only be populated if advertise_mode is CUSTOM and
7293 # overrides the list defined for the router (in the &quot;bgp&quot; message).
7294 # These IP ranges are advertised in addition to any specified groups.
7295 # Leave this field blank to advertise no custom IP ranges.
7296 { # Description-tagged IP ranges for the router to advertise.
7297 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
7298 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
7299 },
7300 ],
7301 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
7302 # than one matching route of maximum length, the routes with the lowest
7303 # priority value win.
7304 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
7305 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
7306 # received from the peer router. The actual value is negotiated between
7307 # the two routers and is equal to the greater of this value and the
7308 # transmit interval of the other router.
7309 #
7310 #
7311 # If set, this value must be between 1000 and 30000.
7312 #
7313 #
7314 # The default is 1000.
7315 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
7316 # transmitted to the peer router. The actual value is negotiated between
7317 # the two routers and is equal to the greater of this value and the
7318 # corresponding receive interval of the other router.
7319 #
7320 #
7321 # If set, this value must be between 1000 and 30000.
7322 #
7323 #
7324 # The default is 1000.
7325 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
7326 # before BFD declares that a peer is unavailable.
7327 #
7328 #
7329 # If set, the value must be a value between 5 and 16.
7330 #
7331 #
7332 # The default is 5.
7333 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
7334 #
7335 #
7336 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
7337 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
7338 # peer router to initiate the BFD session for this BGP peer. If set to
7339 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
7340 },
7341 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
7342 # session.
7343 {
7344 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
7345 # CIDR-formatted prefix. If an IP address is provided without a subnet
7346 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
7347 # range, and, for IPv6, `/128`.
7348 },
7349 ],
7350 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
7351 # value is applied to all custom learned route ranges for the session.
7352 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
7353 # value, Google Cloud assigns a priority of `100` to the ranges.
7354 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
7355 #
7356 #
7357 # If set to FALSE, any active session with the peer is terminated and
7358 # all associated routing information is removed. If set to TRUE, the
7359 # peer connection can be established with routing information. The default
7360 # is TRUE.
7361 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
7362 # the peerIpAddress is version 4.
7363 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
7364 # peerIpAddress is version 6.
7365 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
7366 # evaluated. The name must correspond to an existing policy that has
7367 # ROUTE_POLICY_TYPE_EXPORT type.
7368 &quot;A String&quot;,
7369 ],
7370 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
7371 # evaluated. The name must correspond to an existing policy that has
7372 # ROUTE_POLICY_TYPE_IMPORT type.
7373 &quot;A String&quot;,
7374 ],
7375 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
7376 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
7377 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
7378 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
7379 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
7380 #
7381 # - MANAGED_BY_USER is the default value and can be managed by you
7382 # or other users
7383 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
7384 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
7385 # PARTNER. Google automatically creates, updates, and deletes this type of
7386 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
7387 # or deleted.
7388 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
7389 # name of one of the entries in the Router.md5_authentication_keys. The
7390 # field must comply with RFC1035.
7391 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
7392 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
7393 # characters long and match the regular expression
7394 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7395 # lowercase letter, and all following characters must be a dash, lowercase
7396 # letter, or digit, except the last character, which cannot be a dash.
7397 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
7398 # a different value.
7399 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
7400 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
7401 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
7402 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
7403 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
7404 # Appliances. The VM instance must be located in zones contained in the
7405 # same region as this Cloud Router.
7406 # The VM instance is the peer side of the BGP session.
7407 },
7408 ],
7409 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7410 # text format.
7411 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7412 # create the resource.
7413 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
7414 # attachments (interconnectAttachments).
7415 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
7416 # defined by the server.
7417 &quot;interfaces&quot;: [ # Router interfaces.
7418 # To create a BGP peer that uses a router interface,
7419 # the interface must have one of the following fields specified:
7420 #
7421 # - linkedVpnTunnel
7422 # - linkedInterconnectAttachment
7423 # - subnetwork
7424 #
7425 #
7426 # You can create a router interface without any of these fields specified.
7427 # However, you cannot create a BGP peer that uses that interface.
7428 {
7429 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
7430 #
7431 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
7432 # be a CIDR-formatted string, for example, 169.254.0.1/30.
7433 # Note: Do not truncate the IP address, as it represents the IP address of
7434 # the interface.
7435 # - For Internet Protocol version 6 (IPv6), the value
7436 # must be a unique local address (ULA) range from fdff:1::/64
7437 # with a mask length of 126 or less. This value should be a CIDR-formatted
7438 # string, for example, fdff:1::1/112. Within the router&#x27;s
7439 # VPC, this IPv6 prefix will be reserved exclusively for this connection
7440 # and cannot be used for any other purpose.
7441 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
7442 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
7443 # as the router. Each interface can have one linked resource, which can be
7444 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
7445 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
7446 # router. Each interface can have one linked resource, which can be
7447 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
7448 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
7449 #
7450 # - MANAGED_BY_USER is the default value and can be managed directly
7451 # by users.
7452 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
7453 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
7454 # of type PARTNER. Google automatically creates, updates, and deletes
7455 # this type of interface when the PARTNER InterconnectAttachment is
7456 # created, updated, or deleted.
7457 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
7458 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
7459 # characters long and match the regular expression
7460 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7461 # lowercase letter, and all following characters must be a dash, lowercase
7462 # letter, or digit, except the last character, which cannot be a dash.
7463 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
7464 # BGP sessions to a VM instance acting as a third-party
7465 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
7466 # an SD-WAN VM.
7467 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
7468 # you are creating. The redundantInterface must belong to the same Cloud
7469 # Router as the interface here. To establish the BGP session to a Router
7470 # Appliance VM, you must create two BGP peers. The two BGP peers must be
7471 # attached to two separate interfaces that are redundant with each other.
7472 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
7473 # be 1-63 characters long and match the regular expression
7474 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7475 # lowercase letter, and all following characters must be a dash, lowercase
7476 # letter, or digit, except the last character, which cannot be a dash.
7477 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
7478 # must be in the same region as the Cloud Router.
7479 # When you establish a BGP session to a VM instance using this interface,
7480 # the VM instance must belong to the same subnetwork as the subnetwork
7481 # specified here.
7482 },
7483 ],
7484 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
7485 # routers.
7486 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
7487 {
7488 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
7489 #
7490 # For patch and update calls, it can be skipped to
7491 # copy the value from the previous configuration. This is allowed if the
7492 # key with the same name existed before the operation. Maximum length is 80
7493 # characters. Can only contain printable ASCII characters.
7494 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
7495 #
7496 # Must be unique within a router. Must be referenced by exactly
7497 # one bgpPeer. Must comply withRFC1035.
7498 },
7499 ],
7500 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
7501 # The name must be 1-63 characters long, and comply withRFC1035.
7502 # Specifically, the name must be 1-63 characters long and match the regular
7503 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7504 # character must be a lowercase letter, and all following characters must
7505 # be a dash, lowercase letter, or digit, except the last character, which
7506 # cannot be a dash.
7507 &quot;nats&quot;: [ # A list of NAT services created in this router.
7508 { # Represents a Nat resource. It enables the VMs within the specified
7509 # subnetworks to access Internet without external IP addresses. It specifies
7510 # a list of subnetworks (and the ranges within) that want to use NAT.
7511 # Customers can also provide the external IPs that would be used for NAT. GCP
7512 # would auto-allocate ephemeral IPs if no external IPs are provided.
7513 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
7514 # Must be one of: PREMIUM, STANDARD.
7515 # If not specified, then the current
7516 # project-level default tier is used.
7517 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
7518 # must be valid static external IPs that have been assigned to the NAT.
7519 # These IPs should be used for updating/patching a NAT only.
7520 &quot;A String&quot;,
7521 ],
7522 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
7523 # state. This value is equal to tcp_time_wait_timeout_sec.
7524 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
7525 # 120s. The field is output only.
7526 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
7527 #
7528 #
7529 # If not specified, it is disabled by default.
7530 #
7531 #
7532 # If set to true,
7533 #
7534 # - Dynamic Port Allocation will be enabled on this NAT
7535 # config.
7536 # - enableEndpointIndependentMapping cannot be set to true.
7537 # - If minPorts is set, minPortsPerVm must be set to a
7538 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
7539 # minimum of 32 ports will be allocated to a VM from this NAT
7540 # config.
7541 &quot;enableEndpointIndependentMapping&quot;: True or False,
7542 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
7543 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
7544 &quot;A String&quot;,
7545 ],
7546 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
7547 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
7548 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
7549 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
7550 # logs are exported for all connections handled by this NAT.
7551 # This option can take one of the following values:
7552 #
7553 # - ERRORS_ONLY: Export logs only for connection failures.
7554 # - TRANSLATIONS_ONLY: Export logs only for successful
7555 # connections.
7556 # - ALL: Export logs for all connections, successful and
7557 # unsuccessful.
7558 },
7559 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
7560 # Dynamic Port Allocation is enabled.
7561 #
7562 #
7563 # If Dynamic Port Allocation is not enabled, this field has no effect.
7564 #
7565 #
7566 # If Dynamic Port Allocation is enabled, and this field is set, it must be
7567 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
7568 # is not set.
7569 #
7570 #
7571 # If Dynamic Port Allocation is enabled and this field is not set,
7572 # a maximum of 65536 ports will be allocated to a VM from this NAT
7573 # config.
7574 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
7575 # set, a default number of ports is allocated to a VM. This is rounded
7576 # up to the nearest power of 2. For example, if the value of this field is
7577 # 50, at least 64 ports are allocated to a VM.
7578 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
7579 # The name must be 1-63 characters long and comply withRFC1035.
7580 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
7581 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
7582 # selected for the SubnetworkIpRangeToNat64Option above.
7583 { # Specifies a subnetwork to enable NAT64.
7584 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
7585 },
7586 ],
7587 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
7588 # values:
7589 #
7590 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
7591 # customers. When there are not enough specified Nat IPs, the Nat service
7592 # fails for new VMs.
7593 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
7594 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
7595 # be empty.
7596 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
7597 # addresses must be valid static external IP addresses assigned to the
7598 # project.
7599 &quot;A String&quot;,
7600 ],
7601 &quot;rules&quot;: [ # A list of rules associated with this NAT.
7602 {
7603 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
7604 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
7605 # addresses must be valid static external IP addresses assigned to the
7606 # project.
7607 # This field is used for public NAT.
7608 &quot;A String&quot;,
7609 ],
7610 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
7611 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
7612 # This field is used for private NAT.
7613 &quot;A String&quot;,
7614 ],
7615 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
7616 # must be valid static external IPs that have been assigned to the NAT.
7617 # These IPs should be used for updating/patching a NAT rule only.
7618 # This field is used for public NAT.
7619 &quot;A String&quot;,
7620 ],
7621 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
7622 # drained. This is only supported on patch/update, and these
7623 # subnetworks must have previously been used as active ranges in this
7624 # NAT Rule.
7625 # This field is used for private NAT.
7626 &quot;A String&quot;,
7627 ],
7628 },
7629 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
7630 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
7631 # from a VM is evaluated against. If it evaluates to true, the
7632 # corresponding `action` is enforced.
7633 #
7634 # The following examples are valid match expressions for public NAT:
7635 #
7636 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
7637 # &#x27;2.2.0.0/16&#x27;)`
7638 #
7639 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
7640 #
7641 # The following example is a valid match expression for private NAT:
7642 #
7643 # `nexthop.hub ==
7644 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
7645 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
7646 # must be a positive value between 0 and 65000, and
7647 # must be unique among rules within a NAT.
7648 },
7649 ],
7650 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
7651 #
7652 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
7653 # Subnetwork are allowed to Nat.
7654 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
7655 # in every Subnetwork are allowed to Nat.
7656 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
7657 # (specified in the field subnetwork below)
7658 #
7659 #
7660 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
7661 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
7662 # should not be any other Router.Nat section in any Router for this network
7663 # in this region.
7664 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
7665 # values:
7666 #
7667 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
7668 # every Subnetwork are allowed to Nat.
7669 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
7670 # (specified in the field nat64_subnetwork below)
7671 #
7672 #
7673 # The default is NAT64_OPTION_UNSPECIFIED.
7674 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
7675 # Router.Nat section in this region can also enable NAT64 for any
7676 # Subnetworks in this network. Other Router.Nat sections can still be
7677 # present to enable NAT44 only.
7678 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
7679 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
7680 # SubnetworkIpRangeToNatOption above.
7681 { # Defines the IP ranges that want to use NAT for a subnetwork.
7682 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
7683 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
7684 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
7685 # is one of the values in source_ip_ranges_to_nat.
7686 &quot;A String&quot;,
7687 ],
7688 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
7689 # options of a single value are valid except
7690 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
7691 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
7692 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
7693 # Default: [ALL_IP_RANGES]
7694 &quot;A String&quot;,
7695 ],
7696 },
7697 ],
7698 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
7699 # if not set.
7700 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
7701 # Defaults to 120s if not set.
7702 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
7703 # not set.
7704 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
7705 # translation. If unspecified, it defaults to PUBLIC.
7706 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
7707 },
7708 ],
7709 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
7710 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
7711 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
7712 # as part of resource payload.
7713 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
7714 # The field is allowed for INSERT
7715 # only. The keys/values to set on the resource should be specified in
7716 # either ID { : } or Namespaced format
7717 # { : }.
7718 # For example the following are valid inputs:
7719 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
7720 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
7721 # Note:
7722 # * Invalid combinations of ID &amp; namespaced format is not supported. For
7723 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
7724 # * Inconsistent format is not supported. For instance:
7725 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
7726 &quot;a_key&quot;: &quot;A String&quot;,
7727 },
7728 },
7729 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
7730 # You must specify this field as part of the HTTP request URL. It is
7731 # not settable as a field in the request body.
7732 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7733 }
7734
7735 x__xgafv: string, V1 error format.
7736 Allowed values
7737 1 - v1 error format
7738 2 - v2 error format
7739
7740 Returns:
7741 An object of the form:
7742
7743 {
7744 &quot;resource&quot;: { # Represents a Cloud Router resource. # Preview of given router.
7745 #
7746 # For more information about Cloud Router, read theCloud
7747 # Router overview.
7748 &quot;bgp&quot;: { # BGP information specific to this router.
7749 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
7750 # The options are DEFAULT or CUSTOM.
7751 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
7752 # This field can only be populated if advertise_mode is CUSTOM and
7753 # is advertised to all peers of the router.
7754 # These groups will be advertised in addition to any specified prefixes.
7755 # Leave this field blank to advertise no custom groups.
7756 &quot;A String&quot;,
7757 ],
7758 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
7759 # This field can only be populated if advertise_mode is CUSTOM and
7760 # is advertised to all peers of the router.
7761 # These IP ranges will be advertised in addition to any specified groups.
7762 # Leave this field blank to advertise no custom IP ranges.
7763 { # Description-tagged IP ranges for the router to advertise.
7764 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
7765 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
7766 },
7767 ],
7768 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
7769 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
7770 # value will be fixed for this router resource. All VPN tunnels that link
7771 # to this router will have the same local ASN.
7772 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
7773 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
7774 # least /30, even if the BGP sessions are over IPv6. It must not overlap
7775 # with any IPv4 BGP session ranges.
7776 #
7777 #
7778 # Other vendors commonly call this &quot;router ID&quot;.
7779 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
7780 # sent to the peer.
7781 #
7782 #
7783 # Hold time is three times the interval at which keepalive messages are
7784 # sent, and the hold time is the maximum number of seconds allowed to
7785 # elapse between successive keepalive messages that BGP receives from a
7786 # peer.
7787 #
7788 #
7789 # BGP will use the smaller of either the local hold time value or the
7790 # peer&#x27;s hold time value as the hold time for the BGP connection between
7791 # the two peers.
7792 #
7793 #
7794 # If set, this value must be between 20 and 60. The default is 20.
7795 },
7796 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
7797 # establish BGP peering. This information must specify the peer ASN and
7798 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
7799 {
7800 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
7801 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
7802 # which currently supports the following option:
7803 #
7804 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
7805 # excludes any routes learned for subnets that use
7806 # VPC Network Peering.
7807 #
7808 #
7809 # Note that this field can only be populated if advertise_mode is CUSTOM
7810 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
7811 # These groups are advertised in addition to any specified prefixes.
7812 # Leave this field blank to advertise no custom groups.
7813 &quot;A String&quot;,
7814 ],
7815 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
7816 # This field can only be populated if advertise_mode is CUSTOM and
7817 # overrides the list defined for the router (in the &quot;bgp&quot; message).
7818 # These IP ranges are advertised in addition to any specified groups.
7819 # Leave this field blank to advertise no custom IP ranges.
7820 { # Description-tagged IP ranges for the router to advertise.
7821 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
7822 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
7823 },
7824 ],
7825 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
7826 # than one matching route of maximum length, the routes with the lowest
7827 # priority value win.
7828 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
7829 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
7830 # received from the peer router. The actual value is negotiated between
7831 # the two routers and is equal to the greater of this value and the
7832 # transmit interval of the other router.
7833 #
7834 #
7835 # If set, this value must be between 1000 and 30000.
7836 #
7837 #
7838 # The default is 1000.
7839 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
7840 # transmitted to the peer router. The actual value is negotiated between
7841 # the two routers and is equal to the greater of this value and the
7842 # corresponding receive interval of the other router.
7843 #
7844 #
7845 # If set, this value must be between 1000 and 30000.
7846 #
7847 #
7848 # The default is 1000.
7849 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
7850 # before BFD declares that a peer is unavailable.
7851 #
7852 #
7853 # If set, the value must be a value between 5 and 16.
7854 #
7855 #
7856 # The default is 5.
7857 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
7858 #
7859 #
7860 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
7861 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
7862 # peer router to initiate the BFD session for this BGP peer. If set to
7863 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
7864 },
7865 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
7866 # session.
7867 {
7868 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
7869 # CIDR-formatted prefix. If an IP address is provided without a subnet
7870 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
7871 # range, and, for IPv6, `/128`.
7872 },
7873 ],
7874 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
7875 # value is applied to all custom learned route ranges for the session.
7876 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
7877 # value, Google Cloud assigns a priority of `100` to the ranges.
7878 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
7879 #
7880 #
7881 # If set to FALSE, any active session with the peer is terminated and
7882 # all associated routing information is removed. If set to TRUE, the
7883 # peer connection can be established with routing information. The default
7884 # is TRUE.
7885 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
7886 # the peerIpAddress is version 4.
7887 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
7888 # peerIpAddress is version 6.
7889 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
7890 # evaluated. The name must correspond to an existing policy that has
7891 # ROUTE_POLICY_TYPE_EXPORT type.
7892 &quot;A String&quot;,
7893 ],
7894 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
7895 # evaluated. The name must correspond to an existing policy that has
7896 # ROUTE_POLICY_TYPE_IMPORT type.
7897 &quot;A String&quot;,
7898 ],
7899 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
7900 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
7901 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
7902 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
7903 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
7904 #
7905 # - MANAGED_BY_USER is the default value and can be managed by you
7906 # or other users
7907 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
7908 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
7909 # PARTNER. Google automatically creates, updates, and deletes this type of
7910 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
7911 # or deleted.
7912 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
7913 # name of one of the entries in the Router.md5_authentication_keys. The
7914 # field must comply with RFC1035.
7915 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
7916 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
7917 # characters long and match the regular expression
7918 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7919 # lowercase letter, and all following characters must be a dash, lowercase
7920 # letter, or digit, except the last character, which cannot be a dash.
7921 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
7922 # a different value.
7923 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
7924 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
7925 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
7926 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
7927 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
7928 # Appliances. The VM instance must be located in zones contained in the
7929 # same region as this Cloud Router.
7930 # The VM instance is the peer side of the BGP session.
7931 },
7932 ],
7933 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7934 # text format.
7935 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7936 # create the resource.
7937 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
7938 # attachments (interconnectAttachments).
7939 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
7940 # defined by the server.
7941 &quot;interfaces&quot;: [ # Router interfaces.
7942 # To create a BGP peer that uses a router interface,
7943 # the interface must have one of the following fields specified:
7944 #
7945 # - linkedVpnTunnel
7946 # - linkedInterconnectAttachment
7947 # - subnetwork
7948 #
7949 #
7950 # You can create a router interface without any of these fields specified.
7951 # However, you cannot create a BGP peer that uses that interface.
7952 {
7953 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
7954 #
7955 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
7956 # be a CIDR-formatted string, for example, 169.254.0.1/30.
7957 # Note: Do not truncate the IP address, as it represents the IP address of
7958 # the interface.
7959 # - For Internet Protocol version 6 (IPv6), the value
7960 # must be a unique local address (ULA) range from fdff:1::/64
7961 # with a mask length of 126 or less. This value should be a CIDR-formatted
7962 # string, for example, fdff:1::1/112. Within the router&#x27;s
7963 # VPC, this IPv6 prefix will be reserved exclusively for this connection
7964 # and cannot be used for any other purpose.
7965 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
7966 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
7967 # as the router. Each interface can have one linked resource, which can be
7968 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
7969 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
7970 # router. Each interface can have one linked resource, which can be
7971 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
7972 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
7973 #
7974 # - MANAGED_BY_USER is the default value and can be managed directly
7975 # by users.
7976 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
7977 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
7978 # of type PARTNER. Google automatically creates, updates, and deletes
7979 # this type of interface when the PARTNER InterconnectAttachment is
7980 # created, updated, or deleted.
7981 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
7982 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
7983 # characters long and match the regular expression
7984 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7985 # lowercase letter, and all following characters must be a dash, lowercase
7986 # letter, or digit, except the last character, which cannot be a dash.
7987 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
7988 # BGP sessions to a VM instance acting as a third-party
7989 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
7990 # an SD-WAN VM.
7991 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
7992 # you are creating. The redundantInterface must belong to the same Cloud
7993 # Router as the interface here. To establish the BGP session to a Router
7994 # Appliance VM, you must create two BGP peers. The two BGP peers must be
7995 # attached to two separate interfaces that are redundant with each other.
7996 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
7997 # be 1-63 characters long and match the regular expression
7998 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
7999 # lowercase letter, and all following characters must be a dash, lowercase
8000 # letter, or digit, except the last character, which cannot be a dash.
8001 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
8002 # must be in the same region as the Cloud Router.
8003 # When you establish a BGP session to a VM instance using this interface,
8004 # the VM instance must belong to the same subnetwork as the subnetwork
8005 # specified here.
8006 },
8007 ],
8008 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
8009 # routers.
8010 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
8011 {
8012 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
8013 #
8014 # For patch and update calls, it can be skipped to
8015 # copy the value from the previous configuration. This is allowed if the
8016 # key with the same name existed before the operation. Maximum length is 80
8017 # characters. Can only contain printable ASCII characters.
8018 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
8019 #
8020 # Must be unique within a router. Must be referenced by exactly
8021 # one bgpPeer. Must comply withRFC1035.
8022 },
8023 ],
8024 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
8025 # The name must be 1-63 characters long, and comply withRFC1035.
8026 # Specifically, the name must be 1-63 characters long and match the regular
8027 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
8028 # character must be a lowercase letter, and all following characters must
8029 # be a dash, lowercase letter, or digit, except the last character, which
8030 # cannot be a dash.
8031 &quot;nats&quot;: [ # A list of NAT services created in this router.
8032 { # Represents a Nat resource. It enables the VMs within the specified
8033 # subnetworks to access Internet without external IP addresses. It specifies
8034 # a list of subnetworks (and the ranges within) that want to use NAT.
8035 # Customers can also provide the external IPs that would be used for NAT. GCP
8036 # would auto-allocate ephemeral IPs if no external IPs are provided.
8037 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
8038 # Must be one of: PREMIUM, STANDARD.
8039 # If not specified, then the current
8040 # project-level default tier is used.
8041 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
8042 # must be valid static external IPs that have been assigned to the NAT.
8043 # These IPs should be used for updating/patching a NAT only.
8044 &quot;A String&quot;,
8045 ],
8046 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
8047 # state. This value is equal to tcp_time_wait_timeout_sec.
8048 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
8049 # 120s. The field is output only.
8050 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
8051 #
8052 #
8053 # If not specified, it is disabled by default.
8054 #
8055 #
8056 # If set to true,
8057 #
8058 # - Dynamic Port Allocation will be enabled on this NAT
8059 # config.
8060 # - enableEndpointIndependentMapping cannot be set to true.
8061 # - If minPorts is set, minPortsPerVm must be set to a
8062 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
8063 # minimum of 32 ports will be allocated to a VM from this NAT
8064 # config.
8065 &quot;enableEndpointIndependentMapping&quot;: True or False,
8066 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
8067 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
8068 &quot;A String&quot;,
8069 ],
8070 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
8071 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
8072 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
8073 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
8074 # logs are exported for all connections handled by this NAT.
8075 # This option can take one of the following values:
8076 #
8077 # - ERRORS_ONLY: Export logs only for connection failures.
8078 # - TRANSLATIONS_ONLY: Export logs only for successful
8079 # connections.
8080 # - ALL: Export logs for all connections, successful and
8081 # unsuccessful.
8082 },
8083 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
8084 # Dynamic Port Allocation is enabled.
8085 #
8086 #
8087 # If Dynamic Port Allocation is not enabled, this field has no effect.
8088 #
8089 #
8090 # If Dynamic Port Allocation is enabled, and this field is set, it must be
8091 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
8092 # is not set.
8093 #
8094 #
8095 # If Dynamic Port Allocation is enabled and this field is not set,
8096 # a maximum of 65536 ports will be allocated to a VM from this NAT
8097 # config.
8098 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
8099 # set, a default number of ports is allocated to a VM. This is rounded
8100 # up to the nearest power of 2. For example, if the value of this field is
8101 # 50, at least 64 ports are allocated to a VM.
8102 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
8103 # The name must be 1-63 characters long and comply withRFC1035.
8104 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
8105 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
8106 # selected for the SubnetworkIpRangeToNat64Option above.
8107 { # Specifies a subnetwork to enable NAT64.
8108 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
8109 },
8110 ],
8111 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
8112 # values:
8113 #
8114 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
8115 # customers. When there are not enough specified Nat IPs, the Nat service
8116 # fails for new VMs.
8117 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
8118 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
8119 # be empty.
8120 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
8121 # addresses must be valid static external IP addresses assigned to the
8122 # project.
8123 &quot;A String&quot;,
8124 ],
8125 &quot;rules&quot;: [ # A list of rules associated with this NAT.
8126 {
8127 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
8128 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
8129 # addresses must be valid static external IP addresses assigned to the
8130 # project.
8131 # This field is used for public NAT.
8132 &quot;A String&quot;,
8133 ],
8134 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
8135 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
8136 # This field is used for private NAT.
8137 &quot;A String&quot;,
8138 ],
8139 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
8140 # must be valid static external IPs that have been assigned to the NAT.
8141 # These IPs should be used for updating/patching a NAT rule only.
8142 # This field is used for public NAT.
8143 &quot;A String&quot;,
8144 ],
8145 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
8146 # drained. This is only supported on patch/update, and these
8147 # subnetworks must have previously been used as active ranges in this
8148 # NAT Rule.
8149 # This field is used for private NAT.
8150 &quot;A String&quot;,
8151 ],
8152 },
8153 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
8154 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
8155 # from a VM is evaluated against. If it evaluates to true, the
8156 # corresponding `action` is enforced.
8157 #
8158 # The following examples are valid match expressions for public NAT:
8159 #
8160 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
8161 # &#x27;2.2.0.0/16&#x27;)`
8162 #
8163 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
8164 #
8165 # The following example is a valid match expression for private NAT:
8166 #
8167 # `nexthop.hub ==
8168 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
8169 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
8170 # must be a positive value between 0 and 65000, and
8171 # must be unique among rules within a NAT.
8172 },
8173 ],
8174 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
8175 #
8176 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
8177 # Subnetwork are allowed to Nat.
8178 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
8179 # in every Subnetwork are allowed to Nat.
8180 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
8181 # (specified in the field subnetwork below)
8182 #
8183 #
8184 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
8185 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
8186 # should not be any other Router.Nat section in any Router for this network
8187 # in this region.
8188 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
8189 # values:
8190 #
8191 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
8192 # every Subnetwork are allowed to Nat.
8193 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
8194 # (specified in the field nat64_subnetwork below)
8195 #
8196 #
8197 # The default is NAT64_OPTION_UNSPECIFIED.
8198 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
8199 # Router.Nat section in this region can also enable NAT64 for any
8200 # Subnetworks in this network. Other Router.Nat sections can still be
8201 # present to enable NAT44 only.
8202 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
8203 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
8204 # SubnetworkIpRangeToNatOption above.
8205 { # Defines the IP ranges that want to use NAT for a subnetwork.
8206 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
8207 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
8208 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
8209 # is one of the values in source_ip_ranges_to_nat.
8210 &quot;A String&quot;,
8211 ],
8212 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
8213 # options of a single value are valid except
8214 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
8215 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
8216 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
8217 # Default: [ALL_IP_RANGES]
8218 &quot;A String&quot;,
8219 ],
8220 },
8221 ],
8222 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
8223 # if not set.
8224 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
8225 # Defaults to 120s if not set.
8226 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
8227 # not set.
8228 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
8229 # translation. If unspecified, it defaults to PUBLIC.
8230 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
8231 },
8232 ],
8233 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
8234 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
8235 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
8236 # as part of resource payload.
8237 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
8238 # The field is allowed for INSERT
8239 # only. The keys/values to set on the resource should be specified in
8240 # either ID { : } or Namespaced format
8241 # { : }.
8242 # For example the following are valid inputs:
8243 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
8244 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
8245 # Note:
8246 # * Invalid combinations of ID &amp; namespaced format is not supported. For
8247 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
8248 # * Inconsistent format is not supported. For instance:
8249 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
8250 &quot;a_key&quot;: &quot;A String&quot;,
8251 },
8252 },
8253 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
8254 # You must specify this field as part of the HTTP request URL. It is
8255 # not settable as a field in the request body.
8256 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8257 },
8258 }</pre>
8259 </div>
8260
8261 <div class="method">
8262 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
8263 <pre>Returns permissions that a caller has on the specified resource.
8264
8265 Args:
8266 project: string, Project ID for this request. (required)
8267 region: string, The name of the region for this request. (required)
8268 resource: string, Name or id of the resource for this request. (required)
8269 body: object, The request body.
8270 The object takes the form of:
8271
8272 {
8273 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
8274 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
8275 &quot;A String&quot;,
8276 ],
8277 }
8278
8279 x__xgafv: string, V1 error format.
8280 Allowed values
8281 1 - v1 error format
8282 2 - v2 error format
8283
8284 Returns:
8285 An object of the form:
8286
8287 {
8288 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
8289 # allowed.
8290 &quot;A String&quot;,
8291 ],
8292 }</pre>
8293 </div>
8294
8295 <div class="method">
8296 <code class="details" id="update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
8297 <pre>Updates the specified Router resource with the data included in the
8298 request. This method conforms toPUT semantics, which requests that the state of the
8299 target resource be created or replaced with the state defined by the
8300 representation enclosed in the request message payload.
8301
8302 Args:
8303 project: string, Project ID for this request. (required)
8304 region: string, Name of the region for this request. (required)
8305 router: string, Name of the Router resource to update. (required)
8306 body: object, The request body.
8307 The object takes the form of:
8308
8309 { # Represents a Cloud Router resource.
8310 #
8311 # For more information about Cloud Router, read theCloud
8312 # Router overview.
8313 &quot;bgp&quot;: { # BGP information specific to this router.
8314 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
8315 # The options are DEFAULT or CUSTOM.
8316 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode.
8317 # This field can only be populated if advertise_mode is CUSTOM and
8318 # is advertised to all peers of the router.
8319 # These groups will be advertised in addition to any specified prefixes.
8320 # Leave this field blank to advertise no custom groups.
8321 &quot;A String&quot;,
8322 ],
8323 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
8324 # This field can only be populated if advertise_mode is CUSTOM and
8325 # is advertised to all peers of the router.
8326 # These IP ranges will be advertised in addition to any specified groups.
8327 # Leave this field blank to advertise no custom IP ranges.
8328 { # Description-tagged IP ranges for the router to advertise.
8329 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
8330 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
8331 },
8332 ],
8333 &quot;asn&quot;: 42, # Local BGP Autonomous System Number (ASN).
8334 # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
8335 # value will be fixed for this router resource. All VPN tunnels that link
8336 # to this router will have the same local ASN.
8337 &quot;identifierRange&quot;: &quot;A String&quot;, # Explicitly specifies a range of valid BGP Identifiers for this Router. It
8338 # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
8339 # least /30, even if the BGP sessions are over IPv6. It must not overlap
8340 # with any IPv4 BGP session ranges.
8341 #
8342 #
8343 # Other vendors commonly call this &quot;router ID&quot;.
8344 &quot;keepaliveInterval&quot;: 42, # The interval in seconds between BGP keepalive messages that are
8345 # sent to the peer.
8346 #
8347 #
8348 # Hold time is three times the interval at which keepalive messages are
8349 # sent, and the hold time is the maximum number of seconds allowed to
8350 # elapse between successive keepalive messages that BGP receives from a
8351 # peer.
8352 #
8353 #
8354 # BGP will use the smaller of either the local hold time value or the
8355 # peer&#x27;s hold time value as the hold time for the BGP connection between
8356 # the two peers.
8357 #
8358 #
8359 # If set, this value must be between 20 and 60. The default is 20.
8360 },
8361 &quot;bgpPeers&quot;: [ # BGP information that must be configured into the routing stack to
8362 # establish BGP peering. This information must specify the peer ASN and
8363 # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
8364 {
8365 &quot;advertiseMode&quot;: &quot;A String&quot;, # User-specified flag to indicate which mode to use for advertisement.
8366 &quot;advertisedGroups&quot;: [ # User-specified list of prefix groups to advertise in custom mode,
8367 # which currently supports the following option:
8368 #
8369 # - ALL_SUBNETS: Advertises all of the router&#x27;s own VPC subnets. This
8370 # excludes any routes learned for subnets that use
8371 # VPC Network Peering.
8372 #
8373 #
8374 # Note that this field can only be populated if advertise_mode is CUSTOM
8375 # and overrides the list defined for the router (in the &quot;bgp&quot; message).
8376 # These groups are advertised in addition to any specified prefixes.
8377 # Leave this field blank to advertise no custom groups.
8378 &quot;A String&quot;,
8379 ],
8380 &quot;advertisedIpRanges&quot;: [ # User-specified list of individual IP ranges to advertise in custom mode.
8381 # This field can only be populated if advertise_mode is CUSTOM and
8382 # overrides the list defined for the router (in the &quot;bgp&quot; message).
8383 # These IP ranges are advertised in addition to any specified groups.
8384 # Leave this field blank to advertise no custom IP ranges.
8385 { # Description-tagged IP ranges for the router to advertise.
8386 &quot;description&quot;: &quot;A String&quot;, # User-specified description for the IP range.
8387 &quot;range&quot;: &quot;A String&quot;, # The IP range to advertise. The value must be a CIDR-formatted string.
8388 },
8389 ],
8390 &quot;advertisedRoutePriority&quot;: 42, # The priority of routes advertised to this BGP peer. Where there is more
8391 # than one matching route of maximum length, the routes with the lowest
8392 # priority value win.
8393 &quot;bfd&quot;: { # BFD configuration for the BGP peering.
8394 &quot;minReceiveInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
8395 # received from the peer router. The actual value is negotiated between
8396 # the two routers and is equal to the greater of this value and the
8397 # transmit interval of the other router.
8398 #
8399 #
8400 # If set, this value must be between 1000 and 30000.
8401 #
8402 #
8403 # The default is 1000.
8404 &quot;minTransmitInterval&quot;: 42, # The minimum interval, in milliseconds, between BFD control packets
8405 # transmitted to the peer router. The actual value is negotiated between
8406 # the two routers and is equal to the greater of this value and the
8407 # corresponding receive interval of the other router.
8408 #
8409 #
8410 # If set, this value must be between 1000 and 30000.
8411 #
8412 #
8413 # The default is 1000.
8414 &quot;multiplier&quot;: 42, # The number of consecutive BFD packets that must be missed
8415 # before BFD declares that a peer is unavailable.
8416 #
8417 #
8418 # If set, the value must be a value between 5 and 16.
8419 #
8420 #
8421 # The default is 5.
8422 &quot;sessionInitializationMode&quot;: &quot;A String&quot;, # The BFD session initialization mode for this BGP peer.
8423 #
8424 #
8425 # If set to ACTIVE, the Cloud Router will initiate the BFD session for
8426 # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
8427 # peer router to initiate the BFD session for this BGP peer. If set to
8428 # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
8429 },
8430 &quot;customLearnedIpRanges&quot;: [ # A list of user-defined custom learned route IP address ranges for a BGP
8431 # session.
8432 {
8433 &quot;range&quot;: &quot;A String&quot;, # The custom learned route IP address range. Must be a valid
8434 # CIDR-formatted prefix. If an IP address is provided without a subnet
8435 # mask, it is interpreted as, for IPv4, a `/32` singular IP address
8436 # range, and, for IPv6, `/128`.
8437 },
8438 ],
8439 &quot;customLearnedRoutePriority&quot;: 42, # The user-defined custom learned route priority for a BGP session. This
8440 # value is applied to all custom learned route ranges for the session.
8441 # You can choose a value from `0` to `65335`. If you don&#x27;t provide a
8442 # value, Google Cloud assigns a priority of `100` to the ranges.
8443 &quot;enable&quot;: &quot;A String&quot;, # The status of the BGP peer connection.
8444 #
8445 #
8446 # If set to FALSE, any active session with the peer is terminated and
8447 # all associated routing information is removed. If set to TRUE, the
8448 # peer connection can be established with routing information. The default
8449 # is TRUE.
8450 &quot;enableIpv4&quot;: True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
8451 # the peerIpAddress is version 4.
8452 &quot;enableIpv6&quot;: True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
8453 # peerIpAddress is version 6.
8454 &quot;exportPolicies&quot;: [ # List of export policies applied to this peer, in the order they must be
8455 # evaluated. The name must correspond to an existing policy that has
8456 # ROUTE_POLICY_TYPE_EXPORT type.
8457 &quot;A String&quot;,
8458 ],
8459 &quot;importPolicies&quot;: [ # List of import policies applied to this peer, in the order they must be
8460 # evaluated. The name must correspond to an existing policy that has
8461 # ROUTE_POLICY_TYPE_IMPORT type.
8462 &quot;A String&quot;,
8463 ],
8464 &quot;interfaceName&quot;: &quot;A String&quot;, # Name of the interface the BGP peer is associated with.
8465 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address of the interface inside Google Cloud Platform.
8466 &quot;ipv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the interface inside Google Cloud Platform.
8467 &quot;ipv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the interface inside Google Cloud Platform.
8468 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this BGP peer.
8469 #
8470 # - MANAGED_BY_USER is the default value and can be managed by you
8471 # or other users
8472 # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
8473 # by Cloud Interconnect, specifically by an InterconnectAttachment of type
8474 # PARTNER. Google automatically creates, updates, and deletes this type of
8475 # BGP peer when the PARTNER InterconnectAttachment is created, updated,
8476 # or deleted.
8477 &quot;md5AuthenticationKeyName&quot;: &quot;A String&quot;, # Present if MD5 authentication is enabled for the peering. Must be the
8478 # name of one of the entries in the Router.md5_authentication_keys. The
8479 # field must comply with RFC1035.
8480 &quot;name&quot;: &quot;A String&quot;, # Name of this BGP peer.
8481 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
8482 # characters long and match the regular expression
8483 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
8484 # lowercase letter, and all following characters must be a dash, lowercase
8485 # letter, or digit, except the last character, which cannot be a dash.
8486 &quot;peerAsn&quot;: 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
8487 # a different value.
8488 &quot;peerIpAddress&quot;: &quot;A String&quot;, # IP address of the BGP interface outside Google Cloud Platform.
8489 &quot;peerIpv4NexthopAddress&quot;: &quot;A String&quot;, # IPv4 address of the BGP interface outside Google Cloud Platform.
8490 &quot;peerIpv6NexthopAddress&quot;: &quot;A String&quot;, # IPv6 address of the BGP interface outside Google Cloud Platform.
8491 &quot;routerApplianceInstance&quot;: &quot;A String&quot;, # URI of the VM instance that is used as third-party router
8492 # appliances such as Next Gen Firewalls, Virtual Routers, or Router
8493 # Appliances. The VM instance must be located in zones contained in the
8494 # same region as this Cloud Router.
8495 # The VM instance is the peer side of the BGP session.
8496 },
8497 ],
8498 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
8499 # text format.
8500 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8501 # create the resource.
8502 &quot;encryptedInterconnectRouter&quot;: True or False, # Indicates if a router is dedicated for use with encrypted VLAN
8503 # attachments (interconnectAttachments).
8504 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
8505 # defined by the server.
8506 &quot;interfaces&quot;: [ # Router interfaces.
8507 # To create a BGP peer that uses a router interface,
8508 # the interface must have one of the following fields specified:
8509 #
8510 # - linkedVpnTunnel
8511 # - linkedInterconnectAttachment
8512 # - subnetwork
8513 #
8514 #
8515 # You can create a router interface without any of these fields specified.
8516 # However, you cannot create a BGP peer that uses that interface.
8517 {
8518 &quot;ipRange&quot;: &quot;A String&quot;, # IP address and range of the interface.
8519 #
8520 # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
8521 # be a CIDR-formatted string, for example, 169.254.0.1/30.
8522 # Note: Do not truncate the IP address, as it represents the IP address of
8523 # the interface.
8524 # - For Internet Protocol version 6 (IPv6), the value
8525 # must be a unique local address (ULA) range from fdff:1::/64
8526 # with a mask length of 126 or less. This value should be a CIDR-formatted
8527 # string, for example, fdff:1::1/112. Within the router&#x27;s
8528 # VPC, this IPv6 prefix will be reserved exclusively for this connection
8529 # and cannot be used for any other purpose.
8530 &quot;ipVersion&quot;: &quot;A String&quot;, # IP version of this interface.
8531 &quot;linkedInterconnectAttachment&quot;: &quot;A String&quot;, # URI of the linked Interconnect attachment. It must be in the same region
8532 # as the router. Each interface can have one linked resource, which can be
8533 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
8534 &quot;linkedVpnTunnel&quot;: &quot;A String&quot;, # URI of the linked VPN tunnel, which must be in the same region as the
8535 # router. Each interface can have one linked resource, which can be
8536 # a VPN tunnel, an Interconnect attachment, or a subnetwork.
8537 &quot;managementType&quot;: &quot;A String&quot;, # Output only. [Output Only] The resource that configures and manages this interface.
8538 #
8539 # - MANAGED_BY_USER is the default value and can be managed directly
8540 # by users.
8541 # - MANAGED_BY_ATTACHMENT is an interface that is configured and
8542 # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
8543 # of type PARTNER. Google automatically creates, updates, and deletes
8544 # this type of interface when the PARTNER InterconnectAttachment is
8545 # created, updated, or deleted.
8546 &quot;name&quot;: &quot;A String&quot;, # Name of this interface entry.
8547 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
8548 # characters long and match the regular expression
8549 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
8550 # lowercase letter, and all following characters must be a dash, lowercase
8551 # letter, or digit, except the last character, which cannot be a dash.
8552 &quot;privateIpAddress&quot;: &quot;A String&quot;, # The regional private internal IP address that is used to establish
8553 # BGP sessions to a VM instance acting as a third-party
8554 # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
8555 # an SD-WAN VM.
8556 &quot;redundantInterface&quot;: &quot;A String&quot;, # Name of the interface that will be redundant with the current interface
8557 # you are creating. The redundantInterface must belong to the same Cloud
8558 # Router as the interface here. To establish the BGP session to a Router
8559 # Appliance VM, you must create two BGP peers. The two BGP peers must be
8560 # attached to two separate interfaces that are redundant with each other.
8561 # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
8562 # be 1-63 characters long and match the regular expression
8563 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
8564 # lowercase letter, and all following characters must be a dash, lowercase
8565 # letter, or digit, except the last character, which cannot be a dash.
8566 &quot;subnetwork&quot;: &quot;A String&quot;, # The URI of the subnetwork resource that this interface belongs to, which
8567 # must be in the same region as the Cloud Router.
8568 # When you establish a BGP session to a VM instance using this interface,
8569 # the VM instance must belong to the same subnetwork as the subnetwork
8570 # specified here.
8571 },
8572 ],
8573 &quot;kind&quot;: &quot;compute#router&quot;, # Output only. [Output Only] Type of resource. Always compute#router for
8574 # routers.
8575 &quot;md5AuthenticationKeys&quot;: [ # Keys used for MD5 authentication.
8576 {
8577 &quot;key&quot;: &quot;A String&quot;, # [Input only] Value of the key.
8578 #
8579 # For patch and update calls, it can be skipped to
8580 # copy the value from the previous configuration. This is allowed if the
8581 # key with the same name existed before the operation. Maximum length is 80
8582 # characters. Can only contain printable ASCII characters.
8583 &quot;name&quot;: &quot;A String&quot;, # Name used to identify the key.
8584 #
8585 # Must be unique within a router. Must be referenced by exactly
8586 # one bgpPeer. Must comply withRFC1035.
8587 },
8588 ],
8589 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
8590 # The name must be 1-63 characters long, and comply withRFC1035.
8591 # Specifically, the name must be 1-63 characters long and match the regular
8592 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
8593 # character must be a lowercase letter, and all following characters must
8594 # be a dash, lowercase letter, or digit, except the last character, which
8595 # cannot be a dash.
8596 &quot;nats&quot;: [ # A list of NAT services created in this router.
8597 { # Represents a Nat resource. It enables the VMs within the specified
8598 # subnetworks to access Internet without external IP addresses. It specifies
8599 # a list of subnetworks (and the ranges within) that want to use NAT.
8600 # Customers can also provide the external IPs that would be used for NAT. GCP
8601 # would auto-allocate ephemeral IPs if no external IPs are provided.
8602 &quot;autoNetworkTier&quot;: &quot;A String&quot;, # The network tier to use when automatically reserving NAT IP addresses.
8603 # Must be one of: PREMIUM, STANDARD.
8604 # If not specified, then the current
8605 # project-level default tier is used.
8606 &quot;drainNatIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
8607 # must be valid static external IPs that have been assigned to the NAT.
8608 # These IPs should be used for updating/patching a NAT only.
8609 &quot;A String&quot;,
8610 ],
8611 &quot;effectiveTcpTimeWaitTimeoutSec&quot;: 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
8612 # state. This value is equal to tcp_time_wait_timeout_sec.
8613 # If tcp_time_wait_timeout_sec isn&#x27;t set, the effective timeout is 30s or
8614 # 120s. The field is output only.
8615 &quot;enableDynamicPortAllocation&quot;: True or False, # Enable Dynamic Port Allocation.
8616 #
8617 #
8618 # If not specified, it is disabled by default.
8619 #
8620 #
8621 # If set to true,
8622 #
8623 # - Dynamic Port Allocation will be enabled on this NAT
8624 # config.
8625 # - enableEndpointIndependentMapping cannot be set to true.
8626 # - If minPorts is set, minPortsPerVm must be set to a
8627 # power of two greater than or equal to 32. If minPortsPerVm is not set, a
8628 # minimum of 32 ports will be allocated to a VM from this NAT
8629 # config.
8630 &quot;enableEndpointIndependentMapping&quot;: True or False,
8631 &quot;endpointTypes&quot;: [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
8632 # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
8633 &quot;A String&quot;,
8634 ],
8635 &quot;icmpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
8636 &quot;logConfig&quot;: { # Configuration of logging on a NAT. # Configure logging on this NAT.
8637 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default.
8638 &quot;filter&quot;: &quot;A String&quot;, # Specify the desired filtering of logs on this NAT. If unspecified,
8639 # logs are exported for all connections handled by this NAT.
8640 # This option can take one of the following values:
8641 #
8642 # - ERRORS_ONLY: Export logs only for connection failures.
8643 # - TRANSLATIONS_ONLY: Export logs only for successful
8644 # connections.
8645 # - ALL: Export logs for all connections, successful and
8646 # unsuccessful.
8647 },
8648 &quot;maxPortsPerVm&quot;: 42, # Maximum number of ports allocated to a VM from this NAT config when
8649 # Dynamic Port Allocation is enabled.
8650 #
8651 #
8652 # If Dynamic Port Allocation is not enabled, this field has no effect.
8653 #
8654 #
8655 # If Dynamic Port Allocation is enabled, and this field is set, it must be
8656 # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
8657 # is not set.
8658 #
8659 #
8660 # If Dynamic Port Allocation is enabled and this field is not set,
8661 # a maximum of 65536 ports will be allocated to a VM from this NAT
8662 # config.
8663 &quot;minPortsPerVm&quot;: 42, # Minimum number of ports allocated to a VM from this NAT config. If not
8664 # set, a default number of ports is allocated to a VM. This is rounded
8665 # up to the nearest power of 2. For example, if the value of this field is
8666 # 50, at least 64 ports are allocated to a VM.
8667 &quot;name&quot;: &quot;A String&quot;, # Unique name of this Nat service.
8668 # The name must be 1-63 characters long and comply withRFC1035.
8669 &quot;nat64Subnetworks&quot;: [ # List of Subnetwork resources whose traffic should be translated by NAT64
8670 # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
8671 # selected for the SubnetworkIpRangeToNat64Option above.
8672 { # Specifies a subnetwork to enable NAT64.
8673 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT64.
8674 },
8675 ],
8676 &quot;natIpAllocateOption&quot;: &quot;A String&quot;, # Specify the NatIpAllocateOption, which can take one of the following
8677 # values:
8678 #
8679 # - MANUAL_ONLY: Uses only Nat IP addresses provided by
8680 # customers. When there are not enough specified Nat IPs, the Nat service
8681 # fails for new VMs.
8682 # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
8683 # can&#x27;t specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
8684 # be empty.
8685 &quot;natIps&quot;: [ # A list of URLs of the IP resources used for this Nat service. These IP
8686 # addresses must be valid static external IP addresses assigned to the
8687 # project.
8688 &quot;A String&quot;,
8689 ],
8690 &quot;rules&quot;: [ # A list of rules associated with this NAT.
8691 {
8692 &quot;action&quot;: { # The action to be enforced for traffic that matches this rule.
8693 &quot;sourceNatActiveIps&quot;: [ # A list of URLs of the IP resources used for this NAT rule. These IP
8694 # addresses must be valid static external IP addresses assigned to the
8695 # project.
8696 # This field is used for public NAT.
8697 &quot;A String&quot;,
8698 ],
8699 &quot;sourceNatActiveRanges&quot;: [ # A list of URLs of the subnetworks used as source ranges for this
8700 # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
8701 # This field is used for private NAT.
8702 &quot;A String&quot;,
8703 ],
8704 &quot;sourceNatDrainIps&quot;: [ # A list of URLs of the IP resources to be drained. These IPs
8705 # must be valid static external IPs that have been assigned to the NAT.
8706 # These IPs should be used for updating/patching a NAT rule only.
8707 # This field is used for public NAT.
8708 &quot;A String&quot;,
8709 ],
8710 &quot;sourceNatDrainRanges&quot;: [ # A list of URLs of subnetworks representing source ranges to be
8711 # drained. This is only supported on patch/update, and these
8712 # subnetworks must have previously been used as active ranges in this
8713 # NAT Rule.
8714 # This field is used for private NAT.
8715 &quot;A String&quot;,
8716 ],
8717 },
8718 &quot;description&quot;: &quot;A String&quot;, # An optional description of this rule.
8719 &quot;match&quot;: &quot;A String&quot;, # CEL expression that specifies the match condition that egress traffic
8720 # from a VM is evaluated against. If it evaluates to true, the
8721 # corresponding `action` is enforced.
8722 #
8723 # The following examples are valid match expressions for public NAT:
8724 #
8725 # `inIpRange(destination.ip, &#x27;1.1.0.0/16&#x27;) || inIpRange(destination.ip,
8726 # &#x27;2.2.0.0/16&#x27;)`
8727 #
8728 # `destination.ip == &#x27;1.1.0.1&#x27; || destination.ip == &#x27;8.8.8.8&#x27;`
8729 #
8730 # The following example is a valid match expression for private NAT:
8731 #
8732 # `nexthop.hub ==
8733 # &#x27;//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1&#x27;`
8734 &quot;ruleNumber&quot;: 42, # An integer uniquely identifying a rule in the list. The rule number
8735 # must be a positive value between 0 and 65000, and
8736 # must be unique among rules within a NAT.
8737 },
8738 ],
8739 &quot;sourceSubnetworkIpRangesToNat&quot;: &quot;A String&quot;, # Specify the Nat option, which can take one of the following values:
8740 #
8741 # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
8742 # Subnetwork are allowed to Nat.
8743 # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
8744 # in every Subnetwork are allowed to Nat.
8745 # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
8746 # (specified in the field subnetwork below)
8747 #
8748 #
8749 # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
8750 # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
8751 # should not be any other Router.Nat section in any Router for this network
8752 # in this region.
8753 &quot;sourceSubnetworkIpRangesToNat64&quot;: &quot;A String&quot;, # Specify the Nat option for NAT64, which can take one of the following
8754 # values:
8755 #
8756 # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
8757 # every Subnetwork are allowed to Nat.
8758 # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
8759 # (specified in the field nat64_subnetwork below)
8760 #
8761 #
8762 # The default is NAT64_OPTION_UNSPECIFIED.
8763 # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
8764 # Router.Nat section in this region can also enable NAT64 for any
8765 # Subnetworks in this network. Other Router.Nat sections can still be
8766 # present to enable NAT44 only.
8767 &quot;subnetworks&quot;: [ # A list of Subnetwork resources whose traffic should be translated by NAT
8768 # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
8769 # SubnetworkIpRangeToNatOption above.
8770 { # Defines the IP ranges that want to use NAT for a subnetwork.
8771 &quot;name&quot;: &quot;A String&quot;, # URL for the subnetwork resource that will use NAT.
8772 &quot;secondaryIpRangeNames&quot;: [ # A list of the secondary ranges of the Subnetwork that are allowed to
8773 # use NAT. This can be populated only if &quot;LIST_OF_SECONDARY_IP_RANGES&quot;
8774 # is one of the values in source_ip_ranges_to_nat.
8775 &quot;A String&quot;,
8776 ],
8777 &quot;sourceIpRangesToNat&quot;: [ # Specify the options for NAT ranges in the Subnetwork. All
8778 # options of a single value are valid except
8779 # NAT_IP_RANGE_OPTION_UNSPECIFIED.
8780 # The only valid option with multiple values is: [&quot;PRIMARY_IP_RANGE&quot;,
8781 # &quot;LIST_OF_SECONDARY_IP_RANGES&quot;]
8782 # Default: [ALL_IP_RANGES]
8783 &quot;A String&quot;,
8784 ],
8785 },
8786 ],
8787 &quot;tcpEstablishedIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
8788 # if not set.
8789 &quot;tcpTimeWaitTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
8790 # Defaults to 120s if not set.
8791 &quot;tcpTransitoryIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
8792 # not set.
8793 &quot;type&quot;: &quot;A String&quot;, # Indicates whether this NAT is used for public or private IP
8794 # translation. If unspecified, it defaults to PUBLIC.
8795 &quot;udpIdleTimeoutSec&quot;: 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
8796 },
8797 ],
8798 &quot;nccGateway&quot;: &quot;A String&quot;, # URI of the ncc_gateway to which this router associated.
8799 &quot;network&quot;: &quot;A String&quot;, # URI of the network to which this router belongs.
8800 &quot;params&quot;: { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
8801 # as part of resource payload.
8802 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
8803 # The field is allowed for INSERT
8804 # only. The keys/values to set on the resource should be specified in
8805 # either ID { : } or Namespaced format
8806 # { : }.
8807 # For example the following are valid inputs:
8808 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
8809 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
8810 # Note:
8811 # * Invalid combinations of ID &amp; namespaced format is not supported. For
8812 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
8813 # * Inconsistent format is not supported. For instance:
8814 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
8815 &quot;a_key&quot;: &quot;A String&quot;,
8816 },
8817 },
8818 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URI of the region where the router resides.
8819 # You must specify this field as part of the HTTP request URL. It is
8820 # not settable as a field in the request body.
8821 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8822 }
8823
8824 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8825 that if you must retry your request, the server will know to ignore the
8826 request if it has already been completed.
8827
8828 For example, consider a situation where you make an initial request and
8829 the request times out. If you make the request again with the same
8830 request ID, the server can check if original operation with the same
8831 request ID was received, and if so, will ignore the second request. This
8832 prevents clients from accidentally creating duplicate commitments.
8833
8834 The request ID must be
8835 a valid UUID with the exception that zero UUID is not supported
8836 (00000000-0000-0000-0000-000000000000).
8837 x__xgafv: string, V1 error format.
8838 Allowed values
8839 1 - v1 error format
8840 2 - v2 error format
8841
8842 Returns:
8843 An object of the form:
8844
8845 { # Represents an Operation resource.
8846 #
8847 # Google Compute Engine has three Operation resources:
8848 #
8849 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
8850 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
8851 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
8852 #
8853 # You can use an operation resource to manage asynchronous API requests.
8854 # For more information, readHandling
8855 # API responses.
8856 #
8857 # Operations can be global, regional or zonal.
8858 #
8859 # - For global operations, use the `globalOperations`
8860 # resource.
8861 # - For regional operations, use the
8862 # `regionOperations` resource.
8863 # - For zonal operations, use
8864 # the `zoneOperations` resource.
8865 #
8866 #
8867 #
8868 # For more information, read
8869 # Global, Regional, and Zonal Resources.
8870 #
8871 # Note that completed Operation resources have a limited
8872 # retention period.
8873 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8874 # Not present otherwise.
8875 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8876 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8877 # set when the operation is created.
8878 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8879 # text format.
8880 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8881 # this field will be populated.
8882 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8883 # operation.
8884 {
8885 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8886 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8887 # details. There is a set of defined message types to use for providing
8888 # details.The syntax depends on the error code. For example,
8889 # QuotaExceededInfo will have details when the error code is
8890 # QUOTA_EXCEEDED.
8891 {
8892 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8893 #
8894 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8895 # is not enabled:
8896 #
8897 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8898 # &quot;domain&quot;: &quot;googleapis.com&quot;
8899 # &quot;metadata&quot;: {
8900 # &quot;resource&quot;: &quot;projects/123&quot;,
8901 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8902 # }
8903 # }
8904 #
8905 # This response indicates that the pubsub.googleapis.com API is not enabled.
8906 #
8907 # Example of an error that is returned when attempting to create a Spanner
8908 # instance in a region that is out of stock:
8909 #
8910 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8911 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8912 # &quot;metadata&quot;: {
8913 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8914 # }
8915 # }
8916 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8917 # is typically the registered service name of the tool or product that
8918 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8919 # generated by some common infrastructure, the error domain must be a
8920 # globally unique value that identifies the infrastructure. For Google API
8921 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8922 &quot;metadatas&quot;: { # Additional structured details about this error.
8923 #
8924 # Keys must match a regular expression of `a-z+` but should
8925 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8926 # length. When identifying the current value of an exceeded limit, the units
8927 # should be contained in the key, not the value. For example, rather than
8928 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8929 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8930 # instances that can be created in a single (batch) request.
8931 &quot;a_key&quot;: &quot;A String&quot;,
8932 },
8933 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8934 # proximate cause of the error. Error reasons are unique within a particular
8935 # domain of errors. This should be at most 63 characters and match a
8936 # regular expression of `A-Z+[A-Z0-9]`, which represents
8937 # UPPER_SNAKE_CASE.
8938 },
8939 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8940 #
8941 # For example, if a quota check failed with an error indicating the calling
8942 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8943 # directly to the right place in the developer console to flip the bit.
8944 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8945 { # Describes a URL link.
8946 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8947 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8948 },
8949 ],
8950 },
8951 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8952 # which can be attached to an RPC error.
8953 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8954 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8955 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8956 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8957 },
8958 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8959 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8960 &quot;a_key&quot;: &quot;A String&quot;,
8961 },
8962 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8963 # type or metric.
8964 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8965 # or metric.
8966 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8967 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8968 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8969 },
8970 },
8971 ],
8972 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8973 # This property is optional.
8974 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8975 },
8976 ],
8977 },
8978 &quot;getVersionOperationMetadata&quot;: {
8979 &quot;inlineSbomInfo&quot;: {
8980 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8981 # appropriate identifiers.
8982 &quot;a_key&quot;: &quot;A String&quot;,
8983 },
8984 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8985 # identifiers.
8986 &quot;a_key&quot;: &quot;A String&quot;,
8987 },
8988 },
8989 },
8990 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8991 # message that was returned, such as `NOT FOUND`.
8992 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8993 # status code that was returned. For example, a `404` means the
8994 # resource was not found.
8995 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8996 # defined by the server.
8997 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8998 # This value is inRFC3339
8999 # text format.
9000 &quot;instancesBulkInsertOperationMetadata&quot;: {
9001 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9002 # Example key: zones/us-central1-a
9003 &quot;a_key&quot;: {
9004 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9005 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9006 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9007 # error.
9008 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9009 # if the flow is rolling forward or rolling back.
9010 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9011 },
9012 },
9013 },
9014 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9015 # Operation resources.
9016 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9017 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9018 # group of operations results from a `bulkInsert` API request.
9019 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9020 # `update`, or `delete`, and so on.
9021 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9022 # There is no requirement that this be linear or support any granularity of
9023 # operations. This should not be used to guess when the operation will be
9024 # complete. This number should monotonically increase as the operation
9025 # progresses.
9026 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9027 # applicable when performing regional operations.
9028 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9029 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9030 # this field will contain information on all underlying zonal actions and
9031 # their state.
9032 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9033 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9034 # Example key: zones/us-central1-a
9035 &quot;a_key&quot;: {
9036 &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
9037 # populated.
9038 # different programming environments, including REST APIs and RPC APIs. It is
9039 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9040 # three pieces of data: error code, error message, and error details.
9041 #
9042 # You can find out more about this error model and how to work with it in the
9043 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9044 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9045 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9046 # message types for APIs to use.
9047 {
9048 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9049 },
9050 ],
9051 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9052 # user-facing error message should be localized and sent in the
9053 # google.rpc.Status.details field, or localized by the client.
9054 },
9055 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9056 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9057 },
9058 },
9059 },
9060 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9061 # This value is inRFC3339
9062 # text format.
9063 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9064 # following:
9065 # `PENDING`, `RUNNING`, or `DONE`.
9066 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9067 # operation.
9068 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9069 # of the target resource.
9070 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9071 # operations related to creating a snapshot, this points to the disk
9072 # that the snapshot was created from.
9073 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9074 # `[email protected]` or
9075 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9076 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9077 # operation, this field will be populated.
9078 {
9079 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9080 # Engine returns NO_RESULTS_ON_PAGE if there
9081 # are no results in the response.
9082 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9083 # value format. For example:
9084 #
9085 # &quot;data&quot;: [
9086 # {
9087 # &quot;key&quot;: &quot;scope&quot;,
9088 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9089 # }
9090 {
9091 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9092 # returned. For example, for warnings where there are no results in a list
9093 # request for a particular zone, this key might be scope and
9094 # the key value might be the zone name. Other examples might be a key
9095 # indicating a deprecated resource and a suggested replacement, or a
9096 # warning about invalid network settings (for example, if an instance
9097 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9098 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9099 },
9100 ],
9101 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9102 },
9103 ],
9104 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9105 # applicable when performing per-zone operations.
9106 }</pre>
9107 </div>
9108
9109 <div class="method">
9110 <code class="details" id="updateNamedSet">updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
9111 <pre>Updates or creates new Named Set
9112
9113 Args:
9114 project: string, Project ID for this request. (required)
9115 region: string, Name of the region for this request. (required)
9116 router: string, Name of the Router resource where Named Set is defined. (required)
9117 body: object, The request body.
9118 The object takes the form of:
9119
9120 {
9121 &quot;description&quot;: &quot;A String&quot;, # An optional description of named set.
9122 &quot;elements&quot;: [ # CEL expressions that are comparable to constructs of this set&#x27;s type
9123 # (see Policy Language).
9124 { # Represents a textual expression in the Common Expression Language (CEL)
9125 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9126 # are documented at https://github.com/google/cel-spec.
9127 #
9128 # Example (Comparison):
9129 #
9130 # title: &quot;Summary size limit&quot;
9131 # description: &quot;Determines if a summary is less than 100 chars&quot;
9132 # expression: &quot;document.summary.size() &lt; 100&quot;
9133 #
9134 # Example (Equality):
9135 #
9136 # title: &quot;Requestor is owner&quot;
9137 # description: &quot;Determines if requestor is the document owner&quot;
9138 # expression: &quot;document.owner == request.auth.claims.email&quot;
9139 #
9140 # Example (Logic):
9141 #
9142 # title: &quot;Public documents&quot;
9143 # description: &quot;Determine whether the document should be publicly visible&quot;
9144 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9145 #
9146 # Example (Data Manipulation):
9147 #
9148 # title: &quot;Notification string&quot;
9149 # description: &quot;Create a notification string with a timestamp.&quot;
9150 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9151 #
9152 # The exact variables and functions that may be referenced within an expression
9153 # are determined by the service that evaluates it. See the service
9154 # documentation for additional information.
9155 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9156 # describes the expression, e.g. when hovered over it in a UI.
9157 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9158 # syntax.
9159 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9160 # reporting, e.g. a file name and a position in the file.
9161 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9162 # its purpose. This can be used e.g. in UIs which allow to enter the
9163 # expression.
9164 },
9165 ],
9166 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Named Set being applied to this Router, which is
9167 # essentially a hash of the Named Set used for optimistic locking.
9168 # The fingerprint is initially generated by Compute Engine and changes
9169 # after every request to modify or update the Named Set. You must always
9170 # provide an up-to-date fingerprint hash in order to update or change
9171 # labels.
9172 #
9173 # To see the latest fingerprint, make a getNamedSet() request
9174 # to retrieve a Named Set.
9175 &quot;name&quot;: &quot;A String&quot;, # This set&#x27;s name, which must be a resource ID segment and unique within all
9176 # named sets owned by the Router. Name should conform to RFC1035.
9177 &quot;type&quot;: &quot;A String&quot;, # This named set&#x27;s type
9178 }
9179
9180 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9181 that if you must retry your request, the server will know to ignore the
9182 request if it has already been completed.
9183
9184 For example, consider a situation where you make an initial request and
9185 the request times out. If you make the request again with the same
9186 request ID, the server can check if original operation with the same
9187 request ID was received, and if so, will ignore the second request. This
9188 prevents clients from accidentally creating duplicate commitments.
9189
9190 The request ID must be
9191 a valid UUID with the exception that zero UUID is not supported
9192 (00000000-0000-0000-0000-000000000000).
9193 x__xgafv: string, V1 error format.
9194 Allowed values
9195 1 - v1 error format
9196 2 - v2 error format
9197
9198 Returns:
9199 An object of the form:
9200
9201 { # Represents an Operation resource.
9202 #
9203 # Google Compute Engine has three Operation resources:
9204 #
9205 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
9206 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
9207 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
9208 #
9209 # You can use an operation resource to manage asynchronous API requests.
9210 # For more information, readHandling
9211 # API responses.
9212 #
9213 # Operations can be global, regional or zonal.
9214 #
9215 # - For global operations, use the `globalOperations`
9216 # resource.
9217 # - For regional operations, use the
9218 # `regionOperations` resource.
9219 # - For zonal operations, use
9220 # the `zoneOperations` resource.
9221 #
9222 #
9223 #
9224 # For more information, read
9225 # Global, Regional, and Zonal Resources.
9226 #
9227 # Note that completed Operation resources have a limited
9228 # retention period.
9229 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9230 # Not present otherwise.
9231 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9232 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9233 # set when the operation is created.
9234 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9235 # text format.
9236 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9237 # this field will be populated.
9238 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9239 # operation.
9240 {
9241 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9242 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9243 # details. There is a set of defined message types to use for providing
9244 # details.The syntax depends on the error code. For example,
9245 # QuotaExceededInfo will have details when the error code is
9246 # QUOTA_EXCEEDED.
9247 {
9248 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9249 #
9250 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9251 # is not enabled:
9252 #
9253 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9254 # &quot;domain&quot;: &quot;googleapis.com&quot;
9255 # &quot;metadata&quot;: {
9256 # &quot;resource&quot;: &quot;projects/123&quot;,
9257 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9258 # }
9259 # }
9260 #
9261 # This response indicates that the pubsub.googleapis.com API is not enabled.
9262 #
9263 # Example of an error that is returned when attempting to create a Spanner
9264 # instance in a region that is out of stock:
9265 #
9266 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9267 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9268 # &quot;metadata&quot;: {
9269 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9270 # }
9271 # }
9272 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9273 # is typically the registered service name of the tool or product that
9274 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9275 # generated by some common infrastructure, the error domain must be a
9276 # globally unique value that identifies the infrastructure. For Google API
9277 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9278 &quot;metadatas&quot;: { # Additional structured details about this error.
9279 #
9280 # Keys must match a regular expression of `a-z+` but should
9281 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9282 # length. When identifying the current value of an exceeded limit, the units
9283 # should be contained in the key, not the value. For example, rather than
9284 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9285 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9286 # instances that can be created in a single (batch) request.
9287 &quot;a_key&quot;: &quot;A String&quot;,
9288 },
9289 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9290 # proximate cause of the error. Error reasons are unique within a particular
9291 # domain of errors. This should be at most 63 characters and match a
9292 # regular expression of `A-Z+[A-Z0-9]`, which represents
9293 # UPPER_SNAKE_CASE.
9294 },
9295 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9296 #
9297 # For example, if a quota check failed with an error indicating the calling
9298 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9299 # directly to the right place in the developer console to flip the bit.
9300 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9301 { # Describes a URL link.
9302 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9303 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9304 },
9305 ],
9306 },
9307 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9308 # which can be attached to an RPC error.
9309 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9310 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9311 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9312 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9313 },
9314 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9315 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9316 &quot;a_key&quot;: &quot;A String&quot;,
9317 },
9318 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9319 # type or metric.
9320 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9321 # or metric.
9322 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9323 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9324 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9325 },
9326 },
9327 ],
9328 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9329 # This property is optional.
9330 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9331 },
9332 ],
9333 },
9334 &quot;getVersionOperationMetadata&quot;: {
9335 &quot;inlineSbomInfo&quot;: {
9336 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9337 # appropriate identifiers.
9338 &quot;a_key&quot;: &quot;A String&quot;,
9339 },
9340 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9341 # identifiers.
9342 &quot;a_key&quot;: &quot;A String&quot;,
9343 },
9344 },
9345 },
9346 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9347 # message that was returned, such as `NOT FOUND`.
9348 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9349 # status code that was returned. For example, a `404` means the
9350 # resource was not found.
9351 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9352 # defined by the server.
9353 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9354 # This value is inRFC3339
9355 # text format.
9356 &quot;instancesBulkInsertOperationMetadata&quot;: {
9357 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9358 # Example key: zones/us-central1-a
9359 &quot;a_key&quot;: {
9360 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9361 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9362 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9363 # error.
9364 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9365 # if the flow is rolling forward or rolling back.
9366 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9367 },
9368 },
9369 },
9370 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9371 # Operation resources.
9372 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9373 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9374 # group of operations results from a `bulkInsert` API request.
9375 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9376 # `update`, or `delete`, and so on.
9377 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9378 # There is no requirement that this be linear or support any granularity of
9379 # operations. This should not be used to guess when the operation will be
9380 # complete. This number should monotonically increase as the operation
9381 # progresses.
9382 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9383 # applicable when performing regional operations.
9384 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9385 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9386 # this field will contain information on all underlying zonal actions and
9387 # their state.
9388 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9389 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9390 # Example key: zones/us-central1-a
9391 &quot;a_key&quot;: {
9392 &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
9393 # populated.
9394 # different programming environments, including REST APIs and RPC APIs. It is
9395 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9396 # three pieces of data: error code, error message, and error details.
9397 #
9398 # You can find out more about this error model and how to work with it in the
9399 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9400 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9401 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9402 # message types for APIs to use.
9403 {
9404 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9405 },
9406 ],
9407 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9408 # user-facing error message should be localized and sent in the
9409 # google.rpc.Status.details field, or localized by the client.
9410 },
9411 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9412 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9413 },
9414 },
9415 },
9416 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9417 # This value is inRFC3339
9418 # text format.
9419 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9420 # following:
9421 # `PENDING`, `RUNNING`, or `DONE`.
9422 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9423 # operation.
9424 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9425 # of the target resource.
9426 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9427 # operations related to creating a snapshot, this points to the disk
9428 # that the snapshot was created from.
9429 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9430 # `[email protected]` or
9431 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9432 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9433 # operation, this field will be populated.
9434 {
9435 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9436 # Engine returns NO_RESULTS_ON_PAGE if there
9437 # are no results in the response.
9438 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9439 # value format. For example:
9440 #
9441 # &quot;data&quot;: [
9442 # {
9443 # &quot;key&quot;: &quot;scope&quot;,
9444 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9445 # }
9446 {
9447 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9448 # returned. For example, for warnings where there are no results in a list
9449 # request for a particular zone, this key might be scope and
9450 # the key value might be the zone name. Other examples might be a key
9451 # indicating a deprecated resource and a suggested replacement, or a
9452 # warning about invalid network settings (for example, if an instance
9453 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9454 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9455 },
9456 ],
9457 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9458 },
9459 ],
9460 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9461 # applicable when performing per-zone operations.
9462 }</pre>
9463 </div>
9464
9465 <div class="method">
9466 <code class="details" id="updateRoutePolicy">updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</code>
9467 <pre>Updates or creates new Route Policy
9468
9469 Args:
9470 project: string, Project ID for this request. (required)
9471 region: string, Name of the region for this request. (required)
9472 router: string, Name of the Router resource where Route Policy is defined. (required)
9473 body: object, The request body.
9474 The object takes the form of:
9475
9476 {
9477 &quot;description&quot;: &quot;A String&quot;, # An optional description of route policy.
9478 &quot;fingerprint&quot;: &quot;A String&quot;, # A fingerprint for the Route Policy being applied to this Router, which is
9479 # essentially a hash of the Route Policy used for optimistic locking.
9480 # The fingerprint is initially generated by Compute Engine and changes
9481 # after every request to modify or update Route Policy. You must always
9482 # provide an up-to-date fingerprint hash in order to update or change
9483 # labels.
9484 #
9485 # To see the latest fingerprint, make a getRoutePolicy() request
9486 # to retrieve a Route Policy.
9487 &quot;name&quot;: &quot;A String&quot;, # Route Policy name, which must be a resource ID segment and unique
9488 # within all the router&#x27;s Route Policies. Name should conform to RFC1035.
9489 &quot;terms&quot;: [ # List of terms (the order in the list is not important, they are evaluated
9490 # in order of priority). Order of policies is not retained and might change
9491 # when getting policy later.
9492 {
9493 &quot;actions&quot;: [ # CEL expressions to evaluate to modify a route when this term matches.
9494 { # Represents a textual expression in the Common Expression Language (CEL)
9495 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9496 # are documented at https://github.com/google/cel-spec.
9497 #
9498 # Example (Comparison):
9499 #
9500 # title: &quot;Summary size limit&quot;
9501 # description: &quot;Determines if a summary is less than 100 chars&quot;
9502 # expression: &quot;document.summary.size() &lt; 100&quot;
9503 #
9504 # Example (Equality):
9505 #
9506 # title: &quot;Requestor is owner&quot;
9507 # description: &quot;Determines if requestor is the document owner&quot;
9508 # expression: &quot;document.owner == request.auth.claims.email&quot;
9509 #
9510 # Example (Logic):
9511 #
9512 # title: &quot;Public documents&quot;
9513 # description: &quot;Determine whether the document should be publicly visible&quot;
9514 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9515 #
9516 # Example (Data Manipulation):
9517 #
9518 # title: &quot;Notification string&quot;
9519 # description: &quot;Create a notification string with a timestamp.&quot;
9520 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9521 #
9522 # The exact variables and functions that may be referenced within an expression
9523 # are determined by the service that evaluates it. See the service
9524 # documentation for additional information.
9525 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9526 # describes the expression, e.g. when hovered over it in a UI.
9527 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9528 # syntax.
9529 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9530 # reporting, e.g. a file name and a position in the file.
9531 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9532 # its purpose. This can be used e.g. in UIs which allow to enter the
9533 # expression.
9534 },
9535 ],
9536 &quot;match&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
9537 # applies. When not set, the term applies to all
9538 # routes.
9539 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9540 # are documented at https://github.com/google/cel-spec.
9541 #
9542 # Example (Comparison):
9543 #
9544 # title: &quot;Summary size limit&quot;
9545 # description: &quot;Determines if a summary is less than 100 chars&quot;
9546 # expression: &quot;document.summary.size() &lt; 100&quot;
9547 #
9548 # Example (Equality):
9549 #
9550 # title: &quot;Requestor is owner&quot;
9551 # description: &quot;Determines if requestor is the document owner&quot;
9552 # expression: &quot;document.owner == request.auth.claims.email&quot;
9553 #
9554 # Example (Logic):
9555 #
9556 # title: &quot;Public documents&quot;
9557 # description: &quot;Determine whether the document should be publicly visible&quot;
9558 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9559 #
9560 # Example (Data Manipulation):
9561 #
9562 # title: &quot;Notification string&quot;
9563 # description: &quot;Create a notification string with a timestamp.&quot;
9564 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9565 #
9566 # The exact variables and functions that may be referenced within an expression
9567 # are determined by the service that evaluates it. See the service
9568 # documentation for additional information.
9569 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9570 # describes the expression, e.g. when hovered over it in a UI.
9571 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9572 # syntax.
9573 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9574 # reporting, e.g. a file name and a position in the file.
9575 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9576 # its purpose. This can be used e.g. in UIs which allow to enter the
9577 # expression.
9578 },
9579 &quot;priority&quot;: 42, # The evaluation priority for this term, which must be between 0
9580 # (inclusive) and 2^31 (exclusive), and unique within the list.
9581 },
9582 ],
9583 &quot;type&quot;: &quot;A String&quot;,
9584 }
9585
9586 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9587 that if you must retry your request, the server will know to ignore the
9588 request if it has already been completed.
9589
9590 For example, consider a situation where you make an initial request and
9591 the request times out. If you make the request again with the same
9592 request ID, the server can check if original operation with the same
9593 request ID was received, and if so, will ignore the second request. This
9594 prevents clients from accidentally creating duplicate commitments.
9595
9596 The request ID must be
9597 a valid UUID with the exception that zero UUID is not supported
9598 (00000000-0000-0000-0000-000000000000).
9599 x__xgafv: string, V1 error format.
9600 Allowed values
9601 1 - v1 error format
9602 2 - v2 error format
9603
9604 Returns:
9605 An object of the form:
9606
9607 { # Represents an Operation resource.
9608 #
9609 # Google Compute Engine has three Operation resources:
9610 #
9611 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
9612 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
9613 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
9614 #
9615 # You can use an operation resource to manage asynchronous API requests.
9616 # For more information, readHandling
9617 # API responses.
9618 #
9619 # Operations can be global, regional or zonal.
9620 #
9621 # - For global operations, use the `globalOperations`
9622 # resource.
9623 # - For regional operations, use the
9624 # `regionOperations` resource.
9625 # - For zonal operations, use
9626 # the `zoneOperations` resource.
9627 #
9628 #
9629 #
9630 # For more information, read
9631 # Global, Regional, and Zonal Resources.
9632 #
9633 # Note that completed Operation resources have a limited
9634 # retention period.
9635 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9636 # Not present otherwise.
9637 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9638 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9639 # set when the operation is created.
9640 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9641 # text format.
9642 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9643 # this field will be populated.
9644 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9645 # operation.
9646 {
9647 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9648 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9649 # details. There is a set of defined message types to use for providing
9650 # details.The syntax depends on the error code. For example,
9651 # QuotaExceededInfo will have details when the error code is
9652 # QUOTA_EXCEEDED.
9653 {
9654 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9655 #
9656 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9657 # is not enabled:
9658 #
9659 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9660 # &quot;domain&quot;: &quot;googleapis.com&quot;
9661 # &quot;metadata&quot;: {
9662 # &quot;resource&quot;: &quot;projects/123&quot;,
9663 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9664 # }
9665 # }
9666 #
9667 # This response indicates that the pubsub.googleapis.com API is not enabled.
9668 #
9669 # Example of an error that is returned when attempting to create a Spanner
9670 # instance in a region that is out of stock:
9671 #
9672 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9673 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9674 # &quot;metadata&quot;: {
9675 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9676 # }
9677 # }
9678 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9679 # is typically the registered service name of the tool or product that
9680 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9681 # generated by some common infrastructure, the error domain must be a
9682 # globally unique value that identifies the infrastructure. For Google API
9683 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9684 &quot;metadatas&quot;: { # Additional structured details about this error.
9685 #
9686 # Keys must match a regular expression of `a-z+` but should
9687 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9688 # length. When identifying the current value of an exceeded limit, the units
9689 # should be contained in the key, not the value. For example, rather than
9690 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9691 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9692 # instances that can be created in a single (batch) request.
9693 &quot;a_key&quot;: &quot;A String&quot;,
9694 },
9695 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9696 # proximate cause of the error. Error reasons are unique within a particular
9697 # domain of errors. This should be at most 63 characters and match a
9698 # regular expression of `A-Z+[A-Z0-9]`, which represents
9699 # UPPER_SNAKE_CASE.
9700 },
9701 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9702 #
9703 # For example, if a quota check failed with an error indicating the calling
9704 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9705 # directly to the right place in the developer console to flip the bit.
9706 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9707 { # Describes a URL link.
9708 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9709 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9710 },
9711 ],
9712 },
9713 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9714 # which can be attached to an RPC error.
9715 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9716 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9717 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9718 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9719 },
9720 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9721 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9722 &quot;a_key&quot;: &quot;A String&quot;,
9723 },
9724 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9725 # type or metric.
9726 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9727 # or metric.
9728 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9729 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9730 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9731 },
9732 },
9733 ],
9734 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9735 # This property is optional.
9736 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9737 },
9738 ],
9739 },
9740 &quot;getVersionOperationMetadata&quot;: {
9741 &quot;inlineSbomInfo&quot;: {
9742 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9743 # appropriate identifiers.
9744 &quot;a_key&quot;: &quot;A String&quot;,
9745 },
9746 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9747 # identifiers.
9748 &quot;a_key&quot;: &quot;A String&quot;,
9749 },
9750 },
9751 },
9752 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9753 # message that was returned, such as `NOT FOUND`.
9754 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9755 # status code that was returned. For example, a `404` means the
9756 # resource was not found.
9757 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9758 # defined by the server.
9759 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9760 # This value is inRFC3339
9761 # text format.
9762 &quot;instancesBulkInsertOperationMetadata&quot;: {
9763 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9764 # Example key: zones/us-central1-a
9765 &quot;a_key&quot;: {
9766 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9767 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9768 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9769 # error.
9770 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9771 # if the flow is rolling forward or rolling back.
9772 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9773 },
9774 },
9775 },
9776 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9777 # Operation resources.
9778 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9779 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9780 # group of operations results from a `bulkInsert` API request.
9781 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9782 # `update`, or `delete`, and so on.
9783 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9784 # There is no requirement that this be linear or support any granularity of
9785 # operations. This should not be used to guess when the operation will be
9786 # complete. This number should monotonically increase as the operation
9787 # progresses.
9788 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9789 # applicable when performing regional operations.
9790 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9791 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9792 # this field will contain information on all underlying zonal actions and
9793 # their state.
9794 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9795 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9796 # Example key: zones/us-central1-a
9797 &quot;a_key&quot;: {
9798 &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
9799 # populated.
9800 # different programming environments, including REST APIs and RPC APIs. It is
9801 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9802 # three pieces of data: error code, error message, and error details.
9803 #
9804 # You can find out more about this error model and how to work with it in the
9805 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9806 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9807 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9808 # message types for APIs to use.
9809 {
9810 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9811 },
9812 ],
9813 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9814 # user-facing error message should be localized and sent in the
9815 # google.rpc.Status.details field, or localized by the client.
9816 },
9817 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9818 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9819 },
9820 },
9821 },
9822 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9823 # This value is inRFC3339
9824 # text format.
9825 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9826 # following:
9827 # `PENDING`, `RUNNING`, or `DONE`.
9828 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9829 # operation.
9830 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9831 # of the target resource.
9832 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9833 # operations related to creating a snapshot, this points to the disk
9834 # that the snapshot was created from.
9835 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9836 # `[email protected]` or
9837 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9838 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9839 # operation, this field will be populated.
9840 {
9841 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9842 # Engine returns NO_RESULTS_ON_PAGE if there
9843 # are no results in the response.
9844 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9845 # value format. For example:
9846 #
9847 # &quot;data&quot;: [
9848 # {
9849 # &quot;key&quot;: &quot;scope&quot;,
9850 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9851 # }
9852 {
9853 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9854 # returned. For example, for warnings where there are no results in a list
9855 # request for a particular zone, this key might be scope and
9856 # the key value might be the zone name. Other examples might be a key
9857 # indicating a deprecated resource and a suggested replacement, or a
9858 # warning about invalid network settings (for example, if an instance
9859 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9860 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9861 },
9862 ],
9863 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9864 },
9865 ],
9866 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9867 # applicable when performing per-zone operations.
9868 }</pre>
9869 </div>
9870
9871 </body></html>