Debian Codegraph @

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