Debian Codegraph @

docs/dyn/compute_beta.routes.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.routes.html">routes</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(project, route, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified Route resource.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, route, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the specified Route resource.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Creates a Route resource in the specified project using the data included</p>
89 <p class="toc_element">
90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves the list of Route resources available to the specified project.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="delete">delete(project, route, requestId=None, x__xgafv=None)</code>
106 <pre>Deletes the specified Route resource.
107
108 Args:
109 project: string, Project ID for this request. (required)
110 route: string, Name of the Route resource to delete. (required)
111 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
112 that if you must retry your request, the server will know to ignore the
113 request if it has already been completed.
114
115 For example, consider a situation where you make an initial request and
116 the request times out. If you make the request again with the same
117 request ID, the server can check if original operation with the same
118 request ID was received, and if so, will ignore the second request. This
119 prevents clients from accidentally creating duplicate commitments.
120
121 The request ID must be
122 a valid UUID with the exception that zero UUID is not supported
123 (00000000-0000-0000-0000-000000000000).
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129 Returns:
130 An object of the form:
131
132 { # Represents an Operation resource.
133 #
134 # Google Compute Engine has three Operation resources:
135 #
136 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
137 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
138 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
139 #
140 # You can use an operation resource to manage asynchronous API requests.
141 # For more information, readHandling
142 # API responses.
143 #
144 # Operations can be global, regional or zonal.
145 #
146 # - For global operations, use the `globalOperations`
147 # resource.
148 # - For regional operations, use the
149 # `regionOperations` resource.
150 # - For zonal operations, use
151 # the `zoneOperations` resource.
152 #
153 #
154 #
155 # For more information, read
156 # Global, Regional, and Zonal Resources.
157 #
158 # Note that completed Operation resources have a limited
159 # retention period.
160 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
161 # Not present otherwise.
162 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
163 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
164 # set when the operation is created.
165 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
166 # text format.
167 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
168 # this field will be populated.
169 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
170 # operation.
171 {
172 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
173 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
174 # details. There is a set of defined message types to use for providing
175 # details.The syntax depends on the error code. For example,
176 # QuotaExceededInfo will have details when the error code is
177 # QUOTA_EXCEEDED.
178 {
179 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
180 #
181 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
182 # is not enabled:
183 #
184 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
185 # &quot;domain&quot;: &quot;googleapis.com&quot;
186 # &quot;metadata&quot;: {
187 # &quot;resource&quot;: &quot;projects/123&quot;,
188 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
189 # }
190 # }
191 #
192 # This response indicates that the pubsub.googleapis.com API is not enabled.
193 #
194 # Example of an error that is returned when attempting to create a Spanner
195 # instance in a region that is out of stock:
196 #
197 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
198 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
199 # &quot;metadata&quot;: {
200 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
201 # }
202 # }
203 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
204 # is typically the registered service name of the tool or product that
205 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
206 # generated by some common infrastructure, the error domain must be a
207 # globally unique value that identifies the infrastructure. For Google API
208 # infrastructure, the error domain is &quot;googleapis.com&quot;.
209 &quot;metadatas&quot;: { # Additional structured details about this error.
210 #
211 # Keys must match a regular expression of `a-z+` but should
212 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
213 # length. When identifying the current value of an exceeded limit, the units
214 # should be contained in the key, not the value. For example, rather than
215 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
216 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
217 # instances that can be created in a single (batch) request.
218 &quot;a_key&quot;: &quot;A String&quot;,
219 },
220 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
221 # proximate cause of the error. Error reasons are unique within a particular
222 # domain of errors. This should be at most 63 characters and match a
223 # regular expression of `A-Z+[A-Z0-9]`, which represents
224 # UPPER_SNAKE_CASE.
225 },
226 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
227 #
228 # For example, if a quota check failed with an error indicating the calling
229 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
230 # directly to the right place in the developer console to flip the bit.
231 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
232 { # Describes a URL link.
233 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
234 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
235 },
236 ],
237 },
238 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
239 # which can be attached to an RPC error.
240 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
241 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
242 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
243 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
244 },
245 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
246 &quot;dimensions&quot;: { # The map holding related quota dimensions.
247 &quot;a_key&quot;: &quot;A String&quot;,
248 },
249 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
250 # type or metric.
251 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
252 # or metric.
253 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
254 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
255 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
256 },
257 },
258 ],
259 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
260 # This property is optional.
261 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
262 },
263 ],
264 },
265 &quot;getVersionOperationMetadata&quot;: {
266 &quot;inlineSbomInfo&quot;: {
267 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
268 # appropriate identifiers.
269 &quot;a_key&quot;: &quot;A String&quot;,
270 },
271 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
272 # identifiers.
273 &quot;a_key&quot;: &quot;A String&quot;,
274 },
275 },
276 },
277 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
278 # message that was returned, such as `NOT FOUND`.
279 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
280 # status code that was returned. For example, a `404` means the
281 # resource was not found.
282 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
283 # defined by the server.
284 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
285 # This value is inRFC3339
286 # text format.
287 &quot;instancesBulkInsertOperationMetadata&quot;: {
288 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
289 # Example key: zones/us-central1-a
290 &quot;a_key&quot;: {
291 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
292 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
293 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
294 # error.
295 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
296 # if the flow is rolling forward or rolling back.
297 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
298 },
299 },
300 },
301 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
302 # Operation resources.
303 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
304 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
305 # group of operations results from a `bulkInsert` API request.
306 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
307 # `update`, or `delete`, and so on.
308 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
309 # There is no requirement that this be linear or support any granularity of
310 # operations. This should not be used to guess when the operation will be
311 # complete. This number should monotonically increase as the operation
312 # progresses.
313 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
314 # applicable when performing regional operations.
315 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
316 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
317 # this field will contain information on all underlying zonal actions and
318 # their state.
319 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
320 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
321 # Example key: zones/us-central1-a
322 &quot;a_key&quot;: {
323 &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
324 # populated.
325 # different programming environments, including REST APIs and RPC APIs. It is
326 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
327 # three pieces of data: error code, error message, and error details.
328 #
329 # You can find out more about this error model and how to work with it in the
330 # [API Design Guide](https://cloud.google.com/apis/design/errors).
331 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
332 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
333 # message types for APIs to use.
334 {
335 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
336 },
337 ],
338 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
339 # user-facing error message should be localized and sent in the
340 # google.rpc.Status.details field, or localized by the client.
341 },
342 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
343 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
344 },
345 },
346 },
347 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
348 # This value is inRFC3339
349 # text format.
350 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
351 # following:
352 # `PENDING`, `RUNNING`, or `DONE`.
353 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
354 # operation.
355 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
356 # of the target resource.
357 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
358 # operations related to creating a snapshot, this points to the disk
359 # that the snapshot was created from.
360 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
361 # `[email protected]` or
362 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
363 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
364 # operation, this field will be populated.
365 {
366 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
367 # Engine returns NO_RESULTS_ON_PAGE if there
368 # are no results in the response.
369 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
370 # value format. For example:
371 #
372 # &quot;data&quot;: [
373 # {
374 # &quot;key&quot;: &quot;scope&quot;,
375 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
376 # }
377 {
378 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
379 # returned. For example, for warnings where there are no results in a list
380 # request for a particular zone, this key might be scope and
381 # the key value might be the zone name. Other examples might be a key
382 # indicating a deprecated resource and a suggested replacement, or a
383 # warning about invalid network settings (for example, if an instance
384 # attempts to perform IP forwarding but is not enabled for IP forwarding).
385 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
386 },
387 ],
388 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
389 },
390 ],
391 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
392 # applicable when performing per-zone operations.
393 }</pre>
394 </div>
395
396 <div class="method">
397 <code class="details" id="get">get(project, route, x__xgafv=None)</code>
398 <pre>Returns the specified Route resource.
399
400 Args:
401 project: string, Project ID for this request. (required)
402 route: string, Name of the Route resource to return. (required)
403 x__xgafv: string, V1 error format.
404 Allowed values
405 1 - v1 error format
406 2 - v2 error format
407
408 Returns:
409 An object of the form:
410
411 { # Represents a Route resource.
412 #
413 # A route defines a path from VM instances in the VPC network to a specific
414 # destination. This destination can be inside or outside the VPC network.
415 # For more information, read theRoutes overview.
416 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
417 {
418 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
419 42,
420 ],
421 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
422 # values:
423 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
424 # in has traversed
425 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
426 # systems that the route has traversed
427 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
428 # ordered set of Member Autonomous Systems in the local confederation that
429 # the route has traversed
430 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
431 # Member Autonomous Systems in the local confederation that the route has
432 # traversed
433 },
434 ],
435 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
436 # text format.
437 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
438 # create the resource.
439 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
440 # IPv4 and IPv6 are supported.
441 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
442 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
443 # compressed format.
444 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
445 # defined by the server.
446 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
447 # Route resources.
448 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
449 # The name must be 1-63 characters long, and comply withRFC1035.
450 # Specifically, the name must be 1-63 characters long and match the regular
451 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
452 # lowercase letter, and all following characters (except for the last
453 # character) must be a dash, lowercase letter, or digit. The last character
454 # must be a lowercase letter or digit.
455 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
456 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
457 # You can only specify the internet gateway using a full or
458 # partial valid URL: projects/project/global/gateways/default-internet-gateway
459 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
460 # that will handle matching packets.
461 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
462 # packets or the IP address of the forwarding Rule.
463 # For example, the following are all valid URLs:
464 #
465 #
466 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
467 # - regions/region/forwardingRules/forwardingRule
468 #
469 #
470 # If an IP address is provided, must specify an IPv4 address in dot-decimal
471 # notation or an IPv6 address in RFC 4291 format. For example, the following
472 # are all valid IP addresses:
473 #
474 #
475 # - 10.128.0.56
476 # - 2001:db8::2d9:51:0:0
477 # - 2001:db8:0:0:2d9:51:0:0
478 #
479 #
480 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
481 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
482 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
483 # this as a full or partial URL.
484 # For example:
485 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
486 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
487 # calculates based on factors such as network performance, distance, and
488 # available bandwidth between regions.
489 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
490 # for the route.
491 # This field will only be populated for dynamic routes generated by
492 # Cloud Router with a linked interconnectAttachment or the static route
493 # generated by each L2 Interconnect Attachment.
494 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
495 # Both IPv6 address and IPv4 addresses are supported.
496 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
497 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
498 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
499 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
500 # IPv4-mapped IPv6 address.
501 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
502 # the desirability of a particular route in a network.
503 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
504 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
505 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
506 # or INCOMPLETE.
507 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
508 # which should conform to RFC1035.
509 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
510 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
511 # as part of resource payload.
512 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
513 # Tag keys and values have the same definition as resource
514 # manager tags. The field is allowed for INSERT
515 # only. The keys/values to set on the resource should be specified in
516 # either ID { : } or Namespaced format
517 # { : }.
518 # For example the following are valid inputs:
519 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
520 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
521 # Note:
522 # * Invalid combinations of ID &amp; namespaced format is not supported. For
523 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
524 &quot;a_key&quot;: &quot;A String&quot;,
525 },
526 },
527 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
528 # where there is more than one matching route of equal prefix length. In
529 # cases where multiple routes have equal prefix length, the one with the
530 # lowest-numbered priority value wins. The default value is `1000`. The
531 # priority value must be from `0` to `65535`, inclusive.
532 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
533 # dynamic routes learned by Cloud Routers. It is also applicable to routes
534 # undergoing migration.
535 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
536 # values:
537 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
538 # another Cloud Router and will readvertise to one of its BGP peers
539 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
540 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
541 # - &#x27;STATIC&#x27; for a static route
542 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
543 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
544 &quot;A String&quot;,
545 ],
546 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
547 # route, this field will be populated with warning messages.
548 {
549 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
550 # Engine returns NO_RESULTS_ON_PAGE if there
551 # are no results in the response.
552 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
553 # value format. For example:
554 #
555 # &quot;data&quot;: [
556 # {
557 # &quot;key&quot;: &quot;scope&quot;,
558 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
559 # }
560 {
561 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
562 # returned. For example, for warnings where there are no results in a list
563 # request for a particular zone, this key might be scope and
564 # the key value might be the zone name. Other examples might be a key
565 # indicating a deprecated resource and a suggested replacement, or a
566 # warning about invalid network settings (for example, if an instance
567 # attempts to perform IP forwarding but is not enabled for IP forwarding).
568 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
569 },
570 ],
571 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
572 },
573 ],
574 }</pre>
575 </div>
576
577 <div class="method">
578 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
579 <pre>Creates a Route resource in the specified project using the data included
580 in the request.
581
582 Args:
583 project: string, Project ID for this request. (required)
584 body: object, The request body.
585 The object takes the form of:
586
587 { # Represents a Route resource.
588 #
589 # A route defines a path from VM instances in the VPC network to a specific
590 # destination. This destination can be inside or outside the VPC network.
591 # For more information, read theRoutes overview.
592 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
593 {
594 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
595 42,
596 ],
597 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
598 # values:
599 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
600 # in has traversed
601 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
602 # systems that the route has traversed
603 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
604 # ordered set of Member Autonomous Systems in the local confederation that
605 # the route has traversed
606 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
607 # Member Autonomous Systems in the local confederation that the route has
608 # traversed
609 },
610 ],
611 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
612 # text format.
613 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
614 # create the resource.
615 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
616 # IPv4 and IPv6 are supported.
617 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
618 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
619 # compressed format.
620 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
621 # defined by the server.
622 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
623 # Route resources.
624 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
625 # The name must be 1-63 characters long, and comply withRFC1035.
626 # Specifically, the name must be 1-63 characters long and match the regular
627 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
628 # lowercase letter, and all following characters (except for the last
629 # character) must be a dash, lowercase letter, or digit. The last character
630 # must be a lowercase letter or digit.
631 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
632 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
633 # You can only specify the internet gateway using a full or
634 # partial valid URL: projects/project/global/gateways/default-internet-gateway
635 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
636 # that will handle matching packets.
637 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
638 # packets or the IP address of the forwarding Rule.
639 # For example, the following are all valid URLs:
640 #
641 #
642 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
643 # - regions/region/forwardingRules/forwardingRule
644 #
645 #
646 # If an IP address is provided, must specify an IPv4 address in dot-decimal
647 # notation or an IPv6 address in RFC 4291 format. For example, the following
648 # are all valid IP addresses:
649 #
650 #
651 # - 10.128.0.56
652 # - 2001:db8::2d9:51:0:0
653 # - 2001:db8:0:0:2d9:51:0:0
654 #
655 #
656 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
657 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
658 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
659 # this as a full or partial URL.
660 # For example:
661 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
662 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
663 # calculates based on factors such as network performance, distance, and
664 # available bandwidth between regions.
665 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
666 # for the route.
667 # This field will only be populated for dynamic routes generated by
668 # Cloud Router with a linked interconnectAttachment or the static route
669 # generated by each L2 Interconnect Attachment.
670 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
671 # Both IPv6 address and IPv4 addresses are supported.
672 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
673 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
674 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
675 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
676 # IPv4-mapped IPv6 address.
677 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
678 # the desirability of a particular route in a network.
679 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
680 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
681 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
682 # or INCOMPLETE.
683 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
684 # which should conform to RFC1035.
685 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
686 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
687 # as part of resource payload.
688 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
689 # Tag keys and values have the same definition as resource
690 # manager tags. The field is allowed for INSERT
691 # only. The keys/values to set on the resource should be specified in
692 # either ID { : } or Namespaced format
693 # { : }.
694 # For example the following are valid inputs:
695 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
696 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
697 # Note:
698 # * Invalid combinations of ID &amp; namespaced format is not supported. For
699 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
700 &quot;a_key&quot;: &quot;A String&quot;,
701 },
702 },
703 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
704 # where there is more than one matching route of equal prefix length. In
705 # cases where multiple routes have equal prefix length, the one with the
706 # lowest-numbered priority value wins. The default value is `1000`. The
707 # priority value must be from `0` to `65535`, inclusive.
708 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
709 # dynamic routes learned by Cloud Routers. It is also applicable to routes
710 # undergoing migration.
711 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
712 # values:
713 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
714 # another Cloud Router and will readvertise to one of its BGP peers
715 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
716 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
717 # - &#x27;STATIC&#x27; for a static route
718 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
719 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
720 &quot;A String&quot;,
721 ],
722 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
723 # route, this field will be populated with warning messages.
724 {
725 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
726 # Engine returns NO_RESULTS_ON_PAGE if there
727 # are no results in the response.
728 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
729 # value format. For example:
730 #
731 # &quot;data&quot;: [
732 # {
733 # &quot;key&quot;: &quot;scope&quot;,
734 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
735 # }
736 {
737 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
738 # returned. For example, for warnings where there are no results in a list
739 # request for a particular zone, this key might be scope and
740 # the key value might be the zone name. Other examples might be a key
741 # indicating a deprecated resource and a suggested replacement, or a
742 # warning about invalid network settings (for example, if an instance
743 # attempts to perform IP forwarding but is not enabled for IP forwarding).
744 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
745 },
746 ],
747 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
748 },
749 ],
750 }
751
752 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
753 that if you must retry your request, the server will know to ignore the
754 request if it has already been completed.
755
756 For example, consider a situation where you make an initial request and
757 the request times out. If you make the request again with the same
758 request ID, the server can check if original operation with the same
759 request ID was received, and if so, will ignore the second request. This
760 prevents clients from accidentally creating duplicate commitments.
761
762 The request ID must be
763 a valid UUID with the exception that zero UUID is not supported
764 (00000000-0000-0000-0000-000000000000).
765 x__xgafv: string, V1 error format.
766 Allowed values
767 1 - v1 error format
768 2 - v2 error format
769
770 Returns:
771 An object of the form:
772
773 { # Represents an Operation resource.
774 #
775 # Google Compute Engine has three Operation resources:
776 #
777 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
778 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
779 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
780 #
781 # You can use an operation resource to manage asynchronous API requests.
782 # For more information, readHandling
783 # API responses.
784 #
785 # Operations can be global, regional or zonal.
786 #
787 # - For global operations, use the `globalOperations`
788 # resource.
789 # - For regional operations, use the
790 # `regionOperations` resource.
791 # - For zonal operations, use
792 # the `zoneOperations` resource.
793 #
794 #
795 #
796 # For more information, read
797 # Global, Regional, and Zonal Resources.
798 #
799 # Note that completed Operation resources have a limited
800 # retention period.
801 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
802 # Not present otherwise.
803 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
804 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
805 # set when the operation is created.
806 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
807 # text format.
808 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
809 # this field will be populated.
810 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
811 # operation.
812 {
813 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
814 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
815 # details. There is a set of defined message types to use for providing
816 # details.The syntax depends on the error code. For example,
817 # QuotaExceededInfo will have details when the error code is
818 # QUOTA_EXCEEDED.
819 {
820 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
821 #
822 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
823 # is not enabled:
824 #
825 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
826 # &quot;domain&quot;: &quot;googleapis.com&quot;
827 # &quot;metadata&quot;: {
828 # &quot;resource&quot;: &quot;projects/123&quot;,
829 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
830 # }
831 # }
832 #
833 # This response indicates that the pubsub.googleapis.com API is not enabled.
834 #
835 # Example of an error that is returned when attempting to create a Spanner
836 # instance in a region that is out of stock:
837 #
838 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
839 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
840 # &quot;metadata&quot;: {
841 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
842 # }
843 # }
844 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
845 # is typically the registered service name of the tool or product that
846 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
847 # generated by some common infrastructure, the error domain must be a
848 # globally unique value that identifies the infrastructure. For Google API
849 # infrastructure, the error domain is &quot;googleapis.com&quot;.
850 &quot;metadatas&quot;: { # Additional structured details about this error.
851 #
852 # Keys must match a regular expression of `a-z+` but should
853 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
854 # length. When identifying the current value of an exceeded limit, the units
855 # should be contained in the key, not the value. For example, rather than
856 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
857 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
858 # instances that can be created in a single (batch) request.
859 &quot;a_key&quot;: &quot;A String&quot;,
860 },
861 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
862 # proximate cause of the error. Error reasons are unique within a particular
863 # domain of errors. This should be at most 63 characters and match a
864 # regular expression of `A-Z+[A-Z0-9]`, which represents
865 # UPPER_SNAKE_CASE.
866 },
867 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
868 #
869 # For example, if a quota check failed with an error indicating the calling
870 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
871 # directly to the right place in the developer console to flip the bit.
872 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
873 { # Describes a URL link.
874 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
875 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
876 },
877 ],
878 },
879 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
880 # which can be attached to an RPC error.
881 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
882 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
883 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
884 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
885 },
886 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
887 &quot;dimensions&quot;: { # The map holding related quota dimensions.
888 &quot;a_key&quot;: &quot;A String&quot;,
889 },
890 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
891 # type or metric.
892 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
893 # or metric.
894 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
895 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
896 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
897 },
898 },
899 ],
900 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
901 # This property is optional.
902 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
903 },
904 ],
905 },
906 &quot;getVersionOperationMetadata&quot;: {
907 &quot;inlineSbomInfo&quot;: {
908 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
909 # appropriate identifiers.
910 &quot;a_key&quot;: &quot;A String&quot;,
911 },
912 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
913 # identifiers.
914 &quot;a_key&quot;: &quot;A String&quot;,
915 },
916 },
917 },
918 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
919 # message that was returned, such as `NOT FOUND`.
920 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
921 # status code that was returned. For example, a `404` means the
922 # resource was not found.
923 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
924 # defined by the server.
925 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
926 # This value is inRFC3339
927 # text format.
928 &quot;instancesBulkInsertOperationMetadata&quot;: {
929 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
930 # Example key: zones/us-central1-a
931 &quot;a_key&quot;: {
932 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
933 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
934 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
935 # error.
936 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
937 # if the flow is rolling forward or rolling back.
938 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
939 },
940 },
941 },
942 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
943 # Operation resources.
944 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
945 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
946 # group of operations results from a `bulkInsert` API request.
947 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
948 # `update`, or `delete`, and so on.
949 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
950 # There is no requirement that this be linear or support any granularity of
951 # operations. This should not be used to guess when the operation will be
952 # complete. This number should monotonically increase as the operation
953 # progresses.
954 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
955 # applicable when performing regional operations.
956 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
957 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
958 # this field will contain information on all underlying zonal actions and
959 # their state.
960 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
961 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
962 # Example key: zones/us-central1-a
963 &quot;a_key&quot;: {
964 &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
965 # populated.
966 # different programming environments, including REST APIs and RPC APIs. It is
967 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
968 # three pieces of data: error code, error message, and error details.
969 #
970 # You can find out more about this error model and how to work with it in the
971 # [API Design Guide](https://cloud.google.com/apis/design/errors).
972 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
973 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
974 # message types for APIs to use.
975 {
976 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
977 },
978 ],
979 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
980 # user-facing error message should be localized and sent in the
981 # google.rpc.Status.details field, or localized by the client.
982 },
983 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
984 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
985 },
986 },
987 },
988 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
989 # This value is inRFC3339
990 # text format.
991 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
992 # following:
993 # `PENDING`, `RUNNING`, or `DONE`.
994 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
995 # operation.
996 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
997 # of the target resource.
998 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
999 # operations related to creating a snapshot, this points to the disk
1000 # that the snapshot was created from.
1001 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1002 # `[email protected]` or
1003 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1004 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1005 # operation, this field will be populated.
1006 {
1007 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1008 # Engine returns NO_RESULTS_ON_PAGE if there
1009 # are no results in the response.
1010 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1011 # value format. For example:
1012 #
1013 # &quot;data&quot;: [
1014 # {
1015 # &quot;key&quot;: &quot;scope&quot;,
1016 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1017 # }
1018 {
1019 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1020 # returned. For example, for warnings where there are no results in a list
1021 # request for a particular zone, this key might be scope and
1022 # the key value might be the zone name. Other examples might be a key
1023 # indicating a deprecated resource and a suggested replacement, or a
1024 # warning about invalid network settings (for example, if an instance
1025 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1026 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1027 },
1028 ],
1029 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1030 },
1031 ],
1032 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1033 # applicable when performing per-zone operations.
1034 }</pre>
1035 </div>
1036
1037 <div class="method">
1038 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1039 <pre>Retrieves the list of Route resources available to the specified project.
1040
1041 Args:
1042 project: string, Project ID for this request. (required)
1043 filter: string, A filter expression that filters resources listed in the response. Most
1044 Compute resources support two types of filter expressions:
1045 expressions that support regular expressions and expressions that follow
1046 API improvement proposal AIP-160.
1047 These two types of filter expressions cannot be mixed in one request.
1048
1049 If you want to use AIP-160, your expression must specify the field name, an
1050 operator, and the value that you want to use for filtering. The value
1051 must be a string, a number, or a boolean. The operator
1052 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1053
1054 For example, if you are filtering Compute Engine instances, you can
1055 exclude instances named `example-instance` by specifying
1056 `name != example-instance`.
1057
1058 The `:*` comparison can be used to test whether a key has been defined.
1059 For example, to find all objects with `owner` label use:
1060 ```
1061 labels.owner:*
1062 ```
1063
1064 You can also filter nested fields. For example, you could specify
1065 `scheduling.automaticRestart = false` to include instances only
1066 if they are not scheduled for automatic restarts. You can use filtering
1067 on nested fields to filter based onresource labels.
1068
1069 To filter on multiple expressions, provide each separate expression within
1070 parentheses. For example:
1071 ```
1072 (scheduling.automaticRestart = true)
1073 (cpuPlatform = &quot;Intel Skylake&quot;)
1074 ```
1075 By default, each expression is an `AND` expression. However, you
1076 can include `AND` and `OR` expressions explicitly.
1077 For example:
1078 ```
1079 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1080 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1081 (scheduling.automaticRestart = true)
1082 ```
1083
1084 If you want to use a regular expression, use the `eq` (equal) or `ne`
1085 (not equal) operator against a single un-parenthesized expression with or
1086 without quotes or against multiple parenthesized expressions. Examples:
1087
1088 `fieldname eq unquoted literal`
1089 `fieldname eq &#x27;single quoted literal&#x27;`
1090 `fieldname eq &quot;double quoted literal&quot;`
1091 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1092
1093 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1094 The literal value must match the entire field.
1095
1096 For example, to filter for instances that do not end with name &quot;instance&quot;,
1097 you would use `name ne .*instance`.
1098
1099 You cannot combine constraints on multiple fields using regular
1100 expressions.
1101 maxResults: integer, The maximum number of results per page that should be returned.
1102 If the number of available results is larger than `maxResults`,
1103 Compute Engine returns a `nextPageToken` that can be used to get
1104 the next page of results in subsequent list requests. Acceptable values are
1105 `0` to `500`, inclusive. (Default: `500`)
1106 orderBy: string, Sorts list results by a certain order. By default, results
1107 are returned in alphanumerical order based on the resource name.
1108
1109 You can also sort results in descending order based on the creation
1110 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1111 results based on the `creationTimestamp` field in
1112 reverse chronological order (newest result first). Use this to sort
1113 resources like operations so that the newest operation is returned first.
1114
1115 Currently, only sorting by `name` or
1116 `creationTimestamp desc` is supported.
1117 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1118 `nextPageToken` returned by a previous list request to get
1119 the next page of results.
1120 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1121 of failure. The default value is false.
1122
1123 For example, when partial success behavior is enabled, aggregatedList for a
1124 single zone scope either returns all resources in the zone or no resources,
1125 with an error code.
1126 x__xgafv: string, V1 error format.
1127 Allowed values
1128 1 - v1 error format
1129 2 - v2 error format
1130
1131 Returns:
1132 An object of the form:
1133
1134 { # Contains a list of Route resources.
1135 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1136 &quot;items&quot;: [ # A list of Route resources.
1137 { # Represents a Route resource.
1138 #
1139 # A route defines a path from VM instances in the VPC network to a specific
1140 # destination. This destination can be inside or outside the VPC network.
1141 # For more information, read theRoutes overview.
1142 &quot;asPaths&quot;: [ # Output only. [Output Only] AS path.
1143 {
1144 &quot;asLists&quot;: [ # [Output Only] The AS numbers of the AS Path.
1145 42,
1146 ],
1147 &quot;pathSegmentType&quot;: &quot;A String&quot;, # [Output Only] The type of the AS Path, which can be one of the following
1148 # values:
1149 # - &#x27;AS_SET&#x27;: unordered set of autonomous systems that the route
1150 # in has traversed
1151 # - &#x27;AS_SEQUENCE&#x27;: ordered set of autonomous
1152 # systems that the route has traversed
1153 # - &#x27;AS_CONFED_SEQUENCE&#x27;:
1154 # ordered set of Member Autonomous Systems in the local confederation that
1155 # the route has traversed
1156 # - &#x27;AS_CONFED_SET&#x27;: unordered set of
1157 # Member Autonomous Systems in the local confederation that the route has
1158 # traversed
1159 },
1160 ],
1161 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1162 # text format.
1163 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
1164 # create the resource.
1165 &quot;destRange&quot;: &quot;A String&quot;, # The destination range of outgoing packets that this route applies to. Both
1166 # IPv4 and IPv6 are supported.
1167 # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
1168 # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
1169 # compressed format.
1170 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1171 # defined by the server.
1172 &quot;kind&quot;: &quot;compute#route&quot;, # Output only. [Output Only] Type of this resource. Always compute#routes for
1173 # Route resources.
1174 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1175 # The name must be 1-63 characters long, and comply withRFC1035.
1176 # Specifically, the name must be 1-63 characters long and match the regular
1177 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a
1178 # lowercase letter, and all following characters (except for the last
1179 # character) must be a dash, lowercase letter, or digit. The last character
1180 # must be a lowercase letter or digit.
1181 &quot;network&quot;: &quot;A String&quot;, # Fully-qualified URL of the network that this route applies to.
1182 &quot;nextHopGateway&quot;: &quot;A String&quot;, # The URL to a gateway that should handle matching packets.
1183 # You can only specify the internet gateway using a full or
1184 # partial valid URL: projects/project/global/gateways/default-internet-gateway
1185 &quot;nextHopHub&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the Network Connectivity Center hub
1186 # that will handle matching packets.
1187 &quot;nextHopIlb&quot;: &quot;A String&quot;, # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
1188 # packets or the IP address of the forwarding Rule.
1189 # For example, the following are all valid URLs:
1190 #
1191 #
1192 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
1193 # - regions/region/forwardingRules/forwardingRule
1194 #
1195 #
1196 # If an IP address is provided, must specify an IPv4 address in dot-decimal
1197 # notation or an IPv6 address in RFC 4291 format. For example, the following
1198 # are all valid IP addresses:
1199 #
1200 #
1201 # - 10.128.0.56
1202 # - 2001:db8::2d9:51:0:0
1203 # - 2001:db8:0:0:2d9:51:0:0
1204 #
1205 #
1206 # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
1207 # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
1208 &quot;nextHopInstance&quot;: &quot;A String&quot;, # The URL to an instance that should handle matching packets. You can specify
1209 # this as a full or partial URL.
1210 # For example:
1211 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
1212 &quot;nextHopInterRegionCost&quot;: 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud
1213 # calculates based on factors such as network performance, distance, and
1214 # available bandwidth between regions.
1215 &quot;nextHopInterconnectAttachment&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop
1216 # for the route.
1217 # This field will only be populated for dynamic routes generated by
1218 # Cloud Router with a linked interconnectAttachment or the static route
1219 # generated by each L2 Interconnect Attachment.
1220 &quot;nextHopIp&quot;: &quot;A String&quot;, # The network IP address of an instance that should handle matching packets.
1221 # Both IPv6 address and IPv4 addresses are supported.
1222 # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
1223 # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
1224 # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
1225 # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
1226 # IPv4-mapped IPv6 address.
1227 &quot;nextHopMed&quot;: 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates
1228 # the desirability of a particular route in a network.
1229 &quot;nextHopNetwork&quot;: &quot;A String&quot;, # The URL of the local network if it should handle matching packets.
1230 &quot;nextHopOrigin&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the origin of the route. Can be IGP
1231 # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol),
1232 # or INCOMPLETE.
1233 &quot;nextHopPeering&quot;: &quot;A String&quot;, # Output only. [Output Only] The network peering name that should handle matching packets,
1234 # which should conform to RFC1035.
1235 &quot;nextHopVpnTunnel&quot;: &quot;A String&quot;, # The URL to a VpnTunnel that should handle matching packets.
1236 &quot;params&quot;: { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1237 # as part of resource payload.
1238 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1239 # Tag keys and values have the same definition as resource
1240 # manager tags. The field is allowed for INSERT
1241 # only. The keys/values to set on the resource should be specified in
1242 # either ID { : } or Namespaced format
1243 # { : }.
1244 # For example the following are valid inputs:
1245 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1246 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1247 # Note:
1248 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1249 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1250 &quot;a_key&quot;: &quot;A String&quot;,
1251 },
1252 },
1253 &quot;priority&quot;: 42, # The priority of this route. Priority is used to break ties in cases
1254 # where there is more than one matching route of equal prefix length. In
1255 # cases where multiple routes have equal prefix length, the one with the
1256 # lowest-numbered priority value wins. The default value is `1000`. The
1257 # priority value must be from `0` to `65535`, inclusive.
1258 &quot;routeStatus&quot;: &quot;A String&quot;, # [Output only] The status of the route. This status applies to
1259 # dynamic routes learned by Cloud Routers. It is also applicable to routes
1260 # undergoing migration.
1261 &quot;routeType&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of this route, which can be one of the following
1262 # values:
1263 # - &#x27;TRANSIT&#x27; for a transit route that this router learned from
1264 # another Cloud Router and will readvertise to one of its BGP peers
1265 # - &#x27;SUBNET&#x27; for a route from a subnet of the VPC
1266 # - &#x27;BGP&#x27; for a route learned from a BGP peer of this router
1267 # - &#x27;STATIC&#x27; for a static route
1268 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined fully-qualified URL for this resource.
1269 &quot;tags&quot;: [ # A list of instance tags to which this route applies.
1270 &quot;A String&quot;,
1271 ],
1272 &quot;warnings&quot;: [ # Output only. [Output Only] If potential misconfigurations are detected for this
1273 # route, this field will be populated with warning messages.
1274 {
1275 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1276 # Engine returns NO_RESULTS_ON_PAGE if there
1277 # are no results in the response.
1278 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1279 # value format. For example:
1280 #
1281 # &quot;data&quot;: [
1282 # {
1283 # &quot;key&quot;: &quot;scope&quot;,
1284 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1285 # }
1286 {
1287 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1288 # returned. For example, for warnings where there are no results in a list
1289 # request for a particular zone, this key might be scope and
1290 # the key value might be the zone name. Other examples might be a key
1291 # indicating a deprecated resource and a suggested replacement, or a
1292 # warning about invalid network settings (for example, if an instance
1293 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1294 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1295 },
1296 ],
1297 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1298 },
1299 ],
1300 },
1301 ],
1302 &quot;kind&quot;: &quot;compute#routeList&quot;, # Output only. Type of resource.
1303 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1304 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1305 # the query parameter pageToken in the next list request.
1306 # Subsequent list requests will have their own nextPageToken to
1307 # continue paging through the results.
1308 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1309 &quot;warning&quot;: { # [Output Only] Informational warning message.
1310 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1311 # Engine returns NO_RESULTS_ON_PAGE if there
1312 # are no results in the response.
1313 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1314 # value format. For example:
1315 #
1316 # &quot;data&quot;: [
1317 # {
1318 # &quot;key&quot;: &quot;scope&quot;,
1319 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1320 # }
1321 {
1322 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1323 # returned. For example, for warnings where there are no results in a list
1324 # request for a particular zone, this key might be scope and
1325 # the key value might be the zone name. Other examples might be a key
1326 # indicating a deprecated resource and a suggested replacement, or a
1327 # warning about invalid network settings (for example, if an instance
1328 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1329 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1330 },
1331 ],
1332 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1333 },
1334 }</pre>
1335 </div>
1336
1337 <div class="method">
1338 <code class="details" id="list_next">list_next()</code>
1339 <pre>Retrieves the next page of results.
1340
1341 Args:
1342 previous_request: The request for the previous page. (required)
1343 previous_response: The response from the request for the previous page. (required)
1344
1345 Returns:
1346 A request object that you can call &#x27;execute()&#x27; on to request the next
1347 page. Returns None if there are no more items in the collection.
1348 </pre>
1349 </div>
1350
1351 <div class="method">
1352 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
1353 <pre>Returns permissions that a caller has on the specified resource.
1354
1355 Args:
1356 project: string, Project ID for this request. (required)
1357 resource: string, Name or id of the resource for this request. (required)
1358 body: object, The request body.
1359 The object takes the form of:
1360
1361 {
1362 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
1363 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1364 &quot;A String&quot;,
1365 ],
1366 }
1367
1368 x__xgafv: string, V1 error format.
1369 Allowed values
1370 1 - v1 error format
1371 2 - v2 error format
1372
1373 Returns:
1374 An object of the form:
1375
1376 {
1377 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1378 # allowed.
1379 &quot;A String&quot;,
1380 ],
1381 }</pre>
1382 </div>
1383
1384 </body></html>