Debian Codegraph @

docs/dyn/compute_alpha.vpnGateways.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.vpnGateways.html">vpnGateways</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 VPN gateways.</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, vpnGateway, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified VPN gateway.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, region, vpnGateway, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified VPN gateway.</p>
92 <p class="toc_element">
93 <code><a href="#getStatus">getStatus(project, region, vpnGateway, x__xgafv=None)</a></code></p>
94 <p class="firstline">Returns the status for the specified VPN gateway.</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates a VPN gateway in the specified project and region using</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Retrieves a list of VPN gateways available to the specified</p>
101 <p class="toc_element">
102 <code><a href="#list_next">list_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Sets the labels on a VpnGateway. To learn more about labels, read theLabeling</p>
107 <p class="toc_element">
108 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
110 <h3>Method Details</h3>
111 <div class="method">
112 <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>
113 <pre>Retrieves an aggregated list of VPN gateways.
114
115 To prevent failure, Google recommends that you set the
116 `returnPartialSuccess` parameter to `true`.
117
118 Args:
119 project: string, Project ID for this request. (required)
120 filter: string, A filter expression that filters resources listed in the response. Most
121 Compute resources support two types of filter expressions:
122 expressions that support regular expressions and expressions that follow
123 API improvement proposal AIP-160.
124 These two types of filter expressions cannot be mixed in one request.
125
126 If you want to use AIP-160, your expression must specify the field name, an
127 operator, and the value that you want to use for filtering. The value
128 must be a string, a number, or a boolean. The operator
129 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
130
131 For example, if you are filtering Compute Engine instances, you can
132 exclude instances named `example-instance` by specifying
133 `name != example-instance`.
134
135 The `:*` comparison can be used to test whether a key has been defined.
136 For example, to find all objects with `owner` label use:
137 ```
138 labels.owner:*
139 ```
140
141 You can also filter nested fields. For example, you could specify
142 `scheduling.automaticRestart = false` to include instances only
143 if they are not scheduled for automatic restarts. You can use filtering
144 on nested fields to filter based onresource labels.
145
146 To filter on multiple expressions, provide each separate expression within
147 parentheses. For example:
148 ```
149 (scheduling.automaticRestart = true)
150 (cpuPlatform = &quot;Intel Skylake&quot;)
151 ```
152 By default, each expression is an `AND` expression. However, you
153 can include `AND` and `OR` expressions explicitly.
154 For example:
155 ```
156 (cpuPlatform = &quot;Intel Skylake&quot;) OR
157 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
158 (scheduling.automaticRestart = true)
159 ```
160
161 If you want to use a regular expression, use the `eq` (equal) or `ne`
162 (not equal) operator against a single un-parenthesized expression with or
163 without quotes or against multiple parenthesized expressions. Examples:
164
165 `fieldname eq unquoted literal`
166 `fieldname eq &#x27;single quoted literal&#x27;`
167 `fieldname eq &quot;double quoted literal&quot;`
168 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
169
170 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
171 The literal value must match the entire field.
172
173 For example, to filter for instances that do not end with name &quot;instance&quot;,
174 you would use `name ne .*instance`.
175
176 You cannot combine constraints on multiple fields using regular
177 expressions.
178 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
179 global) should be included in the response. For new resource types added
180 after this field, the flag has no effect as new resource types will always
181 include every visible scope for each scope type in response. For resource
182 types which predate this field, if this flag is omitted or false, only
183 scopes of the scope types where the resource type is expected to be found
184 will be included.
185 maxResults: integer, The maximum number of results per page that should be returned.
186 If the number of available results is larger than `maxResults`,
187 Compute Engine returns a `nextPageToken` that can be used to get
188 the next page of results in subsequent list requests. Acceptable values are
189 `0` to `500`, inclusive. (Default: `500`)
190 orderBy: string, Sorts list results by a certain order. By default, results
191 are returned in alphanumerical order based on the resource name.
192
193 You can also sort results in descending order based on the creation
194 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
195 results based on the `creationTimestamp` field in
196 reverse chronological order (newest result first). Use this to sort
197 resources like operations so that the newest operation is returned first.
198
199 Currently, only sorting by `name` or
200 `creationTimestamp desc` is supported.
201 pageToken: string, Specifies a page token to use. Set `pageToken` to the
202 `nextPageToken` returned by a previous list request to get
203 the next page of results.
204 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
205 of failure. The default value is false.
206
207 For example, when partial success behavior is enabled, aggregatedList for a
208 single zone scope either returns all resources in the zone or no resources,
209 with an error code.
210 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
211 aggregated list request is invoked for subnetworks list-usable api.
212 x__xgafv: string, V1 error format.
213 Allowed values
214 1 - v1 error format
215 2 - v2 error format
216
217 Returns:
218 An object of the form:
219
220 {
221 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
222 &quot;items&quot;: { # A list of VpnGateway resources.
223 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of VPN gateways.
224 &quot;vpnGateways&quot;: [ # [Output Only] A list of VPN gateways contained in this scope.
225 { # Represents a HA VPN gateway.
226 #
227 # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely
228 # connect your on-premises network to your Google Cloud Virtual Private Cloud
229 # network through an IPsec VPN connection in a single region.
230 # For more information about Cloud HA VPN solutions, see
231 # Cloud VPN topologies .
232 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
233 # text format.
234 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
235 # create the resource.
236 &quot;gatewayIpVersion&quot;: &quot;A String&quot;, # The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
237 # specified, IPV4 will be used.
238 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
239 # defined by the server.
240 &quot;kind&quot;: &quot;compute#vpnGateway&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
241 # VPN gateways.
242 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this VpnGateway, which
243 # is essentially a hash of the labels set used for optimistic locking. The
244 # fingerprint is initially generated by Compute Engine and changes after
245 # every request to modify or update labels. You must always provide an
246 # up-to-date fingerprint hash in order to update or change labels,
247 # otherwise the request will fail with error412 conditionNotMet.
248 #
249 # To see the latest fingerprint, make a get() request to
250 # retrieve a VpnGateway.
251 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
252 # Label values may be empty.
253 &quot;a_key&quot;: &quot;A String&quot;,
254 },
255 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
256 # The name must be 1-63 characters long, and comply withRFC1035.
257 # Specifically, the name must be 1-63 characters long and match the regular
258 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
259 # character must be a lowercase letter, and all following characters must
260 # be a dash, lowercase letter, or digit, except the last character, which
261 # cannot be a dash.
262 &quot;network&quot;: &quot;A String&quot;, # URL of the network to which this VPN gateway is attached. Provided by the
263 # client when the VPN gateway is created.
264 &quot;params&quot;: { # Input only. [Input Only] Additional params passed with the request, but not persisted
265 # as part of resource payload.
266 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
267 # Tag keys and values have the same definition as resource
268 # manager tags. The field is allowed for INSERT
269 # only. The keys/values to set on the resource should be specified in
270 # either ID { : } or Namespaced format
271 # { : }.
272 # For example the following are valid inputs:
273 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
274 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
275 # Note:
276 # * Invalid combinations of ID &amp; namespaced format is not supported. For
277 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
278 # * Inconsistent format is not supported. For instance:
279 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
280 &quot;a_key&quot;: &quot;A String&quot;,
281 },
282 },
283 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the VPN gateway resides.
284 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
285 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this VPN gateway to identify the IP protocols that are
286 # enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6.
287 &quot;vpnInterfaces&quot;: [ # The list of VPN interfaces associated with this VPN gateway.
288 { # A VPN gateway interface.
289 &quot;id&quot;: 42, # Output only. [Output Only] Numeric identifier for this VPN interface associated with
290 # the VPN gateway.
291 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # URL of the VLAN attachment (interconnectAttachment) resource for this
292 # VPN gateway interface. When the value of this field is present, the VPN
293 # gateway is used for HA VPN over Cloud Interconnect; all egress
294 # or ingress traffic for this VPN gateway interface goes through the
295 # specified VLAN attachment resource.
296 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address for this VPN interface associated with the VPN
297 # gateway.
298 # The IP address could be either a regional external IP address or
299 # a regional internal IP address. The two IP addresses for a VPN gateway
300 # must be all regional external or regional internal IP addresses. There
301 # cannot be a mix of regional external IP addresses and regional internal
302 # IP addresses. For HA VPN over Cloud Interconnect, the IP addresses
303 # for both interfaces could either be regional internal IP addresses or
304 # regional external IP addresses. For regular (non HA VPN over Cloud
305 # Interconnect) HA VPN tunnels, the IP address must be a regional external
306 # IP address.
307 &quot;ipv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address for this VPN interface associated with the VPN
308 # gateway.
309 # The IPv6 address must be a regional external IPv6 address. The format is
310 # RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
311 },
312 ],
313 },
314 ],
315 &quot;warning&quot;: { # [Output Only] Informational warning which replaces the list of addresses
316 # when the list is empty.
317 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
318 # Engine returns NO_RESULTS_ON_PAGE if there
319 # are no results in the response.
320 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
321 # value format. For example:
322 #
323 # &quot;data&quot;: [
324 # {
325 # &quot;key&quot;: &quot;scope&quot;,
326 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
327 # }
328 {
329 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
330 # returned. For example, for warnings where there are no results in a list
331 # request for a particular zone, this key might be scope and
332 # the key value might be the zone name. Other examples might be a key
333 # indicating a deprecated resource and a suggested replacement, or a
334 # warning about invalid network settings (for example, if an instance
335 # attempts to perform IP forwarding but is not enabled for IP forwarding).
336 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
337 },
338 ],
339 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
340 },
341 },
342 },
343 &quot;kind&quot;: &quot;compute#vpnGatewayAggregatedList&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
344 # VPN gateways.
345 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
346 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
347 # the query parameter pageToken in the next list request.
348 # Subsequent list requests will have their own nextPageToken to
349 # continue paging through the results.
350 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
351 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
352 &quot;A String&quot;,
353 ],
354 &quot;warning&quot;: { # [Output Only] Informational warning message.
355 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
356 # Engine returns NO_RESULTS_ON_PAGE if there
357 # are no results in the response.
358 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
359 # value format. For example:
360 #
361 # &quot;data&quot;: [
362 # {
363 # &quot;key&quot;: &quot;scope&quot;,
364 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
365 # }
366 {
367 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
368 # returned. For example, for warnings where there are no results in a list
369 # request for a particular zone, this key might be scope and
370 # the key value might be the zone name. Other examples might be a key
371 # indicating a deprecated resource and a suggested replacement, or a
372 # warning about invalid network settings (for example, if an instance
373 # attempts to perform IP forwarding but is not enabled for IP forwarding).
374 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
375 },
376 ],
377 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
378 },
379 }</pre>
380 </div>
381
382 <div class="method">
383 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
384 <pre>Retrieves the next page of results.
385
386 Args:
387 previous_request: The request for the previous page. (required)
388 previous_response: The response from the request for the previous page. (required)
389
390 Returns:
391 A request object that you can call &#x27;execute()&#x27; on to request the next
392 page. Returns None if there are no more items in the collection.
393 </pre>
394 </div>
395
396 <div class="method">
397 <code class="details" id="close">close()</code>
398 <pre>Close httplib2 connections.</pre>
399 </div>
400
401 <div class="method">
402 <code class="details" id="delete">delete(project, region, vpnGateway, requestId=None, x__xgafv=None)</code>
403 <pre>Deletes the specified VPN gateway.
404
405 Args:
406 project: string, Project ID for this request. (required)
407 region: string, Name of the region for this request. (required)
408 vpnGateway: string, Name of the VPN gateway to delete. (required)
409 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
410 that if you must retry your request, the server will know to ignore the
411 request if it has already been completed.
412
413 For example, consider a situation where you make an initial request and
414 the request times out. If you make the request again with the same
415 request ID, the server can check if original operation with the same
416 request ID was received, and if so, will ignore the second request. This
417 prevents clients from accidentally creating duplicate commitments.
418
419 The request ID must be
420 a valid UUID with the exception that zero UUID is not supported
421 (00000000-0000-0000-0000-000000000000).
422 x__xgafv: string, V1 error format.
423 Allowed values
424 1 - v1 error format
425 2 - v2 error format
426
427 Returns:
428 An object of the form:
429
430 { # Represents an Operation resource.
431 #
432 # Google Compute Engine has three Operation resources:
433 #
434 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
435 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
436 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
437 #
438 # You can use an operation resource to manage asynchronous API requests.
439 # For more information, readHandling
440 # API responses.
441 #
442 # Operations can be global, regional or zonal.
443 #
444 # - For global operations, use the `globalOperations`
445 # resource.
446 # - For regional operations, use the
447 # `regionOperations` resource.
448 # - For zonal operations, use
449 # the `zoneOperations` resource.
450 #
451 #
452 #
453 # For more information, read
454 # Global, Regional, and Zonal Resources.
455 #
456 # Note that completed Operation resources have a limited
457 # retention period.
458 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
459 # Not present otherwise.
460 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
461 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
462 # set when the operation is created.
463 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
464 # text format.
465 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
466 # this field will be populated.
467 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
468 # operation.
469 {
470 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
471 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
472 # details. There is a set of defined message types to use for providing
473 # details.The syntax depends on the error code. For example,
474 # QuotaExceededInfo will have details when the error code is
475 # QUOTA_EXCEEDED.
476 {
477 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
478 #
479 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
480 # is not enabled:
481 #
482 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
483 # &quot;domain&quot;: &quot;googleapis.com&quot;
484 # &quot;metadata&quot;: {
485 # &quot;resource&quot;: &quot;projects/123&quot;,
486 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
487 # }
488 # }
489 #
490 # This response indicates that the pubsub.googleapis.com API is not enabled.
491 #
492 # Example of an error that is returned when attempting to create a Spanner
493 # instance in a region that is out of stock:
494 #
495 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
496 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
497 # &quot;metadata&quot;: {
498 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
499 # }
500 # }
501 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
502 # is typically the registered service name of the tool or product that
503 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
504 # generated by some common infrastructure, the error domain must be a
505 # globally unique value that identifies the infrastructure. For Google API
506 # infrastructure, the error domain is &quot;googleapis.com&quot;.
507 &quot;metadatas&quot;: { # Additional structured details about this error.
508 #
509 # Keys must match a regular expression of `a-z+` but should
510 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
511 # length. When identifying the current value of an exceeded limit, the units
512 # should be contained in the key, not the value. For example, rather than
513 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
514 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
515 # instances that can be created in a single (batch) request.
516 &quot;a_key&quot;: &quot;A String&quot;,
517 },
518 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
519 # proximate cause of the error. Error reasons are unique within a particular
520 # domain of errors. This should be at most 63 characters and match a
521 # regular expression of `A-Z+[A-Z0-9]`, which represents
522 # UPPER_SNAKE_CASE.
523 },
524 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
525 #
526 # For example, if a quota check failed with an error indicating the calling
527 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
528 # directly to the right place in the developer console to flip the bit.
529 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
530 { # Describes a URL link.
531 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
532 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
533 },
534 ],
535 },
536 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
537 # which can be attached to an RPC error.
538 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
539 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
540 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
541 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
542 },
543 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
544 &quot;dimensions&quot;: { # The map holding related quota dimensions.
545 &quot;a_key&quot;: &quot;A String&quot;,
546 },
547 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
548 # type or metric.
549 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
550 # or metric.
551 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
552 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
553 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
554 },
555 },
556 ],
557 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
558 # This property is optional.
559 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
560 },
561 ],
562 },
563 &quot;getVersionOperationMetadata&quot;: {
564 &quot;inlineSbomInfo&quot;: {
565 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
566 # appropriate identifiers.
567 &quot;a_key&quot;: &quot;A String&quot;,
568 },
569 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
570 # identifiers.
571 &quot;a_key&quot;: &quot;A String&quot;,
572 },
573 },
574 },
575 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
576 # message that was returned, such as `NOT FOUND`.
577 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
578 # status code that was returned. For example, a `404` means the
579 # resource was not found.
580 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
581 # defined by the server.
582 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
583 # This value is inRFC3339
584 # text format.
585 &quot;instancesBulkInsertOperationMetadata&quot;: {
586 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
587 # Example key: zones/us-central1-a
588 &quot;a_key&quot;: {
589 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
590 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
591 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
592 # error.
593 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
594 # if the flow is rolling forward or rolling back.
595 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
596 },
597 },
598 },
599 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
600 # Operation resources.
601 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
602 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
603 # group of operations results from a `bulkInsert` API request.
604 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
605 # `update`, or `delete`, and so on.
606 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
607 # There is no requirement that this be linear or support any granularity of
608 # operations. This should not be used to guess when the operation will be
609 # complete. This number should monotonically increase as the operation
610 # progresses.
611 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
612 # applicable when performing regional operations.
613 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
614 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
615 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
616 # this field will contain information on all underlying zonal actions and
617 # their state.
618 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
619 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
620 # Example key: zones/us-central1-a
621 &quot;a_key&quot;: {
622 &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
623 # populated.
624 # different programming environments, including REST APIs and RPC APIs. It is
625 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
626 # three pieces of data: error code, error message, and error details.
627 #
628 # You can find out more about this error model and how to work with it in the
629 # [API Design Guide](https://cloud.google.com/apis/design/errors).
630 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
631 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
632 # message types for APIs to use.
633 {
634 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
635 },
636 ],
637 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
638 # user-facing error message should be localized and sent in the
639 # google.rpc.Status.details field, or localized by the client.
640 },
641 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
642 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
643 },
644 },
645 },
646 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
647 # This value is inRFC3339
648 # text format.
649 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
650 # following:
651 # `PENDING`, `RUNNING`, or `DONE`.
652 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
653 # operation.
654 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
655 # of the target resource.
656 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
657 # operations related to creating a snapshot, this points to the disk
658 # that the snapshot was created from.
659 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
660 # `[email protected]` or
661 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
662 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
663 # operation, this field will be populated.
664 {
665 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
666 # Engine returns NO_RESULTS_ON_PAGE if there
667 # are no results in the response.
668 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
669 # value format. For example:
670 #
671 # &quot;data&quot;: [
672 # {
673 # &quot;key&quot;: &quot;scope&quot;,
674 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
675 # }
676 {
677 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
678 # returned. For example, for warnings where there are no results in a list
679 # request for a particular zone, this key might be scope and
680 # the key value might be the zone name. Other examples might be a key
681 # indicating a deprecated resource and a suggested replacement, or a
682 # warning about invalid network settings (for example, if an instance
683 # attempts to perform IP forwarding but is not enabled for IP forwarding).
684 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
685 },
686 ],
687 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
688 },
689 ],
690 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
691 # applicable when performing per-zone operations.
692 }</pre>
693 </div>
694
695 <div class="method">
696 <code class="details" id="get">get(project, region, vpnGateway, x__xgafv=None)</code>
697 <pre>Returns the specified VPN gateway.
698
699 Args:
700 project: string, Project ID for this request. (required)
701 region: string, Name of the region for this request. (required)
702 vpnGateway: string, Name of the VPN gateway to return. (required)
703 x__xgafv: string, V1 error format.
704 Allowed values
705 1 - v1 error format
706 2 - v2 error format
707
708 Returns:
709 An object of the form:
710
711 { # Represents a HA VPN gateway.
712 #
713 # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely
714 # connect your on-premises network to your Google Cloud Virtual Private Cloud
715 # network through an IPsec VPN connection in a single region.
716 # For more information about Cloud HA VPN solutions, see
717 # Cloud VPN topologies .
718 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
719 # text format.
720 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
721 # create the resource.
722 &quot;gatewayIpVersion&quot;: &quot;A String&quot;, # The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
723 # specified, IPV4 will be used.
724 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
725 # defined by the server.
726 &quot;kind&quot;: &quot;compute#vpnGateway&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
727 # VPN gateways.
728 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this VpnGateway, which
729 # is essentially a hash of the labels set used for optimistic locking. The
730 # fingerprint is initially generated by Compute Engine and changes after
731 # every request to modify or update labels. You must always provide an
732 # up-to-date fingerprint hash in order to update or change labels,
733 # otherwise the request will fail with error412 conditionNotMet.
734 #
735 # To see the latest fingerprint, make a get() request to
736 # retrieve a VpnGateway.
737 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
738 # Label values may be empty.
739 &quot;a_key&quot;: &quot;A String&quot;,
740 },
741 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
742 # The name must be 1-63 characters long, and comply withRFC1035.
743 # Specifically, the name must be 1-63 characters long and match the regular
744 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
745 # character must be a lowercase letter, and all following characters must
746 # be a dash, lowercase letter, or digit, except the last character, which
747 # cannot be a dash.
748 &quot;network&quot;: &quot;A String&quot;, # URL of the network to which this VPN gateway is attached. Provided by the
749 # client when the VPN gateway is created.
750 &quot;params&quot;: { # Input only. [Input Only] Additional params passed with the request, but not persisted
751 # as part of resource payload.
752 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
753 # Tag keys and values have the same definition as resource
754 # manager tags. The field is allowed for INSERT
755 # only. The keys/values to set on the resource should be specified in
756 # either ID { : } or Namespaced format
757 # { : }.
758 # For example the following are valid inputs:
759 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
760 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
761 # Note:
762 # * Invalid combinations of ID &amp; namespaced format is not supported. For
763 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
764 # * Inconsistent format is not supported. For instance:
765 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
766 &quot;a_key&quot;: &quot;A String&quot;,
767 },
768 },
769 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the VPN gateway resides.
770 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
771 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this VPN gateway to identify the IP protocols that are
772 # enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6.
773 &quot;vpnInterfaces&quot;: [ # The list of VPN interfaces associated with this VPN gateway.
774 { # A VPN gateway interface.
775 &quot;id&quot;: 42, # Output only. [Output Only] Numeric identifier for this VPN interface associated with
776 # the VPN gateway.
777 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # URL of the VLAN attachment (interconnectAttachment) resource for this
778 # VPN gateway interface. When the value of this field is present, the VPN
779 # gateway is used for HA VPN over Cloud Interconnect; all egress
780 # or ingress traffic for this VPN gateway interface goes through the
781 # specified VLAN attachment resource.
782 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address for this VPN interface associated with the VPN
783 # gateway.
784 # The IP address could be either a regional external IP address or
785 # a regional internal IP address. The two IP addresses for a VPN gateway
786 # must be all regional external or regional internal IP addresses. There
787 # cannot be a mix of regional external IP addresses and regional internal
788 # IP addresses. For HA VPN over Cloud Interconnect, the IP addresses
789 # for both interfaces could either be regional internal IP addresses or
790 # regional external IP addresses. For regular (non HA VPN over Cloud
791 # Interconnect) HA VPN tunnels, the IP address must be a regional external
792 # IP address.
793 &quot;ipv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address for this VPN interface associated with the VPN
794 # gateway.
795 # The IPv6 address must be a regional external IPv6 address. The format is
796 # RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
797 },
798 ],
799 }</pre>
800 </div>
801
802 <div class="method">
803 <code class="details" id="getStatus">getStatus(project, region, vpnGateway, x__xgafv=None)</code>
804 <pre>Returns the status for the specified VPN gateway.
805
806 Args:
807 project: string, Project ID for this request. (required)
808 region: string, Name of the region for this request. (required)
809 vpnGateway: string, Name of the VPN gateway to return. (required)
810 x__xgafv: string, V1 error format.
811 Allowed values
812 1 - v1 error format
813 2 - v2 error format
814
815 Returns:
816 An object of the form:
817
818 {
819 &quot;result&quot;: {
820 &quot;vpnConnections&quot;: [ # Output only. List of VPN connection for this VpnGateway.
821 { # A VPN connection contains all VPN tunnels connected from this VpnGateway
822 # to the same peer gateway. The peer gateway could either be an external VPN
823 # gateway or a Google Cloud VPN gateway.
824 &quot;peerExternalGateway&quot;: &quot;A String&quot;, # Output only. URL reference to the peer external VPN gateways to which the VPN tunnels
825 # in this VPN connection are connected.
826 # This field is mutually exclusive with peer_gcp_gateway.
827 &quot;peerGcpGateway&quot;: &quot;A String&quot;, # Output only. URL reference to the peer side VPN gateways to which the VPN tunnels in
828 # this VPN connection are connected.
829 # This field is mutually exclusive with peer_gcp_gateway.
830 &quot;state&quot;: { # Describes the high availability requirement state for the VPN connection # HighAvailabilityRequirementState for the VPN connection.
831 # between this Cloud VPN gateway and a peer gateway.
832 &quot;state&quot;: &quot;A String&quot;, # Indicates the high availability requirement state for the VPN connection.
833 # Valid values are CONNECTION_REDUNDANCY_MET,CONNECTION_REDUNDANCY_NOT_MET.
834 &quot;unsatisfiedReason&quot;: &quot;A String&quot;, # Indicates the reason why the VPN connection does not meet the high
835 # availability redundancy criteria/requirement.
836 # Valid values is INCOMPLETE_TUNNELS_COVERAGE.
837 },
838 &quot;tunnels&quot;: [ # List of VPN tunnels that are in this VPN connection.
839 { # Contains some information about a VPN tunnel.
840 &quot;localGatewayInterface&quot;: 42, # Output only. The VPN gateway interface this VPN tunnel is associated with.
841 &quot;peerGatewayInterface&quot;: 42, # Output only. The peer gateway interface this VPN tunnel is connected to, the peer
842 # gateway could either be an external VPN gateway or a Google Cloud
843 # VPN gateway.
844 &quot;tunnelUrl&quot;: &quot;A String&quot;, # Output only. URL reference to the VPN tunnel.
845 },
846 ],
847 },
848 ],
849 },
850 }</pre>
851 </div>
852
853 <div class="method">
854 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
855 <pre>Creates a VPN gateway in the specified project and region using
856 the data included in the request.
857
858 Args:
859 project: string, Project ID for this request. (required)
860 region: string, Name of the region for this request. (required)
861 body: object, The request body.
862 The object takes the form of:
863
864 { # Represents a HA VPN gateway.
865 #
866 # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely
867 # connect your on-premises network to your Google Cloud Virtual Private Cloud
868 # network through an IPsec VPN connection in a single region.
869 # For more information about Cloud HA VPN solutions, see
870 # Cloud VPN topologies .
871 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
872 # text format.
873 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
874 # create the resource.
875 &quot;gatewayIpVersion&quot;: &quot;A String&quot;, # The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
876 # specified, IPV4 will be used.
877 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
878 # defined by the server.
879 &quot;kind&quot;: &quot;compute#vpnGateway&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
880 # VPN gateways.
881 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this VpnGateway, which
882 # is essentially a hash of the labels set used for optimistic locking. The
883 # fingerprint is initially generated by Compute Engine and changes after
884 # every request to modify or update labels. You must always provide an
885 # up-to-date fingerprint hash in order to update or change labels,
886 # otherwise the request will fail with error412 conditionNotMet.
887 #
888 # To see the latest fingerprint, make a get() request to
889 # retrieve a VpnGateway.
890 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
891 # Label values may be empty.
892 &quot;a_key&quot;: &quot;A String&quot;,
893 },
894 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
895 # The name must be 1-63 characters long, and comply withRFC1035.
896 # Specifically, the name must be 1-63 characters long and match the regular
897 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
898 # character must be a lowercase letter, and all following characters must
899 # be a dash, lowercase letter, or digit, except the last character, which
900 # cannot be a dash.
901 &quot;network&quot;: &quot;A String&quot;, # URL of the network to which this VPN gateway is attached. Provided by the
902 # client when the VPN gateway is created.
903 &quot;params&quot;: { # Input only. [Input Only] Additional params passed with the request, but not persisted
904 # as part of resource payload.
905 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
906 # Tag keys and values have the same definition as resource
907 # manager tags. The field is allowed for INSERT
908 # only. The keys/values to set on the resource should be specified in
909 # either ID { : } or Namespaced format
910 # { : }.
911 # For example the following are valid inputs:
912 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
913 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
914 # Note:
915 # * Invalid combinations of ID &amp; namespaced format is not supported. For
916 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
917 # * Inconsistent format is not supported. For instance:
918 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
919 &quot;a_key&quot;: &quot;A String&quot;,
920 },
921 },
922 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the VPN gateway resides.
923 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
924 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this VPN gateway to identify the IP protocols that are
925 # enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6.
926 &quot;vpnInterfaces&quot;: [ # The list of VPN interfaces associated with this VPN gateway.
927 { # A VPN gateway interface.
928 &quot;id&quot;: 42, # Output only. [Output Only] Numeric identifier for this VPN interface associated with
929 # the VPN gateway.
930 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # URL of the VLAN attachment (interconnectAttachment) resource for this
931 # VPN gateway interface. When the value of this field is present, the VPN
932 # gateway is used for HA VPN over Cloud Interconnect; all egress
933 # or ingress traffic for this VPN gateway interface goes through the
934 # specified VLAN attachment resource.
935 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address for this VPN interface associated with the VPN
936 # gateway.
937 # The IP address could be either a regional external IP address or
938 # a regional internal IP address. The two IP addresses for a VPN gateway
939 # must be all regional external or regional internal IP addresses. There
940 # cannot be a mix of regional external IP addresses and regional internal
941 # IP addresses. For HA VPN over Cloud Interconnect, the IP addresses
942 # for both interfaces could either be regional internal IP addresses or
943 # regional external IP addresses. For regular (non HA VPN over Cloud
944 # Interconnect) HA VPN tunnels, the IP address must be a regional external
945 # IP address.
946 &quot;ipv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address for this VPN interface associated with the VPN
947 # gateway.
948 # The IPv6 address must be a regional external IPv6 address. The format is
949 # RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
950 },
951 ],
952 }
953
954 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
955 that if you must retry your request, the server will know to ignore the
956 request if it has already been completed.
957
958 For example, consider a situation where you make an initial request and
959 the request times out. If you make the request again with the same
960 request ID, the server can check if original operation with the same
961 request ID was received, and if so, will ignore the second request. This
962 prevents clients from accidentally creating duplicate commitments.
963
964 The request ID must be
965 a valid UUID with the exception that zero UUID is not supported
966 (00000000-0000-0000-0000-000000000000).
967 x__xgafv: string, V1 error format.
968 Allowed values
969 1 - v1 error format
970 2 - v2 error format
971
972 Returns:
973 An object of the form:
974
975 { # Represents an Operation resource.
976 #
977 # Google Compute Engine has three Operation resources:
978 #
979 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
980 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
981 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
982 #
983 # You can use an operation resource to manage asynchronous API requests.
984 # For more information, readHandling
985 # API responses.
986 #
987 # Operations can be global, regional or zonal.
988 #
989 # - For global operations, use the `globalOperations`
990 # resource.
991 # - For regional operations, use the
992 # `regionOperations` resource.
993 # - For zonal operations, use
994 # the `zoneOperations` resource.
995 #
996 #
997 #
998 # For more information, read
999 # Global, Regional, and Zonal Resources.
1000 #
1001 # Note that completed Operation resources have a limited
1002 # retention period.
1003 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1004 # Not present otherwise.
1005 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1006 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1007 # set when the operation is created.
1008 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1009 # text format.
1010 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1011 # this field will be populated.
1012 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1013 # operation.
1014 {
1015 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1016 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1017 # details. There is a set of defined message types to use for providing
1018 # details.The syntax depends on the error code. For example,
1019 # QuotaExceededInfo will have details when the error code is
1020 # QUOTA_EXCEEDED.
1021 {
1022 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1023 #
1024 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1025 # is not enabled:
1026 #
1027 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1028 # &quot;domain&quot;: &quot;googleapis.com&quot;
1029 # &quot;metadata&quot;: {
1030 # &quot;resource&quot;: &quot;projects/123&quot;,
1031 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1032 # }
1033 # }
1034 #
1035 # This response indicates that the pubsub.googleapis.com API is not enabled.
1036 #
1037 # Example of an error that is returned when attempting to create a Spanner
1038 # instance in a region that is out of stock:
1039 #
1040 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1041 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1042 # &quot;metadata&quot;: {
1043 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1044 # }
1045 # }
1046 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1047 # is typically the registered service name of the tool or product that
1048 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1049 # generated by some common infrastructure, the error domain must be a
1050 # globally unique value that identifies the infrastructure. For Google API
1051 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1052 &quot;metadatas&quot;: { # Additional structured details about this error.
1053 #
1054 # Keys must match a regular expression of `a-z+` but should
1055 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1056 # length. When identifying the current value of an exceeded limit, the units
1057 # should be contained in the key, not the value. For example, rather than
1058 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1059 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1060 # instances that can be created in a single (batch) request.
1061 &quot;a_key&quot;: &quot;A String&quot;,
1062 },
1063 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1064 # proximate cause of the error. Error reasons are unique within a particular
1065 # domain of errors. This should be at most 63 characters and match a
1066 # regular expression of `A-Z+[A-Z0-9]`, which represents
1067 # UPPER_SNAKE_CASE.
1068 },
1069 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1070 #
1071 # For example, if a quota check failed with an error indicating the calling
1072 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1073 # directly to the right place in the developer console to flip the bit.
1074 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1075 { # Describes a URL link.
1076 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1077 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1078 },
1079 ],
1080 },
1081 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1082 # which can be attached to an RPC error.
1083 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1084 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1085 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1086 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1087 },
1088 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1089 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1090 &quot;a_key&quot;: &quot;A String&quot;,
1091 },
1092 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1093 # type or metric.
1094 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1095 # or metric.
1096 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1097 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1098 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1099 },
1100 },
1101 ],
1102 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1103 # This property is optional.
1104 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1105 },
1106 ],
1107 },
1108 &quot;getVersionOperationMetadata&quot;: {
1109 &quot;inlineSbomInfo&quot;: {
1110 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1111 # appropriate identifiers.
1112 &quot;a_key&quot;: &quot;A String&quot;,
1113 },
1114 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1115 # identifiers.
1116 &quot;a_key&quot;: &quot;A String&quot;,
1117 },
1118 },
1119 },
1120 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1121 # message that was returned, such as `NOT FOUND`.
1122 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1123 # status code that was returned. For example, a `404` means the
1124 # resource was not found.
1125 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1126 # defined by the server.
1127 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1128 # This value is inRFC3339
1129 # text format.
1130 &quot;instancesBulkInsertOperationMetadata&quot;: {
1131 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1132 # Example key: zones/us-central1-a
1133 &quot;a_key&quot;: {
1134 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1135 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1136 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1137 # error.
1138 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1139 # if the flow is rolling forward or rolling back.
1140 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1141 },
1142 },
1143 },
1144 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1145 # Operation resources.
1146 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1147 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1148 # group of operations results from a `bulkInsert` API request.
1149 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1150 # `update`, or `delete`, and so on.
1151 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1152 # There is no requirement that this be linear or support any granularity of
1153 # operations. This should not be used to guess when the operation will be
1154 # complete. This number should monotonically increase as the operation
1155 # progresses.
1156 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1157 # applicable when performing regional operations.
1158 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1159 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1160 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1161 # this field will contain information on all underlying zonal actions and
1162 # their state.
1163 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1164 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1165 # Example key: zones/us-central1-a
1166 &quot;a_key&quot;: {
1167 &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
1168 # populated.
1169 # different programming environments, including REST APIs and RPC APIs. It is
1170 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1171 # three pieces of data: error code, error message, and error details.
1172 #
1173 # You can find out more about this error model and how to work with it in the
1174 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1175 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1176 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1177 # message types for APIs to use.
1178 {
1179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1180 },
1181 ],
1182 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1183 # user-facing error message should be localized and sent in the
1184 # google.rpc.Status.details field, or localized by the client.
1185 },
1186 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1187 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1188 },
1189 },
1190 },
1191 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1192 # This value is inRFC3339
1193 # text format.
1194 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1195 # following:
1196 # `PENDING`, `RUNNING`, or `DONE`.
1197 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1198 # operation.
1199 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1200 # of the target resource.
1201 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1202 # operations related to creating a snapshot, this points to the disk
1203 # that the snapshot was created from.
1204 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1205 # `[email protected]` or
1206 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1207 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1208 # operation, this field will be populated.
1209 {
1210 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1211 # Engine returns NO_RESULTS_ON_PAGE if there
1212 # are no results in the response.
1213 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1214 # value format. For example:
1215 #
1216 # &quot;data&quot;: [
1217 # {
1218 # &quot;key&quot;: &quot;scope&quot;,
1219 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1220 # }
1221 {
1222 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1223 # returned. For example, for warnings where there are no results in a list
1224 # request for a particular zone, this key might be scope and
1225 # the key value might be the zone name. Other examples might be a key
1226 # indicating a deprecated resource and a suggested replacement, or a
1227 # warning about invalid network settings (for example, if an instance
1228 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1229 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1230 },
1231 ],
1232 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1233 },
1234 ],
1235 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1236 # applicable when performing per-zone operations.
1237 }</pre>
1238 </div>
1239
1240 <div class="method">
1241 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1242 <pre>Retrieves a list of VPN gateways available to the specified
1243 project and region.
1244
1245 Args:
1246 project: string, Project ID for this request. (required)
1247 region: string, Name of the region for this request. (required)
1248 filter: string, A filter expression that filters resources listed in the response. Most
1249 Compute resources support two types of filter expressions:
1250 expressions that support regular expressions and expressions that follow
1251 API improvement proposal AIP-160.
1252 These two types of filter expressions cannot be mixed in one request.
1253
1254 If you want to use AIP-160, your expression must specify the field name, an
1255 operator, and the value that you want to use for filtering. The value
1256 must be a string, a number, or a boolean. The operator
1257 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1258
1259 For example, if you are filtering Compute Engine instances, you can
1260 exclude instances named `example-instance` by specifying
1261 `name != example-instance`.
1262
1263 The `:*` comparison can be used to test whether a key has been defined.
1264 For example, to find all objects with `owner` label use:
1265 ```
1266 labels.owner:*
1267 ```
1268
1269 You can also filter nested fields. For example, you could specify
1270 `scheduling.automaticRestart = false` to include instances only
1271 if they are not scheduled for automatic restarts. You can use filtering
1272 on nested fields to filter based onresource labels.
1273
1274 To filter on multiple expressions, provide each separate expression within
1275 parentheses. For example:
1276 ```
1277 (scheduling.automaticRestart = true)
1278 (cpuPlatform = &quot;Intel Skylake&quot;)
1279 ```
1280 By default, each expression is an `AND` expression. However, you
1281 can include `AND` and `OR` expressions explicitly.
1282 For example:
1283 ```
1284 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1285 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1286 (scheduling.automaticRestart = true)
1287 ```
1288
1289 If you want to use a regular expression, use the `eq` (equal) or `ne`
1290 (not equal) operator against a single un-parenthesized expression with or
1291 without quotes or against multiple parenthesized expressions. Examples:
1292
1293 `fieldname eq unquoted literal`
1294 `fieldname eq &#x27;single quoted literal&#x27;`
1295 `fieldname eq &quot;double quoted literal&quot;`
1296 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1297
1298 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1299 The literal value must match the entire field.
1300
1301 For example, to filter for instances that do not end with name &quot;instance&quot;,
1302 you would use `name ne .*instance`.
1303
1304 You cannot combine constraints on multiple fields using regular
1305 expressions.
1306 maxResults: integer, The maximum number of results per page that should be returned.
1307 If the number of available results is larger than `maxResults`,
1308 Compute Engine returns a `nextPageToken` that can be used to get
1309 the next page of results in subsequent list requests. Acceptable values are
1310 `0` to `500`, inclusive. (Default: `500`)
1311 orderBy: string, Sorts list results by a certain order. By default, results
1312 are returned in alphanumerical order based on the resource name.
1313
1314 You can also sort results in descending order based on the creation
1315 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1316 results based on the `creationTimestamp` field in
1317 reverse chronological order (newest result first). Use this to sort
1318 resources like operations so that the newest operation is returned first.
1319
1320 Currently, only sorting by `name` or
1321 `creationTimestamp desc` is supported.
1322 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1323 `nextPageToken` returned by a previous list request to get
1324 the next page of results.
1325 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1326 of failure. The default value is false.
1327
1328 For example, when partial success behavior is enabled, aggregatedList for a
1329 single zone scope either returns all resources in the zone or no resources,
1330 with an error code.
1331 x__xgafv: string, V1 error format.
1332 Allowed values
1333 1 - v1 error format
1334 2 - v2 error format
1335
1336 Returns:
1337 An object of the form:
1338
1339 { # Contains a list of VpnGateway resources.
1340 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1341 &quot;items&quot;: [ # A list of VpnGateway resources.
1342 { # Represents a HA VPN gateway.
1343 #
1344 # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely
1345 # connect your on-premises network to your Google Cloud Virtual Private Cloud
1346 # network through an IPsec VPN connection in a single region.
1347 # For more information about Cloud HA VPN solutions, see
1348 # Cloud VPN topologies .
1349 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1350 # text format.
1351 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1352 # create the resource.
1353 &quot;gatewayIpVersion&quot;: &quot;A String&quot;, # The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
1354 # specified, IPV4 will be used.
1355 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1356 # defined by the server.
1357 &quot;kind&quot;: &quot;compute#vpnGateway&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
1358 # VPN gateways.
1359 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this VpnGateway, which
1360 # is essentially a hash of the labels set used for optimistic locking. The
1361 # fingerprint is initially generated by Compute Engine and changes after
1362 # every request to modify or update labels. You must always provide an
1363 # up-to-date fingerprint hash in order to update or change labels,
1364 # otherwise the request will fail with error412 conditionNotMet.
1365 #
1366 # To see the latest fingerprint, make a get() request to
1367 # retrieve a VpnGateway.
1368 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
1369 # Label values may be empty.
1370 &quot;a_key&quot;: &quot;A String&quot;,
1371 },
1372 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1373 # The name must be 1-63 characters long, and comply withRFC1035.
1374 # Specifically, the name must be 1-63 characters long and match the regular
1375 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1376 # character must be a lowercase letter, and all following characters must
1377 # be a dash, lowercase letter, or digit, except the last character, which
1378 # cannot be a dash.
1379 &quot;network&quot;: &quot;A String&quot;, # URL of the network to which this VPN gateway is attached. Provided by the
1380 # client when the VPN gateway is created.
1381 &quot;params&quot;: { # Input only. [Input Only] Additional params passed with the request, but not persisted
1382 # as part of resource payload.
1383 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1384 # Tag keys and values have the same definition as resource
1385 # manager tags. The field is allowed for INSERT
1386 # only. The keys/values to set on the resource should be specified in
1387 # either ID { : } or Namespaced format
1388 # { : }.
1389 # For example the following are valid inputs:
1390 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1391 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1392 # Note:
1393 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1394 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1395 # * Inconsistent format is not supported. For instance:
1396 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
1397 &quot;a_key&quot;: &quot;A String&quot;,
1398 },
1399 },
1400 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the VPN gateway resides.
1401 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1402 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this VPN gateway to identify the IP protocols that are
1403 # enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6.
1404 &quot;vpnInterfaces&quot;: [ # The list of VPN interfaces associated with this VPN gateway.
1405 { # A VPN gateway interface.
1406 &quot;id&quot;: 42, # Output only. [Output Only] Numeric identifier for this VPN interface associated with
1407 # the VPN gateway.
1408 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # URL of the VLAN attachment (interconnectAttachment) resource for this
1409 # VPN gateway interface. When the value of this field is present, the VPN
1410 # gateway is used for HA VPN over Cloud Interconnect; all egress
1411 # or ingress traffic for this VPN gateway interface goes through the
1412 # specified VLAN attachment resource.
1413 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address for this VPN interface associated with the VPN
1414 # gateway.
1415 # The IP address could be either a regional external IP address or
1416 # a regional internal IP address. The two IP addresses for a VPN gateway
1417 # must be all regional external or regional internal IP addresses. There
1418 # cannot be a mix of regional external IP addresses and regional internal
1419 # IP addresses. For HA VPN over Cloud Interconnect, the IP addresses
1420 # for both interfaces could either be regional internal IP addresses or
1421 # regional external IP addresses. For regular (non HA VPN over Cloud
1422 # Interconnect) HA VPN tunnels, the IP address must be a regional external
1423 # IP address.
1424 &quot;ipv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address for this VPN interface associated with the VPN
1425 # gateway.
1426 # The IPv6 address must be a regional external IPv6 address. The format is
1427 # RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
1428 },
1429 ],
1430 },
1431 ],
1432 &quot;kind&quot;: &quot;compute#vpnGatewayList&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
1433 # VPN gateways.
1434 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1435 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1436 # the query parameter pageToken in the next list request.
1437 # Subsequent list requests will have their own nextPageToken to
1438 # continue paging through the results.
1439 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1440 &quot;warning&quot;: { # [Output Only] Informational warning message.
1441 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1442 # Engine returns NO_RESULTS_ON_PAGE if there
1443 # are no results in the response.
1444 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1445 # value format. For example:
1446 #
1447 # &quot;data&quot;: [
1448 # {
1449 # &quot;key&quot;: &quot;scope&quot;,
1450 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1451 # }
1452 {
1453 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1454 # returned. For example, for warnings where there are no results in a list
1455 # request for a particular zone, this key might be scope and
1456 # the key value might be the zone name. Other examples might be a key
1457 # indicating a deprecated resource and a suggested replacement, or a
1458 # warning about invalid network settings (for example, if an instance
1459 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1460 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1461 },
1462 ],
1463 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1464 },
1465 }</pre>
1466 </div>
1467
1468 <div class="method">
1469 <code class="details" id="list_next">list_next()</code>
1470 <pre>Retrieves the next page of results.
1471
1472 Args:
1473 previous_request: The request for the previous page. (required)
1474 previous_response: The response from the request for the previous page. (required)
1475
1476 Returns:
1477 A request object that you can call &#x27;execute()&#x27; on to request the next
1478 page. Returns None if there are no more items in the collection.
1479 </pre>
1480 </div>
1481
1482 <div class="method">
1483 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code>
1484 <pre>Sets the labels on a VpnGateway. To learn more about labels, read theLabeling
1485 Resources documentation.
1486
1487 Args:
1488 project: string, Project ID for this request. (required)
1489 region: string, The region for this request. (required)
1490 resource: string, Name or id of the resource for this request. (required)
1491 body: object, The request body.
1492 The object takes the form of:
1493
1494 {
1495 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
1496 # used to detect conflicts. The fingerprint is initially generated by Compute
1497 # Engine and changes after every request to modify or update labels. You must
1498 # always provide an up-to-date fingerprint hash in order to update or change
1499 # labels. Make a get() request to the resource to get the latest
1500 # fingerprint.
1501 &quot;labels&quot;: { # The labels to set for this resource.
1502 &quot;a_key&quot;: &quot;A String&quot;,
1503 },
1504 }
1505
1506 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1507 that if you must retry your request, the server will know to ignore the
1508 request if it has already been completed.
1509
1510 For example, consider a situation where you make an initial request and
1511 the request times out. If you make the request again with the same
1512 request ID, the server can check if original operation with the same
1513 request ID was received, and if so, will ignore the second request. This
1514 prevents clients from accidentally creating duplicate commitments.
1515
1516 The request ID must be
1517 a valid UUID with the exception that zero UUID is not supported
1518 (00000000-0000-0000-0000-000000000000).
1519 x__xgafv: string, V1 error format.
1520 Allowed values
1521 1 - v1 error format
1522 2 - v2 error format
1523
1524 Returns:
1525 An object of the form:
1526
1527 { # Represents an Operation resource.
1528 #
1529 # Google Compute Engine has three Operation resources:
1530 #
1531 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1532 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1533 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1534 #
1535 # You can use an operation resource to manage asynchronous API requests.
1536 # For more information, readHandling
1537 # API responses.
1538 #
1539 # Operations can be global, regional or zonal.
1540 #
1541 # - For global operations, use the `globalOperations`
1542 # resource.
1543 # - For regional operations, use the
1544 # `regionOperations` resource.
1545 # - For zonal operations, use
1546 # the `zoneOperations` resource.
1547 #
1548 #
1549 #
1550 # For more information, read
1551 # Global, Regional, and Zonal Resources.
1552 #
1553 # Note that completed Operation resources have a limited
1554 # retention period.
1555 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1556 # Not present otherwise.
1557 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1558 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1559 # set when the operation is created.
1560 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1561 # text format.
1562 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1563 # this field will be populated.
1564 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1565 # operation.
1566 {
1567 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1568 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1569 # details. There is a set of defined message types to use for providing
1570 # details.The syntax depends on the error code. For example,
1571 # QuotaExceededInfo will have details when the error code is
1572 # QUOTA_EXCEEDED.
1573 {
1574 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1575 #
1576 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1577 # is not enabled:
1578 #
1579 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1580 # &quot;domain&quot;: &quot;googleapis.com&quot;
1581 # &quot;metadata&quot;: {
1582 # &quot;resource&quot;: &quot;projects/123&quot;,
1583 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1584 # }
1585 # }
1586 #
1587 # This response indicates that the pubsub.googleapis.com API is not enabled.
1588 #
1589 # Example of an error that is returned when attempting to create a Spanner
1590 # instance in a region that is out of stock:
1591 #
1592 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1593 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1594 # &quot;metadata&quot;: {
1595 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1596 # }
1597 # }
1598 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1599 # is typically the registered service name of the tool or product that
1600 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1601 # generated by some common infrastructure, the error domain must be a
1602 # globally unique value that identifies the infrastructure. For Google API
1603 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1604 &quot;metadatas&quot;: { # Additional structured details about this error.
1605 #
1606 # Keys must match a regular expression of `a-z+` but should
1607 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1608 # length. When identifying the current value of an exceeded limit, the units
1609 # should be contained in the key, not the value. For example, rather than
1610 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1611 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1612 # instances that can be created in a single (batch) request.
1613 &quot;a_key&quot;: &quot;A String&quot;,
1614 },
1615 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1616 # proximate cause of the error. Error reasons are unique within a particular
1617 # domain of errors. This should be at most 63 characters and match a
1618 # regular expression of `A-Z+[A-Z0-9]`, which represents
1619 # UPPER_SNAKE_CASE.
1620 },
1621 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1622 #
1623 # For example, if a quota check failed with an error indicating the calling
1624 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1625 # directly to the right place in the developer console to flip the bit.
1626 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1627 { # Describes a URL link.
1628 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1629 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1630 },
1631 ],
1632 },
1633 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1634 # which can be attached to an RPC error.
1635 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1636 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1637 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1638 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1639 },
1640 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1641 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1642 &quot;a_key&quot;: &quot;A String&quot;,
1643 },
1644 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1645 # type or metric.
1646 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1647 # or metric.
1648 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1649 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1650 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1651 },
1652 },
1653 ],
1654 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1655 # This property is optional.
1656 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1657 },
1658 ],
1659 },
1660 &quot;getVersionOperationMetadata&quot;: {
1661 &quot;inlineSbomInfo&quot;: {
1662 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1663 # appropriate identifiers.
1664 &quot;a_key&quot;: &quot;A String&quot;,
1665 },
1666 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1667 # identifiers.
1668 &quot;a_key&quot;: &quot;A String&quot;,
1669 },
1670 },
1671 },
1672 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1673 # message that was returned, such as `NOT FOUND`.
1674 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1675 # status code that was returned. For example, a `404` means the
1676 # resource was not found.
1677 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1678 # defined by the server.
1679 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1680 # This value is inRFC3339
1681 # text format.
1682 &quot;instancesBulkInsertOperationMetadata&quot;: {
1683 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1684 # Example key: zones/us-central1-a
1685 &quot;a_key&quot;: {
1686 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1687 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1688 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1689 # error.
1690 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1691 # if the flow is rolling forward or rolling back.
1692 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1693 },
1694 },
1695 },
1696 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1697 # Operation resources.
1698 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1699 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1700 # group of operations results from a `bulkInsert` API request.
1701 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1702 # `update`, or `delete`, and so on.
1703 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1704 # There is no requirement that this be linear or support any granularity of
1705 # operations. This should not be used to guess when the operation will be
1706 # complete. This number should monotonically increase as the operation
1707 # progresses.
1708 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1709 # applicable when performing regional operations.
1710 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1711 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1712 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1713 # this field will contain information on all underlying zonal actions and
1714 # their state.
1715 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1716 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1717 # Example key: zones/us-central1-a
1718 &quot;a_key&quot;: {
1719 &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
1720 # populated.
1721 # different programming environments, including REST APIs and RPC APIs. It is
1722 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1723 # three pieces of data: error code, error message, and error details.
1724 #
1725 # You can find out more about this error model and how to work with it in the
1726 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1727 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1728 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1729 # message types for APIs to use.
1730 {
1731 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1732 },
1733 ],
1734 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1735 # user-facing error message should be localized and sent in the
1736 # google.rpc.Status.details field, or localized by the client.
1737 },
1738 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1739 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1740 },
1741 },
1742 },
1743 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1744 # This value is inRFC3339
1745 # text format.
1746 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1747 # following:
1748 # `PENDING`, `RUNNING`, or `DONE`.
1749 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1750 # operation.
1751 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1752 # of the target resource.
1753 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1754 # operations related to creating a snapshot, this points to the disk
1755 # that the snapshot was created from.
1756 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1757 # `[email protected]` or
1758 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1759 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1760 # operation, this field will be populated.
1761 {
1762 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1763 # Engine returns NO_RESULTS_ON_PAGE if there
1764 # are no results in the response.
1765 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1766 # value format. For example:
1767 #
1768 # &quot;data&quot;: [
1769 # {
1770 # &quot;key&quot;: &quot;scope&quot;,
1771 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1772 # }
1773 {
1774 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1775 # returned. For example, for warnings where there are no results in a list
1776 # request for a particular zone, this key might be scope and
1777 # the key value might be the zone name. Other examples might be a key
1778 # indicating a deprecated resource and a suggested replacement, or a
1779 # warning about invalid network settings (for example, if an instance
1780 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1781 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1782 },
1783 ],
1784 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1785 },
1786 ],
1787 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1788 # applicable when performing per-zone operations.
1789 }</pre>
1790 </div>
1791
1792 <div class="method">
1793 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
1794 <pre>Returns permissions that a caller has on the specified resource.
1795
1796 Args:
1797 project: string, Project ID for this request. (required)
1798 region: string, The name of the region for this request. (required)
1799 resource: string, Name or id of the resource for this request. (required)
1800 body: object, The request body.
1801 The object takes the form of:
1802
1803 {
1804 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
1805 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1806 &quot;A String&quot;,
1807 ],
1808 }
1809
1810 x__xgafv: string, V1 error format.
1811 Allowed values
1812 1 - v1 error format
1813 2 - v2 error format
1814
1815 Returns:
1816 An object of the form:
1817
1818 {
1819 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1820 # allowed.
1821 &quot;A String&quot;,
1822 ],
1823 }</pre>
1824 </div>
1825
1826 </body></html>