Debian Codegraph @

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