Debian Codegraph @

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