Debian Codegraph @

docs/dyn/compute_beta.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_beta.html">Compute Engine API</a> . <a href="compute_beta.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/beta/globalOperations)
435 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
436 # * [Zonal](/compute/docs/reference/rest/beta/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;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
615 # this field will contain information on all underlying zonal actions and
616 # their state.
617 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
618 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
619 # Example key: zones/us-central1-a
620 &quot;a_key&quot;: {
621 &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
622 # populated.
623 # different programming environments, including REST APIs and RPC APIs. It is
624 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
625 # three pieces of data: error code, error message, and error details.
626 #
627 # You can find out more about this error model and how to work with it in the
628 # [API Design Guide](https://cloud.google.com/apis/design/errors).
629 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
630 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
631 # message types for APIs to use.
632 {
633 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
634 },
635 ],
636 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
637 # user-facing error message should be localized and sent in the
638 # google.rpc.Status.details field, or localized by the client.
639 },
640 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
641 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
642 },
643 },
644 },
645 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
646 # This value is inRFC3339
647 # text format.
648 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
649 # following:
650 # `PENDING`, `RUNNING`, or `DONE`.
651 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
652 # operation.
653 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
654 # of the target resource.
655 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
656 # operations related to creating a snapshot, this points to the disk
657 # that the snapshot was created from.
658 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
659 # `[email protected]` or
660 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
661 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
662 # operation, this field will be populated.
663 {
664 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
665 # Engine returns NO_RESULTS_ON_PAGE if there
666 # are no results in the response.
667 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
668 # value format. For example:
669 #
670 # &quot;data&quot;: [
671 # {
672 # &quot;key&quot;: &quot;scope&quot;,
673 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
674 # }
675 {
676 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
677 # returned. For example, for warnings where there are no results in a list
678 # request for a particular zone, this key might be scope and
679 # the key value might be the zone name. Other examples might be a key
680 # indicating a deprecated resource and a suggested replacement, or a
681 # warning about invalid network settings (for example, if an instance
682 # attempts to perform IP forwarding but is not enabled for IP forwarding).
683 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
684 },
685 ],
686 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
687 },
688 ],
689 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
690 # applicable when performing per-zone operations.
691 }</pre>
692 </div>
693
694 <div class="method">
695 <code class="details" id="get">get(project, region, vpnGateway, x__xgafv=None)</code>
696 <pre>Returns the specified VPN gateway.
697
698 Args:
699 project: string, Project ID for this request. (required)
700 region: string, Name of the region for this request. (required)
701 vpnGateway: string, Name of the VPN gateway to return. (required)
702 x__xgafv: string, V1 error format.
703 Allowed values
704 1 - v1 error format
705 2 - v2 error format
706
707 Returns:
708 An object of the form:
709
710 { # Represents a HA VPN gateway.
711 #
712 # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely
713 # connect your on-premises network to your Google Cloud Virtual Private Cloud
714 # network through an IPsec VPN connection in a single region.
715 # For more information about Cloud HA VPN solutions, see
716 # Cloud VPN topologies .
717 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
718 # text format.
719 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
720 # create the resource.
721 &quot;gatewayIpVersion&quot;: &quot;A String&quot;, # The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
722 # specified, IPV4 will be used.
723 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
724 # defined by the server.
725 &quot;kind&quot;: &quot;compute#vpnGateway&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
726 # VPN gateways.
727 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this VpnGateway, which
728 # is essentially a hash of the labels set used for optimistic locking. The
729 # fingerprint is initially generated by Compute Engine and changes after
730 # every request to modify or update labels. You must always provide an
731 # up-to-date fingerprint hash in order to update or change labels,
732 # otherwise the request will fail with error412 conditionNotMet.
733 #
734 # To see the latest fingerprint, make a get() request to
735 # retrieve a VpnGateway.
736 &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.
737 # Label values may be empty.
738 &quot;a_key&quot;: &quot;A String&quot;,
739 },
740 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
741 # The name must be 1-63 characters long, and comply withRFC1035.
742 # Specifically, the name must be 1-63 characters long and match the regular
743 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
744 # character must be a lowercase letter, and all following characters must
745 # be a dash, lowercase letter, or digit, except the last character, which
746 # cannot be a dash.
747 &quot;network&quot;: &quot;A String&quot;, # URL of the network to which this VPN gateway is attached. Provided by the
748 # client when the VPN gateway is created.
749 &quot;params&quot;: { # Input only. [Input Only] Additional params passed with the request, but not persisted
750 # as part of resource payload.
751 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
752 # Tag keys and values have the same definition as resource
753 # manager tags. The field is allowed for INSERT
754 # only. The keys/values to set on the resource should be specified in
755 # either ID { : } or Namespaced format
756 # { : }.
757 # For example the following are valid inputs:
758 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
759 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
760 # Note:
761 # * Invalid combinations of ID &amp; namespaced format is not supported. For
762 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
763 # * Inconsistent format is not supported. For instance:
764 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
765 &quot;a_key&quot;: &quot;A String&quot;,
766 },
767 },
768 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the VPN gateway resides.
769 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
770 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this VPN gateway to identify the IP protocols that are
771 # 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.
772 &quot;vpnInterfaces&quot;: [ # The list of VPN interfaces associated with this VPN gateway.
773 { # A VPN gateway interface.
774 &quot;id&quot;: 42, # Output only. [Output Only] Numeric identifier for this VPN interface associated with
775 # the VPN gateway.
776 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # URL of the VLAN attachment (interconnectAttachment) resource for this
777 # VPN gateway interface. When the value of this field is present, the VPN
778 # gateway is used for HA VPN over Cloud Interconnect; all egress
779 # or ingress traffic for this VPN gateway interface goes through the
780 # specified VLAN attachment resource.
781 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address for this VPN interface associated with the VPN
782 # gateway.
783 # The IP address could be either a regional external IP address or
784 # a regional internal IP address. The two IP addresses for a VPN gateway
785 # must be all regional external or regional internal IP addresses. There
786 # cannot be a mix of regional external IP addresses and regional internal
787 # IP addresses. For HA VPN over Cloud Interconnect, the IP addresses
788 # for both interfaces could either be regional internal IP addresses or
789 # regional external IP addresses. For regular (non HA VPN over Cloud
790 # Interconnect) HA VPN tunnels, the IP address must be a regional external
791 # IP address.
792 &quot;ipv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address for this VPN interface associated with the VPN
793 # gateway.
794 # The IPv6 address must be a regional external IPv6 address. The format is
795 # RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
796 },
797 ],
798 }</pre>
799 </div>
800
801 <div class="method">
802 <code class="details" id="getStatus">getStatus(project, region, vpnGateway, x__xgafv=None)</code>
803 <pre>Returns the status for the specified VPN gateway.
804
805 Args:
806 project: string, Project ID for this request. (required)
807 region: string, Name of the region for this request. (required)
808 vpnGateway: string, Name of the VPN gateway to return. (required)
809 x__xgafv: string, V1 error format.
810 Allowed values
811 1 - v1 error format
812 2 - v2 error format
813
814 Returns:
815 An object of the form:
816
817 {
818 &quot;result&quot;: {
819 &quot;vpnConnections&quot;: [ # Output only. List of VPN connection for this VpnGateway.
820 { # A VPN connection contains all VPN tunnels connected from this VpnGateway
821 # to the same peer gateway. The peer gateway could either be an external VPN
822 # gateway or a Google Cloud VPN gateway.
823 &quot;peerExternalGateway&quot;: &quot;A String&quot;, # Output only. URL reference to the peer external VPN gateways to which the VPN tunnels
824 # in this VPN connection are connected.
825 # This field is mutually exclusive with peer_gcp_gateway.
826 &quot;peerGcpGateway&quot;: &quot;A String&quot;, # Output only. URL reference to the peer side VPN gateways to which the VPN tunnels in
827 # this VPN connection are connected.
828 # This field is mutually exclusive with peer_gcp_gateway.
829 &quot;state&quot;: { # Describes the high availability requirement state for the VPN connection # HighAvailabilityRequirementState for the VPN connection.
830 # between this Cloud VPN gateway and a peer gateway.
831 &quot;state&quot;: &quot;A String&quot;, # Indicates the high availability requirement state for the VPN connection.
832 # Valid values are CONNECTION_REDUNDANCY_MET,CONNECTION_REDUNDANCY_NOT_MET.
833 &quot;unsatisfiedReason&quot;: &quot;A String&quot;, # Indicates the reason why the VPN connection does not meet the high
834 # availability redundancy criteria/requirement.
835 # Valid values is INCOMPLETE_TUNNELS_COVERAGE.
836 },
837 &quot;tunnels&quot;: [ # List of VPN tunnels that are in this VPN connection.
838 { # Contains some information about a VPN tunnel.
839 &quot;localGatewayInterface&quot;: 42, # Output only. The VPN gateway interface this VPN tunnel is associated with.
840 &quot;peerGatewayInterface&quot;: 42, # Output only. The peer gateway interface this VPN tunnel is connected to, the peer
841 # gateway could either be an external VPN gateway or a Google Cloud
842 # VPN gateway.
843 &quot;tunnelUrl&quot;: &quot;A String&quot;, # Output only. URL reference to the VPN tunnel.
844 },
845 ],
846 },
847 ],
848 },
849 }</pre>
850 </div>
851
852 <div class="method">
853 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
854 <pre>Creates a VPN gateway in the specified project and region using
855 the data included in the request.
856
857 Args:
858 project: string, Project ID for this request. (required)
859 region: string, Name of the region for this request. (required)
860 body: object, The request body.
861 The object takes the form of:
862
863 { # Represents a HA VPN gateway.
864 #
865 # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely
866 # connect your on-premises network to your Google Cloud Virtual Private Cloud
867 # network through an IPsec VPN connection in a single region.
868 # For more information about Cloud HA VPN solutions, see
869 # Cloud VPN topologies .
870 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
871 # text format.
872 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
873 # create the resource.
874 &quot;gatewayIpVersion&quot;: &quot;A String&quot;, # The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
875 # specified, IPV4 will be used.
876 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
877 # defined by the server.
878 &quot;kind&quot;: &quot;compute#vpnGateway&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
879 # VPN gateways.
880 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this VpnGateway, which
881 # is essentially a hash of the labels set used for optimistic locking. The
882 # fingerprint is initially generated by Compute Engine and changes after
883 # every request to modify or update labels. You must always provide an
884 # up-to-date fingerprint hash in order to update or change labels,
885 # otherwise the request will fail with error412 conditionNotMet.
886 #
887 # To see the latest fingerprint, make a get() request to
888 # retrieve a VpnGateway.
889 &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.
890 # Label values may be empty.
891 &quot;a_key&quot;: &quot;A String&quot;,
892 },
893 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
894 # The name must be 1-63 characters long, and comply withRFC1035.
895 # Specifically, the name must be 1-63 characters long and match the regular
896 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
897 # character must be a lowercase letter, and all following characters must
898 # be a dash, lowercase letter, or digit, except the last character, which
899 # cannot be a dash.
900 &quot;network&quot;: &quot;A String&quot;, # URL of the network to which this VPN gateway is attached. Provided by the
901 # client when the VPN gateway is created.
902 &quot;params&quot;: { # Input only. [Input Only] Additional params passed with the request, but not persisted
903 # as part of resource payload.
904 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
905 # Tag keys and values have the same definition as resource
906 # manager tags. The field is allowed for INSERT
907 # only. The keys/values to set on the resource should be specified in
908 # either ID { : } or Namespaced format
909 # { : }.
910 # For example the following are valid inputs:
911 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
912 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
913 # Note:
914 # * Invalid combinations of ID &amp; namespaced format is not supported. For
915 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
916 # * Inconsistent format is not supported. For instance:
917 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
918 &quot;a_key&quot;: &quot;A String&quot;,
919 },
920 },
921 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the VPN gateway resides.
922 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
923 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this VPN gateway to identify the IP protocols that are
924 # 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.
925 &quot;vpnInterfaces&quot;: [ # The list of VPN interfaces associated with this VPN gateway.
926 { # A VPN gateway interface.
927 &quot;id&quot;: 42, # Output only. [Output Only] Numeric identifier for this VPN interface associated with
928 # the VPN gateway.
929 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # URL of the VLAN attachment (interconnectAttachment) resource for this
930 # VPN gateway interface. When the value of this field is present, the VPN
931 # gateway is used for HA VPN over Cloud Interconnect; all egress
932 # or ingress traffic for this VPN gateway interface goes through the
933 # specified VLAN attachment resource.
934 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address for this VPN interface associated with the VPN
935 # gateway.
936 # The IP address could be either a regional external IP address or
937 # a regional internal IP address. The two IP addresses for a VPN gateway
938 # must be all regional external or regional internal IP addresses. There
939 # cannot be a mix of regional external IP addresses and regional internal
940 # IP addresses. For HA VPN over Cloud Interconnect, the IP addresses
941 # for both interfaces could either be regional internal IP addresses or
942 # regional external IP addresses. For regular (non HA VPN over Cloud
943 # Interconnect) HA VPN tunnels, the IP address must be a regional external
944 # IP address.
945 &quot;ipv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address for this VPN interface associated with the VPN
946 # gateway.
947 # The IPv6 address must be a regional external IPv6 address. The format is
948 # RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
949 },
950 ],
951 }
952
953 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
954 that if you must retry your request, the server will know to ignore the
955 request if it has already been completed.
956
957 For example, consider a situation where you make an initial request and
958 the request times out. If you make the request again with the same
959 request ID, the server can check if original operation with the same
960 request ID was received, and if so, will ignore the second request. This
961 prevents clients from accidentally creating duplicate commitments.
962
963 The request ID must be
964 a valid UUID with the exception that zero UUID is not supported
965 (00000000-0000-0000-0000-000000000000).
966 x__xgafv: string, V1 error format.
967 Allowed values
968 1 - v1 error format
969 2 - v2 error format
970
971 Returns:
972 An object of the form:
973
974 { # Represents an Operation resource.
975 #
976 # Google Compute Engine has three Operation resources:
977 #
978 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
979 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
980 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
981 #
982 # You can use an operation resource to manage asynchronous API requests.
983 # For more information, readHandling
984 # API responses.
985 #
986 # Operations can be global, regional or zonal.
987 #
988 # - For global operations, use the `globalOperations`
989 # resource.
990 # - For regional operations, use the
991 # `regionOperations` resource.
992 # - For zonal operations, use
993 # the `zoneOperations` resource.
994 #
995 #
996 #
997 # For more information, read
998 # Global, Regional, and Zonal Resources.
999 #
1000 # Note that completed Operation resources have a limited
1001 # retention period.
1002 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1003 # Not present otherwise.
1004 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1005 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1006 # set when the operation is created.
1007 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1008 # text format.
1009 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1010 # this field will be populated.
1011 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1012 # operation.
1013 {
1014 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1015 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1016 # details. There is a set of defined message types to use for providing
1017 # details.The syntax depends on the error code. For example,
1018 # QuotaExceededInfo will have details when the error code is
1019 # QUOTA_EXCEEDED.
1020 {
1021 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1022 #
1023 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1024 # is not enabled:
1025 #
1026 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1027 # &quot;domain&quot;: &quot;googleapis.com&quot;
1028 # &quot;metadata&quot;: {
1029 # &quot;resource&quot;: &quot;projects/123&quot;,
1030 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1031 # }
1032 # }
1033 #
1034 # This response indicates that the pubsub.googleapis.com API is not enabled.
1035 #
1036 # Example of an error that is returned when attempting to create a Spanner
1037 # instance in a region that is out of stock:
1038 #
1039 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1040 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1041 # &quot;metadata&quot;: {
1042 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1043 # }
1044 # }
1045 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1046 # is typically the registered service name of the tool or product that
1047 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1048 # generated by some common infrastructure, the error domain must be a
1049 # globally unique value that identifies the infrastructure. For Google API
1050 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1051 &quot;metadatas&quot;: { # Additional structured details about this error.
1052 #
1053 # Keys must match a regular expression of `a-z+` but should
1054 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1055 # length. When identifying the current value of an exceeded limit, the units
1056 # should be contained in the key, not the value. For example, rather than
1057 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1058 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1059 # instances that can be created in a single (batch) request.
1060 &quot;a_key&quot;: &quot;A String&quot;,
1061 },
1062 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1063 # proximate cause of the error. Error reasons are unique within a particular
1064 # domain of errors. This should be at most 63 characters and match a
1065 # regular expression of `A-Z+[A-Z0-9]`, which represents
1066 # UPPER_SNAKE_CASE.
1067 },
1068 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1069 #
1070 # For example, if a quota check failed with an error indicating the calling
1071 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1072 # directly to the right place in the developer console to flip the bit.
1073 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1074 { # Describes a URL link.
1075 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1076 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1077 },
1078 ],
1079 },
1080 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1081 # which can be attached to an RPC error.
1082 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1083 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1084 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1085 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1086 },
1087 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1088 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1089 &quot;a_key&quot;: &quot;A String&quot;,
1090 },
1091 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1092 # type or metric.
1093 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1094 # or metric.
1095 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1096 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1097 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1098 },
1099 },
1100 ],
1101 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1102 # This property is optional.
1103 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1104 },
1105 ],
1106 },
1107 &quot;getVersionOperationMetadata&quot;: {
1108 &quot;inlineSbomInfo&quot;: {
1109 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1110 # appropriate identifiers.
1111 &quot;a_key&quot;: &quot;A String&quot;,
1112 },
1113 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1114 # identifiers.
1115 &quot;a_key&quot;: &quot;A String&quot;,
1116 },
1117 },
1118 },
1119 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1120 # message that was returned, such as `NOT FOUND`.
1121 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1122 # status code that was returned. For example, a `404` means the
1123 # resource was not found.
1124 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1125 # defined by the server.
1126 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1127 # This value is inRFC3339
1128 # text format.
1129 &quot;instancesBulkInsertOperationMetadata&quot;: {
1130 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1131 # Example key: zones/us-central1-a
1132 &quot;a_key&quot;: {
1133 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1134 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1135 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1136 # error.
1137 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1138 # if the flow is rolling forward or rolling back.
1139 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1140 },
1141 },
1142 },
1143 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1144 # Operation resources.
1145 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1146 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1147 # group of operations results from a `bulkInsert` API request.
1148 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1149 # `update`, or `delete`, and so on.
1150 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1151 # There is no requirement that this be linear or support any granularity of
1152 # operations. This should not be used to guess when the operation will be
1153 # complete. This number should monotonically increase as the operation
1154 # progresses.
1155 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1156 # applicable when performing regional operations.
1157 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1158 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1159 # this field will contain information on all underlying zonal actions and
1160 # their state.
1161 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1162 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1163 # Example key: zones/us-central1-a
1164 &quot;a_key&quot;: {
1165 &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
1166 # populated.
1167 # different programming environments, including REST APIs and RPC APIs. It is
1168 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1169 # three pieces of data: error code, error message, and error details.
1170 #
1171 # You can find out more about this error model and how to work with it in the
1172 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1173 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1174 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1175 # message types for APIs to use.
1176 {
1177 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1178 },
1179 ],
1180 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1181 # user-facing error message should be localized and sent in the
1182 # google.rpc.Status.details field, or localized by the client.
1183 },
1184 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1185 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1186 },
1187 },
1188 },
1189 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1190 # This value is inRFC3339
1191 # text format.
1192 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1193 # following:
1194 # `PENDING`, `RUNNING`, or `DONE`.
1195 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1196 # operation.
1197 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1198 # of the target resource.
1199 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1200 # operations related to creating a snapshot, this points to the disk
1201 # that the snapshot was created from.
1202 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1203 # `[email protected]` or
1204 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1205 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1206 # operation, this field will be populated.
1207 {
1208 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1209 # Engine returns NO_RESULTS_ON_PAGE if there
1210 # are no results in the response.
1211 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1212 # value format. For example:
1213 #
1214 # &quot;data&quot;: [
1215 # {
1216 # &quot;key&quot;: &quot;scope&quot;,
1217 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1218 # }
1219 {
1220 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1221 # returned. For example, for warnings where there are no results in a list
1222 # request for a particular zone, this key might be scope and
1223 # the key value might be the zone name. Other examples might be a key
1224 # indicating a deprecated resource and a suggested replacement, or a
1225 # warning about invalid network settings (for example, if an instance
1226 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1227 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1228 },
1229 ],
1230 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1231 },
1232 ],
1233 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1234 # applicable when performing per-zone operations.
1235 }</pre>
1236 </div>
1237
1238 <div class="method">
1239 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1240 <pre>Retrieves a list of VPN gateways available to the specified
1241 project and region.
1242
1243 Args:
1244 project: string, Project ID for this request. (required)
1245 region: string, Name of the region for this request. (required)
1246 filter: string, A filter expression that filters resources listed in the response. Most
1247 Compute resources support two types of filter expressions:
1248 expressions that support regular expressions and expressions that follow
1249 API improvement proposal AIP-160.
1250 These two types of filter expressions cannot be mixed in one request.
1251
1252 If you want to use AIP-160, your expression must specify the field name, an
1253 operator, and the value that you want to use for filtering. The value
1254 must be a string, a number, or a boolean. The operator
1255 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1256
1257 For example, if you are filtering Compute Engine instances, you can
1258 exclude instances named `example-instance` by specifying
1259 `name != example-instance`.
1260
1261 The `:*` comparison can be used to test whether a key has been defined.
1262 For example, to find all objects with `owner` label use:
1263 ```
1264 labels.owner:*
1265 ```
1266
1267 You can also filter nested fields. For example, you could specify
1268 `scheduling.automaticRestart = false` to include instances only
1269 if they are not scheduled for automatic restarts. You can use filtering
1270 on nested fields to filter based onresource labels.
1271
1272 To filter on multiple expressions, provide each separate expression within
1273 parentheses. For example:
1274 ```
1275 (scheduling.automaticRestart = true)
1276 (cpuPlatform = &quot;Intel Skylake&quot;)
1277 ```
1278 By default, each expression is an `AND` expression. However, you
1279 can include `AND` and `OR` expressions explicitly.
1280 For example:
1281 ```
1282 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1283 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1284 (scheduling.automaticRestart = true)
1285 ```
1286
1287 If you want to use a regular expression, use the `eq` (equal) or `ne`
1288 (not equal) operator against a single un-parenthesized expression with or
1289 without quotes or against multiple parenthesized expressions. Examples:
1290
1291 `fieldname eq unquoted literal`
1292 `fieldname eq &#x27;single quoted literal&#x27;`
1293 `fieldname eq &quot;double quoted literal&quot;`
1294 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1295
1296 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1297 The literal value must match the entire field.
1298
1299 For example, to filter for instances that do not end with name &quot;instance&quot;,
1300 you would use `name ne .*instance`.
1301
1302 You cannot combine constraints on multiple fields using regular
1303 expressions.
1304 maxResults: integer, The maximum number of results per page that should be returned.
1305 If the number of available results is larger than `maxResults`,
1306 Compute Engine returns a `nextPageToken` that can be used to get
1307 the next page of results in subsequent list requests. Acceptable values are
1308 `0` to `500`, inclusive. (Default: `500`)
1309 orderBy: string, Sorts list results by a certain order. By default, results
1310 are returned in alphanumerical order based on the resource name.
1311
1312 You can also sort results in descending order based on the creation
1313 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1314 results based on the `creationTimestamp` field in
1315 reverse chronological order (newest result first). Use this to sort
1316 resources like operations so that the newest operation is returned first.
1317
1318 Currently, only sorting by `name` or
1319 `creationTimestamp desc` is supported.
1320 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1321 `nextPageToken` returned by a previous list request to get
1322 the next page of results.
1323 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1324 of failure. The default value is false.
1325
1326 For example, when partial success behavior is enabled, aggregatedList for a
1327 single zone scope either returns all resources in the zone or no resources,
1328 with an error code.
1329 x__xgafv: string, V1 error format.
1330 Allowed values
1331 1 - v1 error format
1332 2 - v2 error format
1333
1334 Returns:
1335 An object of the form:
1336
1337 { # Contains a list of VpnGateway resources.
1338 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1339 &quot;items&quot;: [ # A list of VpnGateway resources.
1340 { # Represents a HA VPN gateway.
1341 #
1342 # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely
1343 # connect your on-premises network to your Google Cloud Virtual Private Cloud
1344 # network through an IPsec VPN connection in a single region.
1345 # For more information about Cloud HA VPN solutions, see
1346 # Cloud VPN topologies .
1347 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1348 # text format.
1349 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1350 # create the resource.
1351 &quot;gatewayIpVersion&quot;: &quot;A String&quot;, # The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not
1352 # specified, IPV4 will be used.
1353 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1354 # defined by the server.
1355 &quot;kind&quot;: &quot;compute#vpnGateway&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
1356 # VPN gateways.
1357 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this VpnGateway, which
1358 # is essentially a hash of the labels set used for optimistic locking. The
1359 # fingerprint is initially generated by Compute Engine and changes after
1360 # every request to modify or update labels. You must always provide an
1361 # up-to-date fingerprint hash in order to update or change labels,
1362 # otherwise the request will fail with error412 conditionNotMet.
1363 #
1364 # To see the latest fingerprint, make a get() request to
1365 # retrieve a VpnGateway.
1366 &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.
1367 # Label values may be empty.
1368 &quot;a_key&quot;: &quot;A String&quot;,
1369 },
1370 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1371 # The name must be 1-63 characters long, and comply withRFC1035.
1372 # Specifically, the name must be 1-63 characters long and match the regular
1373 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1374 # character must be a lowercase letter, and all following characters must
1375 # be a dash, lowercase letter, or digit, except the last character, which
1376 # cannot be a dash.
1377 &quot;network&quot;: &quot;A String&quot;, # URL of the network to which this VPN gateway is attached. Provided by the
1378 # client when the VPN gateway is created.
1379 &quot;params&quot;: { # Input only. [Input Only] Additional params passed with the request, but not persisted
1380 # as part of resource payload.
1381 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1382 # Tag keys and values have the same definition as resource
1383 # manager tags. The field is allowed for INSERT
1384 # only. The keys/values to set on the resource should be specified in
1385 # either ID { : } or Namespaced format
1386 # { : }.
1387 # For example the following are valid inputs:
1388 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1389 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1390 # Note:
1391 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1392 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1393 # * Inconsistent format is not supported. For instance:
1394 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
1395 &quot;a_key&quot;: &quot;A String&quot;,
1396 },
1397 },
1398 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the VPN gateway resides.
1399 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1400 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this VPN gateway to identify the IP protocols that are
1401 # 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.
1402 &quot;vpnInterfaces&quot;: [ # The list of VPN interfaces associated with this VPN gateway.
1403 { # A VPN gateway interface.
1404 &quot;id&quot;: 42, # Output only. [Output Only] Numeric identifier for this VPN interface associated with
1405 # the VPN gateway.
1406 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # URL of the VLAN attachment (interconnectAttachment) resource for this
1407 # VPN gateway interface. When the value of this field is present, the VPN
1408 # gateway is used for HA VPN over Cloud Interconnect; all egress
1409 # or ingress traffic for this VPN gateway interface goes through the
1410 # specified VLAN attachment resource.
1411 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address for this VPN interface associated with the VPN
1412 # gateway.
1413 # The IP address could be either a regional external IP address or
1414 # a regional internal IP address. The two IP addresses for a VPN gateway
1415 # must be all regional external or regional internal IP addresses. There
1416 # cannot be a mix of regional external IP addresses and regional internal
1417 # IP addresses. For HA VPN over Cloud Interconnect, the IP addresses
1418 # for both interfaces could either be regional internal IP addresses or
1419 # regional external IP addresses. For regular (non HA VPN over Cloud
1420 # Interconnect) HA VPN tunnels, the IP address must be a regional external
1421 # IP address.
1422 &quot;ipv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address for this VPN interface associated with the VPN
1423 # gateway.
1424 # The IPv6 address must be a regional external IPv6 address. The format is
1425 # RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
1426 },
1427 ],
1428 },
1429 ],
1430 &quot;kind&quot;: &quot;compute#vpnGatewayList&quot;, # Output only. [Output Only] Type of resource. Always compute#vpnGateway for
1431 # VPN gateways.
1432 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1433 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1434 # the query parameter pageToken in the next list request.
1435 # Subsequent list requests will have their own nextPageToken to
1436 # continue paging through the results.
1437 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1438 &quot;warning&quot;: { # [Output Only] Informational warning message.
1439 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1440 # Engine returns NO_RESULTS_ON_PAGE if there
1441 # are no results in the response.
1442 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1443 # value format. For example:
1444 #
1445 # &quot;data&quot;: [
1446 # {
1447 # &quot;key&quot;: &quot;scope&quot;,
1448 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1449 # }
1450 {
1451 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1452 # returned. For example, for warnings where there are no results in a list
1453 # request for a particular zone, this key might be scope and
1454 # the key value might be the zone name. Other examples might be a key
1455 # indicating a deprecated resource and a suggested replacement, or a
1456 # warning about invalid network settings (for example, if an instance
1457 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1458 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1459 },
1460 ],
1461 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1462 },
1463 }</pre>
1464 </div>
1465
1466 <div class="method">
1467 <code class="details" id="list_next">list_next()</code>
1468 <pre>Retrieves the next page of results.
1469
1470 Args:
1471 previous_request: The request for the previous page. (required)
1472 previous_response: The response from the request for the previous page. (required)
1473
1474 Returns:
1475 A request object that you can call &#x27;execute()&#x27; on to request the next
1476 page. Returns None if there are no more items in the collection.
1477 </pre>
1478 </div>
1479
1480 <div class="method">
1481 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code>
1482 <pre>Sets the labels on a VpnGateway. To learn more about labels, read theLabeling
1483 Resources documentation.
1484
1485 Args:
1486 project: string, Project ID for this request. (required)
1487 region: string, The region for this request. (required)
1488 resource: string, Name or id of the resource for this request. (required)
1489 body: object, The request body.
1490 The object takes the form of:
1491
1492 {
1493 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
1494 # used to detect conflicts. The fingerprint is initially generated by Compute
1495 # Engine and changes after every request to modify or update labels. You must
1496 # always provide an up-to-date fingerprint hash in order to update or change
1497 # labels. Make a get() request to the resource to get the latest
1498 # fingerprint.
1499 &quot;labels&quot;: { # The labels to set for this resource.
1500 &quot;a_key&quot;: &quot;A String&quot;,
1501 },
1502 }
1503
1504 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1505 that if you must retry your request, the server will know to ignore the
1506 request if it has already been completed.
1507
1508 For example, consider a situation where you make an initial request and
1509 the request times out. If you make the request again with the same
1510 request ID, the server can check if original operation with the same
1511 request ID was received, and if so, will ignore the second request. This
1512 prevents clients from accidentally creating duplicate commitments.
1513
1514 The request ID must be
1515 a valid UUID with the exception that zero UUID is not supported
1516 (00000000-0000-0000-0000-000000000000).
1517 x__xgafv: string, V1 error format.
1518 Allowed values
1519 1 - v1 error format
1520 2 - v2 error format
1521
1522 Returns:
1523 An object of the form:
1524
1525 { # Represents an Operation resource.
1526 #
1527 # Google Compute Engine has three Operation resources:
1528 #
1529 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1530 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1531 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1532 #
1533 # You can use an operation resource to manage asynchronous API requests.
1534 # For more information, readHandling
1535 # API responses.
1536 #
1537 # Operations can be global, regional or zonal.
1538 #
1539 # - For global operations, use the `globalOperations`
1540 # resource.
1541 # - For regional operations, use the
1542 # `regionOperations` resource.
1543 # - For zonal operations, use
1544 # the `zoneOperations` resource.
1545 #
1546 #
1547 #
1548 # For more information, read
1549 # Global, Regional, and Zonal Resources.
1550 #
1551 # Note that completed Operation resources have a limited
1552 # retention period.
1553 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1554 # Not present otherwise.
1555 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1556 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1557 # set when the operation is created.
1558 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1559 # text format.
1560 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1561 # this field will be populated.
1562 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1563 # operation.
1564 {
1565 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1566 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1567 # details. There is a set of defined message types to use for providing
1568 # details.The syntax depends on the error code. For example,
1569 # QuotaExceededInfo will have details when the error code is
1570 # QUOTA_EXCEEDED.
1571 {
1572 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1573 #
1574 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1575 # is not enabled:
1576 #
1577 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1578 # &quot;domain&quot;: &quot;googleapis.com&quot;
1579 # &quot;metadata&quot;: {
1580 # &quot;resource&quot;: &quot;projects/123&quot;,
1581 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1582 # }
1583 # }
1584 #
1585 # This response indicates that the pubsub.googleapis.com API is not enabled.
1586 #
1587 # Example of an error that is returned when attempting to create a Spanner
1588 # instance in a region that is out of stock:
1589 #
1590 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1591 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1592 # &quot;metadata&quot;: {
1593 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1594 # }
1595 # }
1596 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1597 # is typically the registered service name of the tool or product that
1598 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1599 # generated by some common infrastructure, the error domain must be a
1600 # globally unique value that identifies the infrastructure. For Google API
1601 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1602 &quot;metadatas&quot;: { # Additional structured details about this error.
1603 #
1604 # Keys must match a regular expression of `a-z+` but should
1605 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1606 # length. When identifying the current value of an exceeded limit, the units
1607 # should be contained in the key, not the value. For example, rather than
1608 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1609 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1610 # instances that can be created in a single (batch) request.
1611 &quot;a_key&quot;: &quot;A String&quot;,
1612 },
1613 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1614 # proximate cause of the error. Error reasons are unique within a particular
1615 # domain of errors. This should be at most 63 characters and match a
1616 # regular expression of `A-Z+[A-Z0-9]`, which represents
1617 # UPPER_SNAKE_CASE.
1618 },
1619 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1620 #
1621 # For example, if a quota check failed with an error indicating the calling
1622 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1623 # directly to the right place in the developer console to flip the bit.
1624 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1625 { # Describes a URL link.
1626 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1627 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1628 },
1629 ],
1630 },
1631 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1632 # which can be attached to an RPC error.
1633 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1634 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1635 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1636 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1637 },
1638 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1639 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1640 &quot;a_key&quot;: &quot;A String&quot;,
1641 },
1642 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1643 # type or metric.
1644 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1645 # or metric.
1646 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1647 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1648 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1649 },
1650 },
1651 ],
1652 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1653 # This property is optional.
1654 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1655 },
1656 ],
1657 },
1658 &quot;getVersionOperationMetadata&quot;: {
1659 &quot;inlineSbomInfo&quot;: {
1660 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1661 # appropriate identifiers.
1662 &quot;a_key&quot;: &quot;A String&quot;,
1663 },
1664 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1665 # identifiers.
1666 &quot;a_key&quot;: &quot;A String&quot;,
1667 },
1668 },
1669 },
1670 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1671 # message that was returned, such as `NOT FOUND`.
1672 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1673 # status code that was returned. For example, a `404` means the
1674 # resource was not found.
1675 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1676 # defined by the server.
1677 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1678 # This value is inRFC3339
1679 # text format.
1680 &quot;instancesBulkInsertOperationMetadata&quot;: {
1681 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1682 # Example key: zones/us-central1-a
1683 &quot;a_key&quot;: {
1684 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1685 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1686 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1687 # error.
1688 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1689 # if the flow is rolling forward or rolling back.
1690 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1691 },
1692 },
1693 },
1694 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1695 # Operation resources.
1696 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1697 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1698 # group of operations results from a `bulkInsert` API request.
1699 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1700 # `update`, or `delete`, and so on.
1701 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1702 # There is no requirement that this be linear or support any granularity of
1703 # operations. This should not be used to guess when the operation will be
1704 # complete. This number should monotonically increase as the operation
1705 # progresses.
1706 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1707 # applicable when performing regional operations.
1708 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1709 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1710 # this field will contain information on all underlying zonal actions and
1711 # their state.
1712 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1713 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1714 # Example key: zones/us-central1-a
1715 &quot;a_key&quot;: {
1716 &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
1717 # populated.
1718 # different programming environments, including REST APIs and RPC APIs. It is
1719 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1720 # three pieces of data: error code, error message, and error details.
1721 #
1722 # You can find out more about this error model and how to work with it in the
1723 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1724 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1725 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1726 # message types for APIs to use.
1727 {
1728 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1729 },
1730 ],
1731 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1732 # user-facing error message should be localized and sent in the
1733 # google.rpc.Status.details field, or localized by the client.
1734 },
1735 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1736 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1737 },
1738 },
1739 },
1740 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1741 # This value is inRFC3339
1742 # text format.
1743 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1744 # following:
1745 # `PENDING`, `RUNNING`, or `DONE`.
1746 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1747 # operation.
1748 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1749 # of the target resource.
1750 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1751 # operations related to creating a snapshot, this points to the disk
1752 # that the snapshot was created from.
1753 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1754 # `[email protected]` or
1755 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1756 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1757 # operation, this field will be populated.
1758 {
1759 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1760 # Engine returns NO_RESULTS_ON_PAGE if there
1761 # are no results in the response.
1762 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1763 # value format. For example:
1764 #
1765 # &quot;data&quot;: [
1766 # {
1767 # &quot;key&quot;: &quot;scope&quot;,
1768 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1769 # }
1770 {
1771 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1772 # returned. For example, for warnings where there are no results in a list
1773 # request for a particular zone, this key might be scope and
1774 # the key value might be the zone name. Other examples might be a key
1775 # indicating a deprecated resource and a suggested replacement, or a
1776 # warning about invalid network settings (for example, if an instance
1777 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1778 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1779 },
1780 ],
1781 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1782 },
1783 ],
1784 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1785 # applicable when performing per-zone operations.
1786 }</pre>
1787 </div>
1788
1789 <div class="method">
1790 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
1791 <pre>Returns permissions that a caller has on the specified resource.
1792
1793 Args:
1794 project: string, Project ID for this request. (required)
1795 region: string, The name of the region for this request. (required)
1796 resource: string, Name or id of the resource for this request. (required)
1797 body: object, The request body.
1798 The object takes the form of:
1799
1800 {
1801 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
1802 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1803 &quot;A String&quot;,
1804 ],
1805 }
1806
1807 x__xgafv: string, V1 error format.
1808 Allowed values
1809 1 - v1 error format
1810 2 - v2 error format
1811
1812 Returns:
1813 An object of the form:
1814
1815 {
1816 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1817 # allowed.
1818 &quot;A String&quot;,
1819 ],
1820 }</pre>
1821 </div>
1822
1823 </body></html>