Debian Codegraph @

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