Debian Codegraph @

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