Debian Codegraph @

docs/dyn/compute_v1.projects.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.projects.html">projects</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#disableXpnHost">disableXpnHost(project, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Disable this project as a shared VPC host project.</p>
83 <p class="toc_element">
84 <code><a href="#disableXpnResource">disableXpnResource(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Disable a service resource (also known as service project) associated with</p>
86 <p class="toc_element">
87 <code><a href="#enableXpnHost">enableXpnHost(project, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Enable this project as a shared VPC host project.</p>
89 <p class="toc_element">
90 <code><a href="#enableXpnResource">enableXpnResource(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Enable service resource (a.k.a service project) for a host project, so that</p>
92 <p class="toc_element">
93 <code><a href="#get">get(project, x__xgafv=None)</a></code></p>
94 <p class="firstline">Returns the specified Project resource.</p>
95 <p class="toc_element">
96 <code><a href="#getXpnHost">getXpnHost(project, x__xgafv=None)</a></code></p>
97 <p class="firstline">Gets the shared VPC host project that this project links to. May be empty</p>
98 <p class="toc_element">
99 <code><a href="#getXpnResources">getXpnResources(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Gets service resources (a.k.a service project) associated with this host</p>
101 <p class="toc_element">
102 <code><a href="#getXpnResources_next">getXpnResources_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#listXpnHosts">listXpnHosts(project, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Lists all shared VPC host projects visible to the user in an organization.</p>
107 <p class="toc_element">
108 <code><a href="#listXpnHosts_next">listXpnHosts_next()</a></code></p>
109 <p class="firstline">Retrieves the next page of results.</p>
110 <p class="toc_element">
111 <code><a href="#moveDisk">moveDisk(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Moves a persistent disk from one zone to another.</p>
113 <p class="toc_element">
114 <code><a href="#moveInstance">moveInstance(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Moves an instance and its attached persistent disks from one zone to</p>
116 <p class="toc_element">
117 <code><a href="#setCloudArmorTier">setCloudArmorTier(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the</p>
119 <p class="toc_element">
120 <code><a href="#setCommonInstanceMetadata">setCommonInstanceMetadata(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Sets metadata common to all instances within the specified project using</p>
122 <p class="toc_element">
123 <code><a href="#setDefaultNetworkTier">setDefaultNetworkTier(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Sets the default network tier of the project. The default network tier is</p>
125 <p class="toc_element">
126 <code><a href="#setUsageExportBucket">setUsageExportBucket(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Enables the usage export feature and sets theusage export bucket</p>
128 <h3>Method Details</h3>
129 <div class="method">
130 <code class="details" id="close">close()</code>
131 <pre>Close httplib2 connections.</pre>
132 </div>
133
134 <div class="method">
135 <code class="details" id="disableXpnHost">disableXpnHost(project, requestId=None, x__xgafv=None)</code>
136 <pre>Disable this project as a shared VPC host project.
137
138 Args:
139 project: string, Project ID for this request. (required)
140 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
141 that if you must retry your request, the server will know to ignore the
142 request if it has already been completed.
143
144 For example, consider a situation where you make an initial request and
145 the request times out. If you make the request again with the same
146 request ID, the server can check if original operation with the same
147 request ID was received, and if so, will ignore the second request. This
148 prevents clients from accidentally creating duplicate commitments.
149
150 The request ID must be
151 a valid UUID with the exception that zero UUID is not supported
152 (00000000-0000-0000-0000-000000000000).
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158 Returns:
159 An object of the form:
160
161 { # Represents an Operation resource.
162 #
163 # Google Compute Engine has three Operation resources:
164 #
165 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
166 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
167 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
168 #
169 # You can use an operation resource to manage asynchronous API requests.
170 # For more information, readHandling
171 # API responses.
172 #
173 # Operations can be global, regional or zonal.
174 #
175 # - For global operations, use the `globalOperations`
176 # resource.
177 # - For regional operations, use the
178 # `regionOperations` resource.
179 # - For zonal operations, use
180 # the `zoneOperations` resource.
181 #
182 #
183 #
184 # For more information, read
185 # Global, Regional, and Zonal Resources.
186 #
187 # Note that completed Operation resources have a limited
188 # retention period.
189 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
190 # Not present otherwise.
191 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
192 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
193 # set when the operation is created.
194 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
195 # text format.
196 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
197 # this field will be populated.
198 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
199 # operation.
200 {
201 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
202 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
203 # details. There is a set of defined message types to use for providing
204 # details.The syntax depends on the error code. For example,
205 # QuotaExceededInfo will have details when the error code is
206 # QUOTA_EXCEEDED.
207 {
208 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
209 #
210 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
211 # is not enabled:
212 #
213 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
214 # &quot;domain&quot;: &quot;googleapis.com&quot;
215 # &quot;metadata&quot;: {
216 # &quot;resource&quot;: &quot;projects/123&quot;,
217 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
218 # }
219 # }
220 #
221 # This response indicates that the pubsub.googleapis.com API is not enabled.
222 #
223 # Example of an error that is returned when attempting to create a Spanner
224 # instance in a region that is out of stock:
225 #
226 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
227 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
228 # &quot;metadata&quot;: {
229 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
230 # }
231 # }
232 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
233 # is typically the registered service name of the tool or product that
234 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
235 # generated by some common infrastructure, the error domain must be a
236 # globally unique value that identifies the infrastructure. For Google API
237 # infrastructure, the error domain is &quot;googleapis.com&quot;.
238 &quot;metadatas&quot;: { # Additional structured details about this error.
239 #
240 # Keys must match a regular expression of `a-z+` but should
241 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
242 # length. When identifying the current value of an exceeded limit, the units
243 # should be contained in the key, not the value. For example, rather than
244 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
245 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
246 # instances that can be created in a single (batch) request.
247 &quot;a_key&quot;: &quot;A String&quot;,
248 },
249 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
250 # proximate cause of the error. Error reasons are unique within a particular
251 # domain of errors. This should be at most 63 characters and match a
252 # regular expression of `A-Z+[A-Z0-9]`, which represents
253 # UPPER_SNAKE_CASE.
254 },
255 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
256 #
257 # For example, if a quota check failed with an error indicating the calling
258 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
259 # directly to the right place in the developer console to flip the bit.
260 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
261 { # Describes a URL link.
262 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
263 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
264 },
265 ],
266 },
267 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
268 # which can be attached to an RPC error.
269 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
270 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
271 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
272 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
273 },
274 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
275 &quot;dimensions&quot;: { # The map holding related quota dimensions.
276 &quot;a_key&quot;: &quot;A String&quot;,
277 },
278 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
279 # type or metric.
280 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
281 # or metric.
282 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
283 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
284 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
285 },
286 },
287 ],
288 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
289 # This property is optional.
290 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
291 },
292 ],
293 },
294 &quot;getVersionOperationMetadata&quot;: {
295 &quot;inlineSbomInfo&quot;: {
296 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
297 # appropriate identifiers.
298 &quot;a_key&quot;: &quot;A String&quot;,
299 },
300 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
301 # identifiers.
302 &quot;a_key&quot;: &quot;A String&quot;,
303 },
304 },
305 },
306 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
307 # message that was returned, such as `NOT FOUND`.
308 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
309 # status code that was returned. For example, a `404` means the
310 # resource was not found.
311 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
312 # defined by the server.
313 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
314 # This value is inRFC3339
315 # text format.
316 &quot;instancesBulkInsertOperationMetadata&quot;: {
317 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
318 # Example key: zones/us-central1-a
319 &quot;a_key&quot;: {
320 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
321 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
322 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
323 # error.
324 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
325 # if the flow is rolling forward or rolling back.
326 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
327 },
328 },
329 },
330 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
331 # Operation resources.
332 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
333 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
334 # group of operations results from a `bulkInsert` API request.
335 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
336 # `update`, or `delete`, and so on.
337 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
338 # There is no requirement that this be linear or support any granularity of
339 # operations. This should not be used to guess when the operation will be
340 # complete. This number should monotonically increase as the operation
341 # progresses.
342 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
343 # applicable when performing regional operations.
344 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
345 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
346 # this field will contain information on all underlying zonal actions and
347 # their state.
348 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
349 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
350 # Example key: zones/us-central1-a
351 &quot;a_key&quot;: {
352 &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
353 # populated.
354 # different programming environments, including REST APIs and RPC APIs. It is
355 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
356 # three pieces of data: error code, error message, and error details.
357 #
358 # You can find out more about this error model and how to work with it in the
359 # [API Design Guide](https://cloud.google.com/apis/design/errors).
360 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
361 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
362 # message types for APIs to use.
363 {
364 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
365 },
366 ],
367 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
368 # user-facing error message should be localized and sent in the
369 # google.rpc.Status.details field, or localized by the client.
370 },
371 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
372 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
373 },
374 },
375 },
376 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
377 # This value is inRFC3339
378 # text format.
379 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
380 # following:
381 # `PENDING`, `RUNNING`, or `DONE`.
382 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
383 # operation.
384 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
385 # of the target resource.
386 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
387 # operations related to creating a snapshot, this points to the disk
388 # that the snapshot was created from.
389 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
390 # `[email protected]` or
391 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
392 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
393 # operation, this field will be populated.
394 {
395 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
396 # Engine returns NO_RESULTS_ON_PAGE if there
397 # are no results in the response.
398 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
399 # value format. For example:
400 #
401 # &quot;data&quot;: [
402 # {
403 # &quot;key&quot;: &quot;scope&quot;,
404 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
405 # }
406 {
407 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
408 # returned. For example, for warnings where there are no results in a list
409 # request for a particular zone, this key might be scope and
410 # the key value might be the zone name. Other examples might be a key
411 # indicating a deprecated resource and a suggested replacement, or a
412 # warning about invalid network settings (for example, if an instance
413 # attempts to perform IP forwarding but is not enabled for IP forwarding).
414 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
415 },
416 ],
417 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
418 },
419 ],
420 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
421 # applicable when performing per-zone operations.
422 }</pre>
423 </div>
424
425 <div class="method">
426 <code class="details" id="disableXpnResource">disableXpnResource(project, body=None, requestId=None, x__xgafv=None)</code>
427 <pre>Disable a service resource (also known as service project) associated with
428 this host project.
429
430 Args:
431 project: string, Project ID for this request. (required)
432 body: object, The request body.
433 The object takes the form of:
434
435 {
436 &quot;xpnResource&quot;: { # Service resource (a.k.a service project) ID. # Service resource (a.k.a service project) ID.
437 &quot;id&quot;: &quot;A String&quot;, # The ID of the service resource. In the case of projects, this field
438 # supports project id (e.g., my-project-123) and project number
439 # (e.g. 12345678).
440 &quot;type&quot;: &quot;A String&quot;, # The type of the service resource.
441 },
442 }
443
444 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
445 that if you must retry your request, the server will know to ignore the
446 request if it has already been completed.
447
448 For example, consider a situation where you make an initial request and
449 the request times out. If you make the request again with the same
450 request ID, the server can check if original operation with the same
451 request ID was received, and if so, will ignore the second request. This
452 prevents clients from accidentally creating duplicate commitments.
453
454 The request ID must be
455 a valid UUID with the exception that zero UUID is not supported
456 (00000000-0000-0000-0000-000000000000).
457 x__xgafv: string, V1 error format.
458 Allowed values
459 1 - v1 error format
460 2 - v2 error format
461
462 Returns:
463 An object of the form:
464
465 { # Represents an Operation resource.
466 #
467 # Google Compute Engine has three Operation resources:
468 #
469 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
470 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
471 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
472 #
473 # You can use an operation resource to manage asynchronous API requests.
474 # For more information, readHandling
475 # API responses.
476 #
477 # Operations can be global, regional or zonal.
478 #
479 # - For global operations, use the `globalOperations`
480 # resource.
481 # - For regional operations, use the
482 # `regionOperations` resource.
483 # - For zonal operations, use
484 # the `zoneOperations` resource.
485 #
486 #
487 #
488 # For more information, read
489 # Global, Regional, and Zonal Resources.
490 #
491 # Note that completed Operation resources have a limited
492 # retention period.
493 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
494 # Not present otherwise.
495 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
496 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
497 # set when the operation is created.
498 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
499 # text format.
500 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
501 # this field will be populated.
502 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
503 # operation.
504 {
505 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
506 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
507 # details. There is a set of defined message types to use for providing
508 # details.The syntax depends on the error code. For example,
509 # QuotaExceededInfo will have details when the error code is
510 # QUOTA_EXCEEDED.
511 {
512 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
513 #
514 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
515 # is not enabled:
516 #
517 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
518 # &quot;domain&quot;: &quot;googleapis.com&quot;
519 # &quot;metadata&quot;: {
520 # &quot;resource&quot;: &quot;projects/123&quot;,
521 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
522 # }
523 # }
524 #
525 # This response indicates that the pubsub.googleapis.com API is not enabled.
526 #
527 # Example of an error that is returned when attempting to create a Spanner
528 # instance in a region that is out of stock:
529 #
530 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
531 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
532 # &quot;metadata&quot;: {
533 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
534 # }
535 # }
536 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
537 # is typically the registered service name of the tool or product that
538 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
539 # generated by some common infrastructure, the error domain must be a
540 # globally unique value that identifies the infrastructure. For Google API
541 # infrastructure, the error domain is &quot;googleapis.com&quot;.
542 &quot;metadatas&quot;: { # Additional structured details about this error.
543 #
544 # Keys must match a regular expression of `a-z+` but should
545 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
546 # length. When identifying the current value of an exceeded limit, the units
547 # should be contained in the key, not the value. For example, rather than
548 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
549 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
550 # instances that can be created in a single (batch) request.
551 &quot;a_key&quot;: &quot;A String&quot;,
552 },
553 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
554 # proximate cause of the error. Error reasons are unique within a particular
555 # domain of errors. This should be at most 63 characters and match a
556 # regular expression of `A-Z+[A-Z0-9]`, which represents
557 # UPPER_SNAKE_CASE.
558 },
559 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
560 #
561 # For example, if a quota check failed with an error indicating the calling
562 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
563 # directly to the right place in the developer console to flip the bit.
564 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
565 { # Describes a URL link.
566 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
567 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
568 },
569 ],
570 },
571 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
572 # which can be attached to an RPC error.
573 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
574 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
575 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
576 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
577 },
578 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
579 &quot;dimensions&quot;: { # The map holding related quota dimensions.
580 &quot;a_key&quot;: &quot;A String&quot;,
581 },
582 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
583 # type or metric.
584 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
585 # or metric.
586 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
587 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
588 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
589 },
590 },
591 ],
592 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
593 # This property is optional.
594 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
595 },
596 ],
597 },
598 &quot;getVersionOperationMetadata&quot;: {
599 &quot;inlineSbomInfo&quot;: {
600 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
601 # appropriate identifiers.
602 &quot;a_key&quot;: &quot;A String&quot;,
603 },
604 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
605 # identifiers.
606 &quot;a_key&quot;: &quot;A String&quot;,
607 },
608 },
609 },
610 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
611 # message that was returned, such as `NOT FOUND`.
612 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
613 # status code that was returned. For example, a `404` means the
614 # resource was not found.
615 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
616 # defined by the server.
617 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
618 # This value is inRFC3339
619 # text format.
620 &quot;instancesBulkInsertOperationMetadata&quot;: {
621 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
622 # Example key: zones/us-central1-a
623 &quot;a_key&quot;: {
624 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
625 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
626 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
627 # error.
628 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
629 # if the flow is rolling forward or rolling back.
630 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
631 },
632 },
633 },
634 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
635 # Operation resources.
636 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
637 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
638 # group of operations results from a `bulkInsert` API request.
639 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
640 # `update`, or `delete`, and so on.
641 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
642 # There is no requirement that this be linear or support any granularity of
643 # operations. This should not be used to guess when the operation will be
644 # complete. This number should monotonically increase as the operation
645 # progresses.
646 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
647 # applicable when performing regional operations.
648 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
649 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
650 # this field will contain information on all underlying zonal actions and
651 # their state.
652 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
653 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
654 # Example key: zones/us-central1-a
655 &quot;a_key&quot;: {
656 &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
657 # populated.
658 # different programming environments, including REST APIs and RPC APIs. It is
659 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
660 # three pieces of data: error code, error message, and error details.
661 #
662 # You can find out more about this error model and how to work with it in the
663 # [API Design Guide](https://cloud.google.com/apis/design/errors).
664 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
665 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
666 # message types for APIs to use.
667 {
668 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
669 },
670 ],
671 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
672 # user-facing error message should be localized and sent in the
673 # google.rpc.Status.details field, or localized by the client.
674 },
675 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
676 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
677 },
678 },
679 },
680 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
681 # This value is inRFC3339
682 # text format.
683 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
684 # following:
685 # `PENDING`, `RUNNING`, or `DONE`.
686 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
687 # operation.
688 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
689 # of the target resource.
690 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
691 # operations related to creating a snapshot, this points to the disk
692 # that the snapshot was created from.
693 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
694 # `[email protected]` or
695 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
696 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
697 # operation, this field will be populated.
698 {
699 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
700 # Engine returns NO_RESULTS_ON_PAGE if there
701 # are no results in the response.
702 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
703 # value format. For example:
704 #
705 # &quot;data&quot;: [
706 # {
707 # &quot;key&quot;: &quot;scope&quot;,
708 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
709 # }
710 {
711 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
712 # returned. For example, for warnings where there are no results in a list
713 # request for a particular zone, this key might be scope and
714 # the key value might be the zone name. Other examples might be a key
715 # indicating a deprecated resource and a suggested replacement, or a
716 # warning about invalid network settings (for example, if an instance
717 # attempts to perform IP forwarding but is not enabled for IP forwarding).
718 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
719 },
720 ],
721 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
722 },
723 ],
724 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
725 # applicable when performing per-zone operations.
726 }</pre>
727 </div>
728
729 <div class="method">
730 <code class="details" id="enableXpnHost">enableXpnHost(project, requestId=None, x__xgafv=None)</code>
731 <pre>Enable this project as a shared VPC host project.
732
733 Args:
734 project: string, Project ID for this request. (required)
735 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
736 that if you must retry your request, the server will know to ignore the
737 request if it has already been completed.
738
739 For example, consider a situation where you make an initial request and
740 the request times out. If you make the request again with the same
741 request ID, the server can check if original operation with the same
742 request ID was received, and if so, will ignore the second request. This
743 prevents clients from accidentally creating duplicate commitments.
744
745 The request ID must be
746 a valid UUID with the exception that zero UUID is not supported
747 (00000000-0000-0000-0000-000000000000).
748 x__xgafv: string, V1 error format.
749 Allowed values
750 1 - v1 error format
751 2 - v2 error format
752
753 Returns:
754 An object of the form:
755
756 { # Represents an Operation resource.
757 #
758 # Google Compute Engine has three Operation resources:
759 #
760 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
761 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
762 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
763 #
764 # You can use an operation resource to manage asynchronous API requests.
765 # For more information, readHandling
766 # API responses.
767 #
768 # Operations can be global, regional or zonal.
769 #
770 # - For global operations, use the `globalOperations`
771 # resource.
772 # - For regional operations, use the
773 # `regionOperations` resource.
774 # - For zonal operations, use
775 # the `zoneOperations` resource.
776 #
777 #
778 #
779 # For more information, read
780 # Global, Regional, and Zonal Resources.
781 #
782 # Note that completed Operation resources have a limited
783 # retention period.
784 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
785 # Not present otherwise.
786 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
787 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
788 # set when the operation is created.
789 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
790 # text format.
791 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
792 # this field will be populated.
793 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
794 # operation.
795 {
796 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
797 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
798 # details. There is a set of defined message types to use for providing
799 # details.The syntax depends on the error code. For example,
800 # QuotaExceededInfo will have details when the error code is
801 # QUOTA_EXCEEDED.
802 {
803 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
804 #
805 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
806 # is not enabled:
807 #
808 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
809 # &quot;domain&quot;: &quot;googleapis.com&quot;
810 # &quot;metadata&quot;: {
811 # &quot;resource&quot;: &quot;projects/123&quot;,
812 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
813 # }
814 # }
815 #
816 # This response indicates that the pubsub.googleapis.com API is not enabled.
817 #
818 # Example of an error that is returned when attempting to create a Spanner
819 # instance in a region that is out of stock:
820 #
821 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
822 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
823 # &quot;metadata&quot;: {
824 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
825 # }
826 # }
827 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
828 # is typically the registered service name of the tool or product that
829 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
830 # generated by some common infrastructure, the error domain must be a
831 # globally unique value that identifies the infrastructure. For Google API
832 # infrastructure, the error domain is &quot;googleapis.com&quot;.
833 &quot;metadatas&quot;: { # Additional structured details about this error.
834 #
835 # Keys must match a regular expression of `a-z+` but should
836 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
837 # length. When identifying the current value of an exceeded limit, the units
838 # should be contained in the key, not the value. For example, rather than
839 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
840 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
841 # instances that can be created in a single (batch) request.
842 &quot;a_key&quot;: &quot;A String&quot;,
843 },
844 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
845 # proximate cause of the error. Error reasons are unique within a particular
846 # domain of errors. This should be at most 63 characters and match a
847 # regular expression of `A-Z+[A-Z0-9]`, which represents
848 # UPPER_SNAKE_CASE.
849 },
850 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
851 #
852 # For example, if a quota check failed with an error indicating the calling
853 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
854 # directly to the right place in the developer console to flip the bit.
855 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
856 { # Describes a URL link.
857 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
858 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
859 },
860 ],
861 },
862 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
863 # which can be attached to an RPC error.
864 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
865 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
866 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
867 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
868 },
869 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
870 &quot;dimensions&quot;: { # The map holding related quota dimensions.
871 &quot;a_key&quot;: &quot;A String&quot;,
872 },
873 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
874 # type or metric.
875 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
876 # or metric.
877 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
878 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
879 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
880 },
881 },
882 ],
883 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
884 # This property is optional.
885 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
886 },
887 ],
888 },
889 &quot;getVersionOperationMetadata&quot;: {
890 &quot;inlineSbomInfo&quot;: {
891 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
892 # appropriate identifiers.
893 &quot;a_key&quot;: &quot;A String&quot;,
894 },
895 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
896 # identifiers.
897 &quot;a_key&quot;: &quot;A String&quot;,
898 },
899 },
900 },
901 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
902 # message that was returned, such as `NOT FOUND`.
903 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
904 # status code that was returned. For example, a `404` means the
905 # resource was not found.
906 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
907 # defined by the server.
908 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
909 # This value is inRFC3339
910 # text format.
911 &quot;instancesBulkInsertOperationMetadata&quot;: {
912 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
913 # Example key: zones/us-central1-a
914 &quot;a_key&quot;: {
915 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
916 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
917 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
918 # error.
919 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
920 # if the flow is rolling forward or rolling back.
921 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
922 },
923 },
924 },
925 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
926 # Operation resources.
927 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
928 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
929 # group of operations results from a `bulkInsert` API request.
930 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
931 # `update`, or `delete`, and so on.
932 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
933 # There is no requirement that this be linear or support any granularity of
934 # operations. This should not be used to guess when the operation will be
935 # complete. This number should monotonically increase as the operation
936 # progresses.
937 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
938 # applicable when performing regional operations.
939 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
940 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
941 # this field will contain information on all underlying zonal actions and
942 # their state.
943 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
944 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
945 # Example key: zones/us-central1-a
946 &quot;a_key&quot;: {
947 &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
948 # populated.
949 # different programming environments, including REST APIs and RPC APIs. It is
950 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
951 # three pieces of data: error code, error message, and error details.
952 #
953 # You can find out more about this error model and how to work with it in the
954 # [API Design Guide](https://cloud.google.com/apis/design/errors).
955 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
956 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
957 # message types for APIs to use.
958 {
959 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
960 },
961 ],
962 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
963 # user-facing error message should be localized and sent in the
964 # google.rpc.Status.details field, or localized by the client.
965 },
966 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
967 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
968 },
969 },
970 },
971 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
972 # This value is inRFC3339
973 # text format.
974 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
975 # following:
976 # `PENDING`, `RUNNING`, or `DONE`.
977 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
978 # operation.
979 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
980 # of the target resource.
981 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
982 # operations related to creating a snapshot, this points to the disk
983 # that the snapshot was created from.
984 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
985 # `[email protected]` or
986 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
987 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
988 # operation, this field will be populated.
989 {
990 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
991 # Engine returns NO_RESULTS_ON_PAGE if there
992 # are no results in the response.
993 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
994 # value format. For example:
995 #
996 # &quot;data&quot;: [
997 # {
998 # &quot;key&quot;: &quot;scope&quot;,
999 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1000 # }
1001 {
1002 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1003 # returned. For example, for warnings where there are no results in a list
1004 # request for a particular zone, this key might be scope and
1005 # the key value might be the zone name. Other examples might be a key
1006 # indicating a deprecated resource and a suggested replacement, or a
1007 # warning about invalid network settings (for example, if an instance
1008 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1009 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1010 },
1011 ],
1012 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1013 },
1014 ],
1015 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1016 # applicable when performing per-zone operations.
1017 }</pre>
1018 </div>
1019
1020 <div class="method">
1021 <code class="details" id="enableXpnResource">enableXpnResource(project, body=None, requestId=None, x__xgafv=None)</code>
1022 <pre>Enable service resource (a.k.a service project) for a host project, so that
1023 subnets in the host project can be used by instances in the service
1024 project.
1025
1026 Args:
1027 project: string, Project ID for this request. (required)
1028 body: object, The request body.
1029 The object takes the form of:
1030
1031 {
1032 &quot;xpnResource&quot;: { # Service resource (a.k.a service project) ID. # Service resource (a.k.a service project) ID.
1033 &quot;id&quot;: &quot;A String&quot;, # The ID of the service resource. In the case of projects, this field
1034 # supports project id (e.g., my-project-123) and project number
1035 # (e.g. 12345678).
1036 &quot;type&quot;: &quot;A String&quot;, # The type of the service resource.
1037 },
1038 }
1039
1040 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1041 that if you must retry your request, the server will know to ignore the
1042 request if it has already been completed.
1043
1044 For example, consider a situation where you make an initial request and
1045 the request times out. If you make the request again with the same
1046 request ID, the server can check if original operation with the same
1047 request ID was received, and if so, will ignore the second request. This
1048 prevents clients from accidentally creating duplicate commitments.
1049
1050 The request ID must be
1051 a valid UUID with the exception that zero UUID is not supported
1052 (00000000-0000-0000-0000-000000000000).
1053 x__xgafv: string, V1 error format.
1054 Allowed values
1055 1 - v1 error format
1056 2 - v2 error format
1057
1058 Returns:
1059 An object of the form:
1060
1061 { # Represents an Operation resource.
1062 #
1063 # Google Compute Engine has three Operation resources:
1064 #
1065 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1066 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1067 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1068 #
1069 # You can use an operation resource to manage asynchronous API requests.
1070 # For more information, readHandling
1071 # API responses.
1072 #
1073 # Operations can be global, regional or zonal.
1074 #
1075 # - For global operations, use the `globalOperations`
1076 # resource.
1077 # - For regional operations, use the
1078 # `regionOperations` resource.
1079 # - For zonal operations, use
1080 # the `zoneOperations` resource.
1081 #
1082 #
1083 #
1084 # For more information, read
1085 # Global, Regional, and Zonal Resources.
1086 #
1087 # Note that completed Operation resources have a limited
1088 # retention period.
1089 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1090 # Not present otherwise.
1091 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1092 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1093 # set when the operation is created.
1094 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1095 # text format.
1096 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1097 # this field will be populated.
1098 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1099 # operation.
1100 {
1101 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1102 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1103 # details. There is a set of defined message types to use for providing
1104 # details.The syntax depends on the error code. For example,
1105 # QuotaExceededInfo will have details when the error code is
1106 # QUOTA_EXCEEDED.
1107 {
1108 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1109 #
1110 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1111 # is not enabled:
1112 #
1113 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1114 # &quot;domain&quot;: &quot;googleapis.com&quot;
1115 # &quot;metadata&quot;: {
1116 # &quot;resource&quot;: &quot;projects/123&quot;,
1117 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1118 # }
1119 # }
1120 #
1121 # This response indicates that the pubsub.googleapis.com API is not enabled.
1122 #
1123 # Example of an error that is returned when attempting to create a Spanner
1124 # instance in a region that is out of stock:
1125 #
1126 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1127 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1128 # &quot;metadata&quot;: {
1129 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1130 # }
1131 # }
1132 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1133 # is typically the registered service name of the tool or product that
1134 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1135 # generated by some common infrastructure, the error domain must be a
1136 # globally unique value that identifies the infrastructure. For Google API
1137 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1138 &quot;metadatas&quot;: { # Additional structured details about this error.
1139 #
1140 # Keys must match a regular expression of `a-z+` but should
1141 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1142 # length. When identifying the current value of an exceeded limit, the units
1143 # should be contained in the key, not the value. For example, rather than
1144 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1145 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1146 # instances that can be created in a single (batch) request.
1147 &quot;a_key&quot;: &quot;A String&quot;,
1148 },
1149 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1150 # proximate cause of the error. Error reasons are unique within a particular
1151 # domain of errors. This should be at most 63 characters and match a
1152 # regular expression of `A-Z+[A-Z0-9]`, which represents
1153 # UPPER_SNAKE_CASE.
1154 },
1155 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1156 #
1157 # For example, if a quota check failed with an error indicating the calling
1158 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1159 # directly to the right place in the developer console to flip the bit.
1160 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1161 { # Describes a URL link.
1162 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1163 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1164 },
1165 ],
1166 },
1167 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1168 # which can be attached to an RPC error.
1169 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1170 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1171 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1172 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1173 },
1174 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1175 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1176 &quot;a_key&quot;: &quot;A String&quot;,
1177 },
1178 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1179 # type or metric.
1180 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1181 # or metric.
1182 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1183 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1184 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1185 },
1186 },
1187 ],
1188 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1189 # This property is optional.
1190 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1191 },
1192 ],
1193 },
1194 &quot;getVersionOperationMetadata&quot;: {
1195 &quot;inlineSbomInfo&quot;: {
1196 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1197 # appropriate identifiers.
1198 &quot;a_key&quot;: &quot;A String&quot;,
1199 },
1200 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1201 # identifiers.
1202 &quot;a_key&quot;: &quot;A String&quot;,
1203 },
1204 },
1205 },
1206 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1207 # message that was returned, such as `NOT FOUND`.
1208 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1209 # status code that was returned. For example, a `404` means the
1210 # resource was not found.
1211 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1212 # defined by the server.
1213 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1214 # This value is inRFC3339
1215 # text format.
1216 &quot;instancesBulkInsertOperationMetadata&quot;: {
1217 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1218 # Example key: zones/us-central1-a
1219 &quot;a_key&quot;: {
1220 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1221 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1222 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1223 # error.
1224 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1225 # if the flow is rolling forward or rolling back.
1226 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1227 },
1228 },
1229 },
1230 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1231 # Operation resources.
1232 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1233 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1234 # group of operations results from a `bulkInsert` API request.
1235 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1236 # `update`, or `delete`, and so on.
1237 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1238 # There is no requirement that this be linear or support any granularity of
1239 # operations. This should not be used to guess when the operation will be
1240 # complete. This number should monotonically increase as the operation
1241 # progresses.
1242 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1243 # applicable when performing regional operations.
1244 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1245 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1246 # this field will contain information on all underlying zonal actions and
1247 # their state.
1248 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1249 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1250 # Example key: zones/us-central1-a
1251 &quot;a_key&quot;: {
1252 &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
1253 # populated.
1254 # different programming environments, including REST APIs and RPC APIs. It is
1255 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1256 # three pieces of data: error code, error message, and error details.
1257 #
1258 # You can find out more about this error model and how to work with it in the
1259 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1260 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1261 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1262 # message types for APIs to use.
1263 {
1264 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1265 },
1266 ],
1267 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1268 # user-facing error message should be localized and sent in the
1269 # google.rpc.Status.details field, or localized by the client.
1270 },
1271 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1272 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1273 },
1274 },
1275 },
1276 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1277 # This value is inRFC3339
1278 # text format.
1279 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1280 # following:
1281 # `PENDING`, `RUNNING`, or `DONE`.
1282 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1283 # operation.
1284 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1285 # of the target resource.
1286 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1287 # operations related to creating a snapshot, this points to the disk
1288 # that the snapshot was created from.
1289 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1290 # `[email protected]` or
1291 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1292 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1293 # operation, this field will be populated.
1294 {
1295 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1296 # Engine returns NO_RESULTS_ON_PAGE if there
1297 # are no results in the response.
1298 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1299 # value format. For example:
1300 #
1301 # &quot;data&quot;: [
1302 # {
1303 # &quot;key&quot;: &quot;scope&quot;,
1304 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1305 # }
1306 {
1307 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1308 # returned. For example, for warnings where there are no results in a list
1309 # request for a particular zone, this key might be scope and
1310 # the key value might be the zone name. Other examples might be a key
1311 # indicating a deprecated resource and a suggested replacement, or a
1312 # warning about invalid network settings (for example, if an instance
1313 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1314 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1315 },
1316 ],
1317 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1318 },
1319 ],
1320 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1321 # applicable when performing per-zone operations.
1322 }</pre>
1323 </div>
1324
1325 <div class="method">
1326 <code class="details" id="get">get(project, x__xgafv=None)</code>
1327 <pre>Returns the specified Project resource.
1328
1329 To decrease latency for this method, you can optionally omit any unneeded
1330 information from the response by using a field mask. This practice is
1331 especially recommended for unused quota information (the `quotas` field).
1332 To exclude one or more fields, set your request&#x27;s `fields` query parameter
1333 to only include the fields you need. For example, to only include the `id`
1334 and `selfLink` fields, add the query parameter `?fields=id,selfLink` to
1335 your request.
1336
1337 Args:
1338 project: string, Project ID for this request. (required)
1339 x__xgafv: string, V1 error format.
1340 Allowed values
1341 1 - v1 error format
1342 2 - v2 error format
1343
1344 Returns:
1345 An object of the form:
1346
1347 { # Represents a Project resource.
1348 #
1349 # A project is used to organize resources in a Google Cloud Platform
1350 # environment. For more information, read about the
1351 # Resource Hierarchy.
1352 &quot;cloudArmorTier&quot;: &quot;A String&quot;, # Output only. [Output Only] The Cloud Armor tier for this project. It can be one of the
1353 # following values: CA_STANDARD,CA_ENTERPRISE_PAYGO.
1354 #
1355 # If this field is not specified, it is assumed to beCA_STANDARD.
1356 &quot;commonInstanceMetadata&quot;: { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this
1357 # project. See Custom
1358 # metadata for more information.
1359 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
1360 # the metadata&#x27;s contents and used for optimistic locking. The
1361 # fingerprint is initially generated by Compute Engine and changes after
1362 # every request to modify or update metadata. You must always provide an
1363 # up-to-date fingerprint hash in order to update or change metadata,
1364 # otherwise the request will fail with error412 conditionNotMet.
1365 #
1366 # To see the latest fingerprint, make a get() request to
1367 # retrieve the resource.
1368 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
1369 # less than 512 KB.
1370 { # Metadata
1371 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
1372 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
1373 # This is reflected as part of a URL in the metadata server. Additionally, to
1374 # avoid ambiguity, keys must not conflict with any other metadata keys
1375 # for the project.
1376 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
1377 # have meaning as interpreted by the image running in the instance. The
1378 # only restriction placed on values is that their size must be less than
1379 # or equal to 262144 bytes (256 KiB).
1380 },
1381 ],
1382 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
1383 # for metadata.
1384 },
1385 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
1386 # text format.
1387 &quot;defaultNetworkTier&quot;: &quot;A String&quot;, # This signifies the default network tier used for configuring resources of
1388 # the project and can only take the following values:PREMIUM, STANDARD. Initially the default network
1389 # tier is PREMIUM.
1390 &quot;defaultServiceAccount&quot;: &quot;A String&quot;, # [Output Only] Default service account used by VMs running in this project.
1391 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource.
1392 &quot;enabledFeatures&quot;: [ # An optional list of restricted features enabled for use on this project.
1393 &quot;A String&quot;,
1394 ],
1395 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1396 # defined by the server. This is *not* the project ID, and is
1397 # just a unique ID used by Compute Engine to identify resources.
1398 &quot;kind&quot;: &quot;compute#project&quot;, # Output only. [Output Only] Type of the resource. Always compute#project for
1399 # projects.
1400 &quot;name&quot;: &quot;A String&quot;, # The project ID. For example: my-example-project. Use the
1401 # project ID to make requests to Compute Engine.
1402 &quot;quotas&quot;: [ # [Output Only] Quotas assigned to this project.
1403 { # A quotas entry.
1404 &quot;limit&quot;: 3.14, # [Output Only] Quota limit for this metric.
1405 &quot;metric&quot;: &quot;A String&quot;, # [Output Only] Name of the quota metric.
1406 &quot;owner&quot;: &quot;A String&quot;, # [Output Only] Owning resource. This is the resource on which this quota
1407 # is applied.
1408 &quot;usage&quot;: 3.14, # [Output Only] Current usage of this metric.
1409 },
1410 ],
1411 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1412 &quot;usageExportLocation&quot;: { # The location in Cloud Storage and naming method of the daily usage # An optional naming prefix for daily usage reports and the Google Cloud
1413 # Storage bucket where they are stored.
1414 # report. Contains bucket_name and report_name prefix.
1415 &quot;bucketName&quot;: &quot;A String&quot;, # The name of an existing bucket in Cloud Storage where the usage report
1416 # object is stored. The Google Service Account is granted write access to
1417 # this bucket. This can either be the bucket name by itself, such asexample-bucket, or the bucket name with gs://
1418 # or https://storage.googleapis.com/ in front of it, such
1419 # as gs://example-bucket.
1420 &quot;reportNamePrefix&quot;: &quot;A String&quot;, # An optional prefix for the name of the usage report object stored inbucketName. If not supplied, defaults tousage_gce. The report is stored as a CSV file namedreport_name_prefix_gce_YYYYMMDD.csv whereYYYYMMDD is the day of the usage according to Pacific Time.
1421 # If you supply a prefix, it should conform to Cloud Storageobject naming
1422 # conventions.
1423 },
1424 &quot;vmDnsSetting&quot;: &quot;A String&quot;, # Output only. [Output Only] Default internal DNS setting used by VMs running in
1425 # this project.
1426 &quot;xpnProjectStatus&quot;: &quot;A String&quot;, # [Output Only] The role this project has in a shared VPC configuration.
1427 # Currently, only projects with the host role, which is specified by the
1428 # value HOST, are differentiated.
1429 }</pre>
1430 </div>
1431
1432 <div class="method">
1433 <code class="details" id="getXpnHost">getXpnHost(project, x__xgafv=None)</code>
1434 <pre>Gets the shared VPC host project that this project links to. May be empty
1435 if no link exists.
1436
1437 Args:
1438 project: string, Project ID for this request. (required)
1439 x__xgafv: string, V1 error format.
1440 Allowed values
1441 1 - v1 error format
1442 2 - v2 error format
1443
1444 Returns:
1445 An object of the form:
1446
1447 { # Represents a Project resource.
1448 #
1449 # A project is used to organize resources in a Google Cloud Platform
1450 # environment. For more information, read about the
1451 # Resource Hierarchy.
1452 &quot;cloudArmorTier&quot;: &quot;A String&quot;, # Output only. [Output Only] The Cloud Armor tier for this project. It can be one of the
1453 # following values: CA_STANDARD,CA_ENTERPRISE_PAYGO.
1454 #
1455 # If this field is not specified, it is assumed to beCA_STANDARD.
1456 &quot;commonInstanceMetadata&quot;: { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this
1457 # project. See Custom
1458 # metadata for more information.
1459 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
1460 # the metadata&#x27;s contents and used for optimistic locking. The
1461 # fingerprint is initially generated by Compute Engine and changes after
1462 # every request to modify or update metadata. You must always provide an
1463 # up-to-date fingerprint hash in order to update or change metadata,
1464 # otherwise the request will fail with error412 conditionNotMet.
1465 #
1466 # To see the latest fingerprint, make a get() request to
1467 # retrieve the resource.
1468 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
1469 # less than 512 KB.
1470 { # Metadata
1471 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
1472 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
1473 # This is reflected as part of a URL in the metadata server. Additionally, to
1474 # avoid ambiguity, keys must not conflict with any other metadata keys
1475 # for the project.
1476 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
1477 # have meaning as interpreted by the image running in the instance. The
1478 # only restriction placed on values is that their size must be less than
1479 # or equal to 262144 bytes (256 KiB).
1480 },
1481 ],
1482 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
1483 # for metadata.
1484 },
1485 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
1486 # text format.
1487 &quot;defaultNetworkTier&quot;: &quot;A String&quot;, # This signifies the default network tier used for configuring resources of
1488 # the project and can only take the following values:PREMIUM, STANDARD. Initially the default network
1489 # tier is PREMIUM.
1490 &quot;defaultServiceAccount&quot;: &quot;A String&quot;, # [Output Only] Default service account used by VMs running in this project.
1491 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource.
1492 &quot;enabledFeatures&quot;: [ # An optional list of restricted features enabled for use on this project.
1493 &quot;A String&quot;,
1494 ],
1495 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1496 # defined by the server. This is *not* the project ID, and is
1497 # just a unique ID used by Compute Engine to identify resources.
1498 &quot;kind&quot;: &quot;compute#project&quot;, # Output only. [Output Only] Type of the resource. Always compute#project for
1499 # projects.
1500 &quot;name&quot;: &quot;A String&quot;, # The project ID. For example: my-example-project. Use the
1501 # project ID to make requests to Compute Engine.
1502 &quot;quotas&quot;: [ # [Output Only] Quotas assigned to this project.
1503 { # A quotas entry.
1504 &quot;limit&quot;: 3.14, # [Output Only] Quota limit for this metric.
1505 &quot;metric&quot;: &quot;A String&quot;, # [Output Only] Name of the quota metric.
1506 &quot;owner&quot;: &quot;A String&quot;, # [Output Only] Owning resource. This is the resource on which this quota
1507 # is applied.
1508 &quot;usage&quot;: 3.14, # [Output Only] Current usage of this metric.
1509 },
1510 ],
1511 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1512 &quot;usageExportLocation&quot;: { # The location in Cloud Storage and naming method of the daily usage # An optional naming prefix for daily usage reports and the Google Cloud
1513 # Storage bucket where they are stored.
1514 # report. Contains bucket_name and report_name prefix.
1515 &quot;bucketName&quot;: &quot;A String&quot;, # The name of an existing bucket in Cloud Storage where the usage report
1516 # object is stored. The Google Service Account is granted write access to
1517 # this bucket. This can either be the bucket name by itself, such asexample-bucket, or the bucket name with gs://
1518 # or https://storage.googleapis.com/ in front of it, such
1519 # as gs://example-bucket.
1520 &quot;reportNamePrefix&quot;: &quot;A String&quot;, # An optional prefix for the name of the usage report object stored inbucketName. If not supplied, defaults tousage_gce. The report is stored as a CSV file namedreport_name_prefix_gce_YYYYMMDD.csv whereYYYYMMDD is the day of the usage according to Pacific Time.
1521 # If you supply a prefix, it should conform to Cloud Storageobject naming
1522 # conventions.
1523 },
1524 &quot;vmDnsSetting&quot;: &quot;A String&quot;, # Output only. [Output Only] Default internal DNS setting used by VMs running in
1525 # this project.
1526 &quot;xpnProjectStatus&quot;: &quot;A String&quot;, # [Output Only] The role this project has in a shared VPC configuration.
1527 # Currently, only projects with the host role, which is specified by the
1528 # value HOST, are differentiated.
1529 }</pre>
1530 </div>
1531
1532 <div class="method">
1533 <code class="details" id="getXpnResources">getXpnResources(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1534 <pre>Gets service resources (a.k.a service project) associated with this host
1535 project.
1536
1537 Args:
1538 project: string, Project ID for this request. (required)
1539 filter: string, A filter expression that filters resources listed in the response. Most
1540 Compute resources support two types of filter expressions:
1541 expressions that support regular expressions and expressions that follow
1542 API improvement proposal AIP-160.
1543 These two types of filter expressions cannot be mixed in one request.
1544
1545 If you want to use AIP-160, your expression must specify the field name, an
1546 operator, and the value that you want to use for filtering. The value
1547 must be a string, a number, or a boolean. The operator
1548 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1549
1550 For example, if you are filtering Compute Engine instances, you can
1551 exclude instances named `example-instance` by specifying
1552 `name != example-instance`.
1553
1554 The `:*` comparison can be used to test whether a key has been defined.
1555 For example, to find all objects with `owner` label use:
1556 ```
1557 labels.owner:*
1558 ```
1559
1560 You can also filter nested fields. For example, you could specify
1561 `scheduling.automaticRestart = false` to include instances only
1562 if they are not scheduled for automatic restarts. You can use filtering
1563 on nested fields to filter based onresource labels.
1564
1565 To filter on multiple expressions, provide each separate expression within
1566 parentheses. For example:
1567 ```
1568 (scheduling.automaticRestart = true)
1569 (cpuPlatform = &quot;Intel Skylake&quot;)
1570 ```
1571 By default, each expression is an `AND` expression. However, you
1572 can include `AND` and `OR` expressions explicitly.
1573 For example:
1574 ```
1575 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1576 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1577 (scheduling.automaticRestart = true)
1578 ```
1579
1580 If you want to use a regular expression, use the `eq` (equal) or `ne`
1581 (not equal) operator against a single un-parenthesized expression with or
1582 without quotes or against multiple parenthesized expressions. Examples:
1583
1584 `fieldname eq unquoted literal`
1585 `fieldname eq &#x27;single quoted literal&#x27;`
1586 `fieldname eq &quot;double quoted literal&quot;`
1587 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1588
1589 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1590 The literal value must match the entire field.
1591
1592 For example, to filter for instances that do not end with name &quot;instance&quot;,
1593 you would use `name ne .*instance`.
1594
1595 You cannot combine constraints on multiple fields using regular
1596 expressions.
1597 maxResults: integer, The maximum number of results per page that should be returned.
1598 If the number of available results is larger than `maxResults`,
1599 Compute Engine returns a `nextPageToken` that can be used to get
1600 the next page of results in subsequent list requests. Acceptable values are
1601 `0` to `500`, inclusive. (Default: `500`)
1602 orderBy: string, Sorts list results by a certain order. By default, results
1603 are returned in alphanumerical order based on the resource name.
1604
1605 You can also sort results in descending order based on the creation
1606 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1607 results based on the `creationTimestamp` field in
1608 reverse chronological order (newest result first). Use this to sort
1609 resources like operations so that the newest operation is returned first.
1610
1611 Currently, only sorting by `name` or
1612 `creationTimestamp desc` is supported.
1613 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1614 `nextPageToken` returned by a previous list request to get
1615 the next page of results.
1616 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1617 of failure. The default value is false.
1618
1619 For example, when partial success behavior is enabled, aggregatedList for a
1620 single zone scope either returns all resources in the zone or no resources,
1621 with an error code.
1622 x__xgafv: string, V1 error format.
1623 Allowed values
1624 1 - v1 error format
1625 2 - v2 error format
1626
1627 Returns:
1628 An object of the form:
1629
1630 {
1631 &quot;kind&quot;: &quot;compute#projectsGetXpnResources&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#projectsGetXpnResources for lists of service resources
1632 # (a.k.a service projects)
1633 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
1634 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1635 # the query parameter pageToken in the next list request.
1636 # Subsequent list requests will have their own nextPageToken to
1637 # continue paging through the results.
1638 &quot;resources&quot;: [ # Service resources (a.k.a service projects) attached to this project as
1639 # their shared VPC host.
1640 { # Service resource (a.k.a service project) ID.
1641 &quot;id&quot;: &quot;A String&quot;, # The ID of the service resource. In the case of projects, this field
1642 # supports project id (e.g., my-project-123) and project number
1643 # (e.g. 12345678).
1644 &quot;type&quot;: &quot;A String&quot;, # The type of the service resource.
1645 },
1646 ],
1647 }</pre>
1648 </div>
1649
1650 <div class="method">
1651 <code class="details" id="getXpnResources_next">getXpnResources_next()</code>
1652 <pre>Retrieves the next page of results.
1653
1654 Args:
1655 previous_request: The request for the previous page. (required)
1656 previous_response: The response from the request for the previous page. (required)
1657
1658 Returns:
1659 A request object that you can call &#x27;execute()&#x27; on to request the next
1660 page. Returns None if there are no more items in the collection.
1661 </pre>
1662 </div>
1663
1664 <div class="method">
1665 <code class="details" id="listXpnHosts">listXpnHosts(project, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1666 <pre>Lists all shared VPC host projects visible to the user in an organization.
1667
1668 Args:
1669 project: string, Project ID for this request. (required)
1670 body: object, The request body.
1671 The object takes the form of:
1672
1673 {
1674 &quot;organization&quot;: &quot;A String&quot;, # Optional organization ID managed by Cloud Resource Manager, for which to
1675 # list shared VPC host projects. If not specified, the organization will be
1676 # inferred from the project.
1677 }
1678
1679 filter: string, A filter expression that filters resources listed in the response. Most
1680 Compute resources support two types of filter expressions:
1681 expressions that support regular expressions and expressions that follow
1682 API improvement proposal AIP-160.
1683 These two types of filter expressions cannot be mixed in one request.
1684
1685 If you want to use AIP-160, your expression must specify the field name, an
1686 operator, and the value that you want to use for filtering. The value
1687 must be a string, a number, or a boolean. The operator
1688 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1689
1690 For example, if you are filtering Compute Engine instances, you can
1691 exclude instances named `example-instance` by specifying
1692 `name != example-instance`.
1693
1694 The `:*` comparison can be used to test whether a key has been defined.
1695 For example, to find all objects with `owner` label use:
1696 ```
1697 labels.owner:*
1698 ```
1699
1700 You can also filter nested fields. For example, you could specify
1701 `scheduling.automaticRestart = false` to include instances only
1702 if they are not scheduled for automatic restarts. You can use filtering
1703 on nested fields to filter based onresource labels.
1704
1705 To filter on multiple expressions, provide each separate expression within
1706 parentheses. For example:
1707 ```
1708 (scheduling.automaticRestart = true)
1709 (cpuPlatform = &quot;Intel Skylake&quot;)
1710 ```
1711 By default, each expression is an `AND` expression. However, you
1712 can include `AND` and `OR` expressions explicitly.
1713 For example:
1714 ```
1715 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1716 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1717 (scheduling.automaticRestart = true)
1718 ```
1719
1720 If you want to use a regular expression, use the `eq` (equal) or `ne`
1721 (not equal) operator against a single un-parenthesized expression with or
1722 without quotes or against multiple parenthesized expressions. Examples:
1723
1724 `fieldname eq unquoted literal`
1725 `fieldname eq &#x27;single quoted literal&#x27;`
1726 `fieldname eq &quot;double quoted literal&quot;`
1727 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1728
1729 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1730 The literal value must match the entire field.
1731
1732 For example, to filter for instances that do not end with name &quot;instance&quot;,
1733 you would use `name ne .*instance`.
1734
1735 You cannot combine constraints on multiple fields using regular
1736 expressions.
1737 maxResults: integer, The maximum number of results per page that should be returned.
1738 If the number of available results is larger than `maxResults`,
1739 Compute Engine returns a `nextPageToken` that can be used to get
1740 the next page of results in subsequent list requests. Acceptable values are
1741 `0` to `500`, inclusive. (Default: `500`)
1742 orderBy: string, Sorts list results by a certain order. By default, results
1743 are returned in alphanumerical order based on the resource name.
1744
1745 You can also sort results in descending order based on the creation
1746 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1747 results based on the `creationTimestamp` field in
1748 reverse chronological order (newest result first). Use this to sort
1749 resources like operations so that the newest operation is returned first.
1750
1751 Currently, only sorting by `name` or
1752 `creationTimestamp desc` is supported.
1753 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1754 `nextPageToken` returned by a previous list request to get
1755 the next page of results.
1756 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1757 of failure. The default value is false.
1758
1759 For example, when partial success behavior is enabled, aggregatedList for a
1760 single zone scope either returns all resources in the zone or no resources,
1761 with an error code.
1762 x__xgafv: string, V1 error format.
1763 Allowed values
1764 1 - v1 error format
1765 2 - v2 error format
1766
1767 Returns:
1768 An object of the form:
1769
1770 {
1771 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1772 &quot;items&quot;: [ # [Output Only] A list of shared VPC host project URLs.
1773 { # Represents a Project resource.
1774 #
1775 # A project is used to organize resources in a Google Cloud Platform
1776 # environment. For more information, read about the
1777 # Resource Hierarchy.
1778 &quot;cloudArmorTier&quot;: &quot;A String&quot;, # Output only. [Output Only] The Cloud Armor tier for this project. It can be one of the
1779 # following values: CA_STANDARD,CA_ENTERPRISE_PAYGO.
1780 #
1781 # If this field is not specified, it is assumed to beCA_STANDARD.
1782 &quot;commonInstanceMetadata&quot;: { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this
1783 # project. See Custom
1784 # metadata for more information.
1785 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
1786 # the metadata&#x27;s contents and used for optimistic locking. The
1787 # fingerprint is initially generated by Compute Engine and changes after
1788 # every request to modify or update metadata. You must always provide an
1789 # up-to-date fingerprint hash in order to update or change metadata,
1790 # otherwise the request will fail with error412 conditionNotMet.
1791 #
1792 # To see the latest fingerprint, make a get() request to
1793 # retrieve the resource.
1794 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
1795 # less than 512 KB.
1796 { # Metadata
1797 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
1798 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
1799 # This is reflected as part of a URL in the metadata server. Additionally, to
1800 # avoid ambiguity, keys must not conflict with any other metadata keys
1801 # for the project.
1802 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
1803 # have meaning as interpreted by the image running in the instance. The
1804 # only restriction placed on values is that their size must be less than
1805 # or equal to 262144 bytes (256 KiB).
1806 },
1807 ],
1808 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
1809 # for metadata.
1810 },
1811 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
1812 # text format.
1813 &quot;defaultNetworkTier&quot;: &quot;A String&quot;, # This signifies the default network tier used for configuring resources of
1814 # the project and can only take the following values:PREMIUM, STANDARD. Initially the default network
1815 # tier is PREMIUM.
1816 &quot;defaultServiceAccount&quot;: &quot;A String&quot;, # [Output Only] Default service account used by VMs running in this project.
1817 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource.
1818 &quot;enabledFeatures&quot;: [ # An optional list of restricted features enabled for use on this project.
1819 &quot;A String&quot;,
1820 ],
1821 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1822 # defined by the server. This is *not* the project ID, and is
1823 # just a unique ID used by Compute Engine to identify resources.
1824 &quot;kind&quot;: &quot;compute#project&quot;, # Output only. [Output Only] Type of the resource. Always compute#project for
1825 # projects.
1826 &quot;name&quot;: &quot;A String&quot;, # The project ID. For example: my-example-project. Use the
1827 # project ID to make requests to Compute Engine.
1828 &quot;quotas&quot;: [ # [Output Only] Quotas assigned to this project.
1829 { # A quotas entry.
1830 &quot;limit&quot;: 3.14, # [Output Only] Quota limit for this metric.
1831 &quot;metric&quot;: &quot;A String&quot;, # [Output Only] Name of the quota metric.
1832 &quot;owner&quot;: &quot;A String&quot;, # [Output Only] Owning resource. This is the resource on which this quota
1833 # is applied.
1834 &quot;usage&quot;: 3.14, # [Output Only] Current usage of this metric.
1835 },
1836 ],
1837 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1838 &quot;usageExportLocation&quot;: { # The location in Cloud Storage and naming method of the daily usage # An optional naming prefix for daily usage reports and the Google Cloud
1839 # Storage bucket where they are stored.
1840 # report. Contains bucket_name and report_name prefix.
1841 &quot;bucketName&quot;: &quot;A String&quot;, # The name of an existing bucket in Cloud Storage where the usage report
1842 # object is stored. The Google Service Account is granted write access to
1843 # this bucket. This can either be the bucket name by itself, such asexample-bucket, or the bucket name with gs://
1844 # or https://storage.googleapis.com/ in front of it, such
1845 # as gs://example-bucket.
1846 &quot;reportNamePrefix&quot;: &quot;A String&quot;, # An optional prefix for the name of the usage report object stored inbucketName. If not supplied, defaults tousage_gce. The report is stored as a CSV file namedreport_name_prefix_gce_YYYYMMDD.csv whereYYYYMMDD is the day of the usage according to Pacific Time.
1847 # If you supply a prefix, it should conform to Cloud Storageobject naming
1848 # conventions.
1849 },
1850 &quot;vmDnsSetting&quot;: &quot;A String&quot;, # Output only. [Output Only] Default internal DNS setting used by VMs running in
1851 # this project.
1852 &quot;xpnProjectStatus&quot;: &quot;A String&quot;, # [Output Only] The role this project has in a shared VPC configuration.
1853 # Currently, only projects with the host role, which is specified by the
1854 # value HOST, are differentiated.
1855 },
1856 ],
1857 &quot;kind&quot;: &quot;compute#xpnHostList&quot;, # Output only. [Output Only] Type of resource. Always compute#xpnHostList for
1858 # lists of shared VPC hosts.
1859 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1860 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1861 # the query parameter pageToken in the next list request.
1862 # Subsequent list requests will have their own nextPageToken to
1863 # continue paging through the results.
1864 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1865 &quot;warning&quot;: { # [Output Only] Informational warning message.
1866 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1867 # Engine returns NO_RESULTS_ON_PAGE if there
1868 # are no results in the response.
1869 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1870 # value format. For example:
1871 #
1872 # &quot;data&quot;: [
1873 # {
1874 # &quot;key&quot;: &quot;scope&quot;,
1875 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1876 # }
1877 {
1878 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1879 # returned. For example, for warnings where there are no results in a list
1880 # request for a particular zone, this key might be scope and
1881 # the key value might be the zone name. Other examples might be a key
1882 # indicating a deprecated resource and a suggested replacement, or a
1883 # warning about invalid network settings (for example, if an instance
1884 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1885 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1886 },
1887 ],
1888 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1889 },
1890 }</pre>
1891 </div>
1892
1893 <div class="method">
1894 <code class="details" id="listXpnHosts_next">listXpnHosts_next()</code>
1895 <pre>Retrieves the next page of results.
1896
1897 Args:
1898 previous_request: The request for the previous page. (required)
1899 previous_response: The response from the request for the previous page. (required)
1900
1901 Returns:
1902 A request object that you can call &#x27;execute()&#x27; on to request the next
1903 page. Returns None if there are no more items in the collection.
1904 </pre>
1905 </div>
1906
1907 <div class="method">
1908 <code class="details" id="moveDisk">moveDisk(project, body=None, requestId=None, x__xgafv=None)</code>
1909 <pre>Moves a persistent disk from one zone to another.
1910 *Note*: The moveDisk API will be deprecated on September 29, 2026.
1911
1912 Starting September 29, 2025, you can&#x27;t use the moveDisk API on new
1913 projects. To move a disk to a different region or zone, follow the steps in
1914 [Change the location of a
1915 disk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).
1916
1917 Projects that already use the moveDisk API can continue usage until
1918 September 29, 2026.
1919
1920 Starting November 1, 2025, API responses will include a warning message in
1921 the response body about the upcoming deprecation. You can skip the message
1922 to continue using the service without interruption.
1923
1924 Args:
1925 project: string, Project ID for this request. (required)
1926 body: object, The request body.
1927 The object takes the form of:
1928
1929 {
1930 &quot;destinationZone&quot;: &quot;A String&quot;, # The URL of the destination zone to move the disk. This can be a full or
1931 # partial URL. For example, the following are all valid URLs to a zone:
1932 #
1933 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
1934 # - projects/project/zones/zone
1935 # - zones/zone
1936 &quot;targetDisk&quot;: &quot;A String&quot;, # The URL of the target disk to move. This can be a full or partial URL.
1937 # For example, the following are all valid URLs to a disk:
1938 #
1939 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
1940 # - projects/project/zones/zone/disks/disk
1941 # - zones/zone/disks/disk
1942 }
1943
1944 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1945 that if you must retry your request, the server will know to ignore the
1946 request if it has already been completed.
1947
1948 For example, consider a situation where you make an initial request and
1949 the request times out. If you make the request again with the same
1950 request ID, the server can check if original operation with the same
1951 request ID was received, and if so, will ignore the second request. This
1952 prevents clients from accidentally creating duplicate commitments.
1953
1954 The request ID must be
1955 a valid UUID with the exception that zero UUID is not supported
1956 (00000000-0000-0000-0000-000000000000).
1957 x__xgafv: string, V1 error format.
1958 Allowed values
1959 1 - v1 error format
1960 2 - v2 error format
1961
1962 Returns:
1963 An object of the form:
1964
1965 { # Represents an Operation resource.
1966 #
1967 # Google Compute Engine has three Operation resources:
1968 #
1969 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1970 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1971 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1972 #
1973 # You can use an operation resource to manage asynchronous API requests.
1974 # For more information, readHandling
1975 # API responses.
1976 #
1977 # Operations can be global, regional or zonal.
1978 #
1979 # - For global operations, use the `globalOperations`
1980 # resource.
1981 # - For regional operations, use the
1982 # `regionOperations` resource.
1983 # - For zonal operations, use
1984 # the `zoneOperations` resource.
1985 #
1986 #
1987 #
1988 # For more information, read
1989 # Global, Regional, and Zonal Resources.
1990 #
1991 # Note that completed Operation resources have a limited
1992 # retention period.
1993 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1994 # Not present otherwise.
1995 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1996 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1997 # set when the operation is created.
1998 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1999 # text format.
2000 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2001 # this field will be populated.
2002 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2003 # operation.
2004 {
2005 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2006 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2007 # details. There is a set of defined message types to use for providing
2008 # details.The syntax depends on the error code. For example,
2009 # QuotaExceededInfo will have details when the error code is
2010 # QUOTA_EXCEEDED.
2011 {
2012 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2013 #
2014 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2015 # is not enabled:
2016 #
2017 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2018 # &quot;domain&quot;: &quot;googleapis.com&quot;
2019 # &quot;metadata&quot;: {
2020 # &quot;resource&quot;: &quot;projects/123&quot;,
2021 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2022 # }
2023 # }
2024 #
2025 # This response indicates that the pubsub.googleapis.com API is not enabled.
2026 #
2027 # Example of an error that is returned when attempting to create a Spanner
2028 # instance in a region that is out of stock:
2029 #
2030 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2031 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2032 # &quot;metadata&quot;: {
2033 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2034 # }
2035 # }
2036 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2037 # is typically the registered service name of the tool or product that
2038 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2039 # generated by some common infrastructure, the error domain must be a
2040 # globally unique value that identifies the infrastructure. For Google API
2041 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2042 &quot;metadatas&quot;: { # Additional structured details about this error.
2043 #
2044 # Keys must match a regular expression of `a-z+` but should
2045 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2046 # length. When identifying the current value of an exceeded limit, the units
2047 # should be contained in the key, not the value. For example, rather than
2048 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2049 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2050 # instances that can be created in a single (batch) request.
2051 &quot;a_key&quot;: &quot;A String&quot;,
2052 },
2053 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2054 # proximate cause of the error. Error reasons are unique within a particular
2055 # domain of errors. This should be at most 63 characters and match a
2056 # regular expression of `A-Z+[A-Z0-9]`, which represents
2057 # UPPER_SNAKE_CASE.
2058 },
2059 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2060 #
2061 # For example, if a quota check failed with an error indicating the calling
2062 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2063 # directly to the right place in the developer console to flip the bit.
2064 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2065 { # Describes a URL link.
2066 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2067 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2068 },
2069 ],
2070 },
2071 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2072 # which can be attached to an RPC error.
2073 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2074 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2075 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2076 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2077 },
2078 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2079 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2080 &quot;a_key&quot;: &quot;A String&quot;,
2081 },
2082 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2083 # type or metric.
2084 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2085 # or metric.
2086 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2087 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2088 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2089 },
2090 },
2091 ],
2092 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2093 # This property is optional.
2094 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2095 },
2096 ],
2097 },
2098 &quot;getVersionOperationMetadata&quot;: {
2099 &quot;inlineSbomInfo&quot;: {
2100 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2101 # appropriate identifiers.
2102 &quot;a_key&quot;: &quot;A String&quot;,
2103 },
2104 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2105 # identifiers.
2106 &quot;a_key&quot;: &quot;A String&quot;,
2107 },
2108 },
2109 },
2110 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2111 # message that was returned, such as `NOT FOUND`.
2112 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2113 # status code that was returned. For example, a `404` means the
2114 # resource was not found.
2115 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2116 # defined by the server.
2117 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2118 # This value is inRFC3339
2119 # text format.
2120 &quot;instancesBulkInsertOperationMetadata&quot;: {
2121 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2122 # Example key: zones/us-central1-a
2123 &quot;a_key&quot;: {
2124 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2125 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2126 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2127 # error.
2128 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2129 # if the flow is rolling forward or rolling back.
2130 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2131 },
2132 },
2133 },
2134 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2135 # Operation resources.
2136 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2137 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2138 # group of operations results from a `bulkInsert` API request.
2139 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2140 # `update`, or `delete`, and so on.
2141 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2142 # There is no requirement that this be linear or support any granularity of
2143 # operations. This should not be used to guess when the operation will be
2144 # complete. This number should monotonically increase as the operation
2145 # progresses.
2146 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2147 # applicable when performing regional operations.
2148 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2149 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2150 # this field will contain information on all underlying zonal actions and
2151 # their state.
2152 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2153 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2154 # Example key: zones/us-central1-a
2155 &quot;a_key&quot;: {
2156 &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
2157 # populated.
2158 # different programming environments, including REST APIs and RPC APIs. It is
2159 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2160 # three pieces of data: error code, error message, and error details.
2161 #
2162 # You can find out more about this error model and how to work with it in the
2163 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2164 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2165 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2166 # message types for APIs to use.
2167 {
2168 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2169 },
2170 ],
2171 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2172 # user-facing error message should be localized and sent in the
2173 # google.rpc.Status.details field, or localized by the client.
2174 },
2175 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2176 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2177 },
2178 },
2179 },
2180 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2181 # This value is inRFC3339
2182 # text format.
2183 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2184 # following:
2185 # `PENDING`, `RUNNING`, or `DONE`.
2186 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2187 # operation.
2188 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2189 # of the target resource.
2190 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2191 # operations related to creating a snapshot, this points to the disk
2192 # that the snapshot was created from.
2193 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2194 # `[email protected]` or
2195 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2196 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2197 # operation, this field will be populated.
2198 {
2199 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2200 # Engine returns NO_RESULTS_ON_PAGE if there
2201 # are no results in the response.
2202 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2203 # value format. For example:
2204 #
2205 # &quot;data&quot;: [
2206 # {
2207 # &quot;key&quot;: &quot;scope&quot;,
2208 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2209 # }
2210 {
2211 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2212 # returned. For example, for warnings where there are no results in a list
2213 # request for a particular zone, this key might be scope and
2214 # the key value might be the zone name. Other examples might be a key
2215 # indicating a deprecated resource and a suggested replacement, or a
2216 # warning about invalid network settings (for example, if an instance
2217 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2218 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2219 },
2220 ],
2221 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2222 },
2223 ],
2224 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2225 # applicable when performing per-zone operations.
2226 }</pre>
2227 </div>
2228
2229 <div class="method">
2230 <code class="details" id="moveInstance">moveInstance(project, body=None, requestId=None, x__xgafv=None)</code>
2231 <pre>Moves an instance and its attached persistent disks from one zone to
2232 another.
2233 *Note*: Moving VMs or disks by using this method might
2234 cause unexpected behavior. For more information, see the [known
2235 issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).
2236 [Deprecated] This method is deprecated. See [moving instance across
2237 zones](/compute/docs/instances/moving-instance-across-zones) instead.
2238
2239 Args:
2240 project: string, Project ID for this request. (required)
2241 body: object, The request body.
2242 The object takes the form of:
2243
2244 {
2245 &quot;destinationZone&quot;: &quot;A String&quot;, # The URL of the destination zone to move the instance. This can be a full or
2246 # partial URL. For example, the following are all valid URLs to a zone:
2247 #
2248 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
2249 # - projects/project/zones/zone
2250 # - zones/zone
2251 &quot;targetInstance&quot;: &quot;A String&quot;, # The URL of the target instance to move. This can be a full or partial URL.
2252 # For example, the following are all valid URLs to an instance:
2253 #
2254 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
2255 # - projects/project/zones/zone/instances/instance
2256 # - zones/zone/instances/instance
2257 }
2258
2259 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2260 that if you must retry your request, the server will know to ignore the
2261 request if it has already been completed.
2262
2263 For example, consider a situation where you make an initial request and
2264 the request times out. If you make the request again with the same
2265 request ID, the server can check if original operation with the same
2266 request ID was received, and if so, will ignore the second request. This
2267 prevents clients from accidentally creating duplicate commitments.
2268
2269 The request ID must be
2270 a valid UUID with the exception that zero UUID is not supported
2271 (00000000-0000-0000-0000-000000000000).
2272 x__xgafv: string, V1 error format.
2273 Allowed values
2274 1 - v1 error format
2275 2 - v2 error format
2276
2277 Returns:
2278 An object of the form:
2279
2280 { # Represents an Operation resource.
2281 #
2282 # Google Compute Engine has three Operation resources:
2283 #
2284 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2285 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2286 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2287 #
2288 # You can use an operation resource to manage asynchronous API requests.
2289 # For more information, readHandling
2290 # API responses.
2291 #
2292 # Operations can be global, regional or zonal.
2293 #
2294 # - For global operations, use the `globalOperations`
2295 # resource.
2296 # - For regional operations, use the
2297 # `regionOperations` resource.
2298 # - For zonal operations, use
2299 # the `zoneOperations` resource.
2300 #
2301 #
2302 #
2303 # For more information, read
2304 # Global, Regional, and Zonal Resources.
2305 #
2306 # Note that completed Operation resources have a limited
2307 # retention period.
2308 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2309 # Not present otherwise.
2310 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2311 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2312 # set when the operation is created.
2313 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2314 # text format.
2315 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2316 # this field will be populated.
2317 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2318 # operation.
2319 {
2320 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2321 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2322 # details. There is a set of defined message types to use for providing
2323 # details.The syntax depends on the error code. For example,
2324 # QuotaExceededInfo will have details when the error code is
2325 # QUOTA_EXCEEDED.
2326 {
2327 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2328 #
2329 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2330 # is not enabled:
2331 #
2332 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2333 # &quot;domain&quot;: &quot;googleapis.com&quot;
2334 # &quot;metadata&quot;: {
2335 # &quot;resource&quot;: &quot;projects/123&quot;,
2336 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2337 # }
2338 # }
2339 #
2340 # This response indicates that the pubsub.googleapis.com API is not enabled.
2341 #
2342 # Example of an error that is returned when attempting to create a Spanner
2343 # instance in a region that is out of stock:
2344 #
2345 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2346 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2347 # &quot;metadata&quot;: {
2348 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2349 # }
2350 # }
2351 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2352 # is typically the registered service name of the tool or product that
2353 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2354 # generated by some common infrastructure, the error domain must be a
2355 # globally unique value that identifies the infrastructure. For Google API
2356 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2357 &quot;metadatas&quot;: { # Additional structured details about this error.
2358 #
2359 # Keys must match a regular expression of `a-z+` but should
2360 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2361 # length. When identifying the current value of an exceeded limit, the units
2362 # should be contained in the key, not the value. For example, rather than
2363 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2364 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2365 # instances that can be created in a single (batch) request.
2366 &quot;a_key&quot;: &quot;A String&quot;,
2367 },
2368 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2369 # proximate cause of the error. Error reasons are unique within a particular
2370 # domain of errors. This should be at most 63 characters and match a
2371 # regular expression of `A-Z+[A-Z0-9]`, which represents
2372 # UPPER_SNAKE_CASE.
2373 },
2374 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2375 #
2376 # For example, if a quota check failed with an error indicating the calling
2377 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2378 # directly to the right place in the developer console to flip the bit.
2379 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2380 { # Describes a URL link.
2381 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2382 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2383 },
2384 ],
2385 },
2386 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2387 # which can be attached to an RPC error.
2388 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2389 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2390 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2391 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2392 },
2393 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2394 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2395 &quot;a_key&quot;: &quot;A String&quot;,
2396 },
2397 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2398 # type or metric.
2399 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2400 # or metric.
2401 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2402 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2403 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2404 },
2405 },
2406 ],
2407 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2408 # This property is optional.
2409 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2410 },
2411 ],
2412 },
2413 &quot;getVersionOperationMetadata&quot;: {
2414 &quot;inlineSbomInfo&quot;: {
2415 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2416 # appropriate identifiers.
2417 &quot;a_key&quot;: &quot;A String&quot;,
2418 },
2419 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2420 # identifiers.
2421 &quot;a_key&quot;: &quot;A String&quot;,
2422 },
2423 },
2424 },
2425 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2426 # message that was returned, such as `NOT FOUND`.
2427 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2428 # status code that was returned. For example, a `404` means the
2429 # resource was not found.
2430 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2431 # defined by the server.
2432 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2433 # This value is inRFC3339
2434 # text format.
2435 &quot;instancesBulkInsertOperationMetadata&quot;: {
2436 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2437 # Example key: zones/us-central1-a
2438 &quot;a_key&quot;: {
2439 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2440 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2441 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2442 # error.
2443 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2444 # if the flow is rolling forward or rolling back.
2445 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2446 },
2447 },
2448 },
2449 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2450 # Operation resources.
2451 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2452 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2453 # group of operations results from a `bulkInsert` API request.
2454 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2455 # `update`, or `delete`, and so on.
2456 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2457 # There is no requirement that this be linear or support any granularity of
2458 # operations. This should not be used to guess when the operation will be
2459 # complete. This number should monotonically increase as the operation
2460 # progresses.
2461 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2462 # applicable when performing regional operations.
2463 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2464 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2465 # this field will contain information on all underlying zonal actions and
2466 # their state.
2467 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2468 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2469 # Example key: zones/us-central1-a
2470 &quot;a_key&quot;: {
2471 &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
2472 # populated.
2473 # different programming environments, including REST APIs and RPC APIs. It is
2474 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2475 # three pieces of data: error code, error message, and error details.
2476 #
2477 # You can find out more about this error model and how to work with it in the
2478 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2479 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2480 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2481 # message types for APIs to use.
2482 {
2483 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2484 },
2485 ],
2486 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2487 # user-facing error message should be localized and sent in the
2488 # google.rpc.Status.details field, or localized by the client.
2489 },
2490 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2491 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2492 },
2493 },
2494 },
2495 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2496 # This value is inRFC3339
2497 # text format.
2498 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2499 # following:
2500 # `PENDING`, `RUNNING`, or `DONE`.
2501 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2502 # operation.
2503 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2504 # of the target resource.
2505 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2506 # operations related to creating a snapshot, this points to the disk
2507 # that the snapshot was created from.
2508 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2509 # `[email protected]` or
2510 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2511 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2512 # operation, this field will be populated.
2513 {
2514 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2515 # Engine returns NO_RESULTS_ON_PAGE if there
2516 # are no results in the response.
2517 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2518 # value format. For example:
2519 #
2520 # &quot;data&quot;: [
2521 # {
2522 # &quot;key&quot;: &quot;scope&quot;,
2523 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2524 # }
2525 {
2526 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2527 # returned. For example, for warnings where there are no results in a list
2528 # request for a particular zone, this key might be scope and
2529 # the key value might be the zone name. Other examples might be a key
2530 # indicating a deprecated resource and a suggested replacement, or a
2531 # warning about invalid network settings (for example, if an instance
2532 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2533 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2534 },
2535 ],
2536 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2537 },
2538 ],
2539 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2540 # applicable when performing per-zone operations.
2541 }</pre>
2542 </div>
2543
2544 <div class="method">
2545 <code class="details" id="setCloudArmorTier">setCloudArmorTier(project, body=None, requestId=None, x__xgafv=None)</code>
2546 <pre>Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the
2547 billing account of the project must be subscribed to Cloud Armor
2548 Enterprise. See Subscribing
2549 to Cloud Armor Enterprise for more information.
2550
2551 Args:
2552 project: string, Project ID for this request. (required)
2553 body: object, The request body.
2554 The object takes the form of:
2555
2556 {
2557 &quot;cloudArmorTier&quot;: &quot;A String&quot;, # Managed protection tier to be set.
2558 }
2559
2560 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2561 that if you must retry your request, the server will know to ignore the
2562 request if it has already been completed.
2563
2564 For example, consider a situation where you make an initial request and
2565 the request times out. If you make the request again with the same
2566 request ID, the server can check if original operation with the same
2567 request ID was received, and if so, will ignore the second request. This
2568 prevents clients from accidentally creating duplicate commitments.
2569
2570 The request ID must be
2571 a valid UUID with the exception that zero UUID is not supported
2572 (00000000-0000-0000-0000-000000000000).
2573 x__xgafv: string, V1 error format.
2574 Allowed values
2575 1 - v1 error format
2576 2 - v2 error format
2577
2578 Returns:
2579 An object of the form:
2580
2581 { # Represents an Operation resource.
2582 #
2583 # Google Compute Engine has three Operation resources:
2584 #
2585 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2586 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2587 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2588 #
2589 # You can use an operation resource to manage asynchronous API requests.
2590 # For more information, readHandling
2591 # API responses.
2592 #
2593 # Operations can be global, regional or zonal.
2594 #
2595 # - For global operations, use the `globalOperations`
2596 # resource.
2597 # - For regional operations, use the
2598 # `regionOperations` resource.
2599 # - For zonal operations, use
2600 # the `zoneOperations` resource.
2601 #
2602 #
2603 #
2604 # For more information, read
2605 # Global, Regional, and Zonal Resources.
2606 #
2607 # Note that completed Operation resources have a limited
2608 # retention period.
2609 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2610 # Not present otherwise.
2611 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2612 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2613 # set when the operation is created.
2614 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2615 # text format.
2616 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2617 # this field will be populated.
2618 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2619 # operation.
2620 {
2621 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2622 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2623 # details. There is a set of defined message types to use for providing
2624 # details.The syntax depends on the error code. For example,
2625 # QuotaExceededInfo will have details when the error code is
2626 # QUOTA_EXCEEDED.
2627 {
2628 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2629 #
2630 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2631 # is not enabled:
2632 #
2633 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2634 # &quot;domain&quot;: &quot;googleapis.com&quot;
2635 # &quot;metadata&quot;: {
2636 # &quot;resource&quot;: &quot;projects/123&quot;,
2637 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2638 # }
2639 # }
2640 #
2641 # This response indicates that the pubsub.googleapis.com API is not enabled.
2642 #
2643 # Example of an error that is returned when attempting to create a Spanner
2644 # instance in a region that is out of stock:
2645 #
2646 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2647 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2648 # &quot;metadata&quot;: {
2649 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2650 # }
2651 # }
2652 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2653 # is typically the registered service name of the tool or product that
2654 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2655 # generated by some common infrastructure, the error domain must be a
2656 # globally unique value that identifies the infrastructure. For Google API
2657 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2658 &quot;metadatas&quot;: { # Additional structured details about this error.
2659 #
2660 # Keys must match a regular expression of `a-z+` but should
2661 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2662 # length. When identifying the current value of an exceeded limit, the units
2663 # should be contained in the key, not the value. For example, rather than
2664 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2665 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2666 # instances that can be created in a single (batch) request.
2667 &quot;a_key&quot;: &quot;A String&quot;,
2668 },
2669 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2670 # proximate cause of the error. Error reasons are unique within a particular
2671 # domain of errors. This should be at most 63 characters and match a
2672 # regular expression of `A-Z+[A-Z0-9]`, which represents
2673 # UPPER_SNAKE_CASE.
2674 },
2675 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2676 #
2677 # For example, if a quota check failed with an error indicating the calling
2678 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2679 # directly to the right place in the developer console to flip the bit.
2680 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2681 { # Describes a URL link.
2682 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2683 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2684 },
2685 ],
2686 },
2687 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2688 # which can be attached to an RPC error.
2689 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2690 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2691 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2692 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2693 },
2694 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2695 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2696 &quot;a_key&quot;: &quot;A String&quot;,
2697 },
2698 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2699 # type or metric.
2700 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2701 # or metric.
2702 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2703 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2704 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2705 },
2706 },
2707 ],
2708 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2709 # This property is optional.
2710 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2711 },
2712 ],
2713 },
2714 &quot;getVersionOperationMetadata&quot;: {
2715 &quot;inlineSbomInfo&quot;: {
2716 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2717 # appropriate identifiers.
2718 &quot;a_key&quot;: &quot;A String&quot;,
2719 },
2720 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2721 # identifiers.
2722 &quot;a_key&quot;: &quot;A String&quot;,
2723 },
2724 },
2725 },
2726 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2727 # message that was returned, such as `NOT FOUND`.
2728 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2729 # status code that was returned. For example, a `404` means the
2730 # resource was not found.
2731 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2732 # defined by the server.
2733 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2734 # This value is inRFC3339
2735 # text format.
2736 &quot;instancesBulkInsertOperationMetadata&quot;: {
2737 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2738 # Example key: zones/us-central1-a
2739 &quot;a_key&quot;: {
2740 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2741 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2742 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2743 # error.
2744 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2745 # if the flow is rolling forward or rolling back.
2746 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2747 },
2748 },
2749 },
2750 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2751 # Operation resources.
2752 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2753 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2754 # group of operations results from a `bulkInsert` API request.
2755 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2756 # `update`, or `delete`, and so on.
2757 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2758 # There is no requirement that this be linear or support any granularity of
2759 # operations. This should not be used to guess when the operation will be
2760 # complete. This number should monotonically increase as the operation
2761 # progresses.
2762 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2763 # applicable when performing regional operations.
2764 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2765 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2766 # this field will contain information on all underlying zonal actions and
2767 # their state.
2768 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2769 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2770 # Example key: zones/us-central1-a
2771 &quot;a_key&quot;: {
2772 &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
2773 # populated.
2774 # different programming environments, including REST APIs and RPC APIs. It is
2775 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2776 # three pieces of data: error code, error message, and error details.
2777 #
2778 # You can find out more about this error model and how to work with it in the
2779 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2780 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2781 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2782 # message types for APIs to use.
2783 {
2784 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2785 },
2786 ],
2787 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2788 # user-facing error message should be localized and sent in the
2789 # google.rpc.Status.details field, or localized by the client.
2790 },
2791 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2792 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2793 },
2794 },
2795 },
2796 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2797 # This value is inRFC3339
2798 # text format.
2799 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2800 # following:
2801 # `PENDING`, `RUNNING`, or `DONE`.
2802 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2803 # operation.
2804 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2805 # of the target resource.
2806 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2807 # operations related to creating a snapshot, this points to the disk
2808 # that the snapshot was created from.
2809 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2810 # `[email protected]` or
2811 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2812 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2813 # operation, this field will be populated.
2814 {
2815 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2816 # Engine returns NO_RESULTS_ON_PAGE if there
2817 # are no results in the response.
2818 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2819 # value format. For example:
2820 #
2821 # &quot;data&quot;: [
2822 # {
2823 # &quot;key&quot;: &quot;scope&quot;,
2824 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2825 # }
2826 {
2827 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2828 # returned. For example, for warnings where there are no results in a list
2829 # request for a particular zone, this key might be scope and
2830 # the key value might be the zone name. Other examples might be a key
2831 # indicating a deprecated resource and a suggested replacement, or a
2832 # warning about invalid network settings (for example, if an instance
2833 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2834 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2835 },
2836 ],
2837 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2838 },
2839 ],
2840 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2841 # applicable when performing per-zone operations.
2842 }</pre>
2843 </div>
2844
2845 <div class="method">
2846 <code class="details" id="setCommonInstanceMetadata">setCommonInstanceMetadata(project, body=None, requestId=None, x__xgafv=None)</code>
2847 <pre>Sets metadata common to all instances within the specified project using
2848 the data included in the request.
2849
2850 Args:
2851 project: string, Project ID for this request. (required)
2852 body: object, The request body.
2853 The object takes the form of:
2854
2855 { # A metadata key/value entry.
2856 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
2857 # the metadata&#x27;s contents and used for optimistic locking. The
2858 # fingerprint is initially generated by Compute Engine and changes after
2859 # every request to modify or update metadata. You must always provide an
2860 # up-to-date fingerprint hash in order to update or change metadata,
2861 # otherwise the request will fail with error412 conditionNotMet.
2862 #
2863 # To see the latest fingerprint, make a get() request to
2864 # retrieve the resource.
2865 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
2866 # less than 512 KB.
2867 { # Metadata
2868 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
2869 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
2870 # This is reflected as part of a URL in the metadata server. Additionally, to
2871 # avoid ambiguity, keys must not conflict with any other metadata keys
2872 # for the project.
2873 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
2874 # have meaning as interpreted by the image running in the instance. The
2875 # only restriction placed on values is that their size must be less than
2876 # or equal to 262144 bytes (256 KiB).
2877 },
2878 ],
2879 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
2880 # for metadata.
2881 }
2882
2883 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2884 that if you must retry your request, the server will know to ignore the
2885 request if it has already been completed.
2886
2887 For example, consider a situation where you make an initial request and
2888 the request times out. If you make the request again with the same
2889 request ID, the server can check if original operation with the same
2890 request ID was received, and if so, will ignore the second request. This
2891 prevents clients from accidentally creating duplicate commitments.
2892
2893 The request ID must be
2894 a valid UUID with the exception that zero UUID is not supported
2895 (00000000-0000-0000-0000-000000000000).
2896 x__xgafv: string, V1 error format.
2897 Allowed values
2898 1 - v1 error format
2899 2 - v2 error format
2900
2901 Returns:
2902 An object of the form:
2903
2904 { # Represents an Operation resource.
2905 #
2906 # Google Compute Engine has three Operation resources:
2907 #
2908 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2909 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2910 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2911 #
2912 # You can use an operation resource to manage asynchronous API requests.
2913 # For more information, readHandling
2914 # API responses.
2915 #
2916 # Operations can be global, regional or zonal.
2917 #
2918 # - For global operations, use the `globalOperations`
2919 # resource.
2920 # - For regional operations, use the
2921 # `regionOperations` resource.
2922 # - For zonal operations, use
2923 # the `zoneOperations` resource.
2924 #
2925 #
2926 #
2927 # For more information, read
2928 # Global, Regional, and Zonal Resources.
2929 #
2930 # Note that completed Operation resources have a limited
2931 # retention period.
2932 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2933 # Not present otherwise.
2934 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2935 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2936 # set when the operation is created.
2937 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2938 # text format.
2939 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2940 # this field will be populated.
2941 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2942 # operation.
2943 {
2944 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2945 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2946 # details. There is a set of defined message types to use for providing
2947 # details.The syntax depends on the error code. For example,
2948 # QuotaExceededInfo will have details when the error code is
2949 # QUOTA_EXCEEDED.
2950 {
2951 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2952 #
2953 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2954 # is not enabled:
2955 #
2956 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2957 # &quot;domain&quot;: &quot;googleapis.com&quot;
2958 # &quot;metadata&quot;: {
2959 # &quot;resource&quot;: &quot;projects/123&quot;,
2960 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2961 # }
2962 # }
2963 #
2964 # This response indicates that the pubsub.googleapis.com API is not enabled.
2965 #
2966 # Example of an error that is returned when attempting to create a Spanner
2967 # instance in a region that is out of stock:
2968 #
2969 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2970 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2971 # &quot;metadata&quot;: {
2972 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2973 # }
2974 # }
2975 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2976 # is typically the registered service name of the tool or product that
2977 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2978 # generated by some common infrastructure, the error domain must be a
2979 # globally unique value that identifies the infrastructure. For Google API
2980 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2981 &quot;metadatas&quot;: { # Additional structured details about this error.
2982 #
2983 # Keys must match a regular expression of `a-z+` but should
2984 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2985 # length. When identifying the current value of an exceeded limit, the units
2986 # should be contained in the key, not the value. For example, rather than
2987 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2988 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2989 # instances that can be created in a single (batch) request.
2990 &quot;a_key&quot;: &quot;A String&quot;,
2991 },
2992 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2993 # proximate cause of the error. Error reasons are unique within a particular
2994 # domain of errors. This should be at most 63 characters and match a
2995 # regular expression of `A-Z+[A-Z0-9]`, which represents
2996 # UPPER_SNAKE_CASE.
2997 },
2998 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2999 #
3000 # For example, if a quota check failed with an error indicating the calling
3001 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3002 # directly to the right place in the developer console to flip the bit.
3003 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3004 { # Describes a URL link.
3005 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3006 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3007 },
3008 ],
3009 },
3010 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3011 # which can be attached to an RPC error.
3012 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3013 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3014 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3015 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3016 },
3017 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3018 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3019 &quot;a_key&quot;: &quot;A String&quot;,
3020 },
3021 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3022 # type or metric.
3023 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3024 # or metric.
3025 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3026 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3027 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3028 },
3029 },
3030 ],
3031 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3032 # This property is optional.
3033 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3034 },
3035 ],
3036 },
3037 &quot;getVersionOperationMetadata&quot;: {
3038 &quot;inlineSbomInfo&quot;: {
3039 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3040 # appropriate identifiers.
3041 &quot;a_key&quot;: &quot;A String&quot;,
3042 },
3043 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3044 # identifiers.
3045 &quot;a_key&quot;: &quot;A String&quot;,
3046 },
3047 },
3048 },
3049 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3050 # message that was returned, such as `NOT FOUND`.
3051 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3052 # status code that was returned. For example, a `404` means the
3053 # resource was not found.
3054 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3055 # defined by the server.
3056 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3057 # This value is inRFC3339
3058 # text format.
3059 &quot;instancesBulkInsertOperationMetadata&quot;: {
3060 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3061 # Example key: zones/us-central1-a
3062 &quot;a_key&quot;: {
3063 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3064 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3065 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3066 # error.
3067 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3068 # if the flow is rolling forward or rolling back.
3069 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3070 },
3071 },
3072 },
3073 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3074 # Operation resources.
3075 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3076 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3077 # group of operations results from a `bulkInsert` API request.
3078 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3079 # `update`, or `delete`, and so on.
3080 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3081 # There is no requirement that this be linear or support any granularity of
3082 # operations. This should not be used to guess when the operation will be
3083 # complete. This number should monotonically increase as the operation
3084 # progresses.
3085 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3086 # applicable when performing regional operations.
3087 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3088 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3089 # this field will contain information on all underlying zonal actions and
3090 # their state.
3091 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3092 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3093 # Example key: zones/us-central1-a
3094 &quot;a_key&quot;: {
3095 &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
3096 # populated.
3097 # different programming environments, including REST APIs and RPC APIs. It is
3098 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3099 # three pieces of data: error code, error message, and error details.
3100 #
3101 # You can find out more about this error model and how to work with it in the
3102 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3103 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3104 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3105 # message types for APIs to use.
3106 {
3107 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3108 },
3109 ],
3110 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3111 # user-facing error message should be localized and sent in the
3112 # google.rpc.Status.details field, or localized by the client.
3113 },
3114 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3115 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3116 },
3117 },
3118 },
3119 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3120 # This value is inRFC3339
3121 # text format.
3122 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3123 # following:
3124 # `PENDING`, `RUNNING`, or `DONE`.
3125 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3126 # operation.
3127 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3128 # of the target resource.
3129 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3130 # operations related to creating a snapshot, this points to the disk
3131 # that the snapshot was created from.
3132 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3133 # `[email protected]` or
3134 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3135 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3136 # operation, this field will be populated.
3137 {
3138 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3139 # Engine returns NO_RESULTS_ON_PAGE if there
3140 # are no results in the response.
3141 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3142 # value format. For example:
3143 #
3144 # &quot;data&quot;: [
3145 # {
3146 # &quot;key&quot;: &quot;scope&quot;,
3147 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3148 # }
3149 {
3150 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3151 # returned. For example, for warnings where there are no results in a list
3152 # request for a particular zone, this key might be scope and
3153 # the key value might be the zone name. Other examples might be a key
3154 # indicating a deprecated resource and a suggested replacement, or a
3155 # warning about invalid network settings (for example, if an instance
3156 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3157 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3158 },
3159 ],
3160 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3161 },
3162 ],
3163 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3164 # applicable when performing per-zone operations.
3165 }</pre>
3166 </div>
3167
3168 <div class="method">
3169 <code class="details" id="setDefaultNetworkTier">setDefaultNetworkTier(project, body=None, requestId=None, x__xgafv=None)</code>
3170 <pre>Sets the default network tier of the project. The default network tier is
3171 used when an address/forwardingRule/instance is created without specifying
3172 the network tier field.
3173
3174 Args:
3175 project: string, Project ID for this request. (required)
3176 body: object, The request body.
3177 The object takes the form of:
3178
3179 {
3180 &quot;networkTier&quot;: &quot;A String&quot;, # Default network tier to be set.
3181 }
3182
3183 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3184 that if you must retry your request, the server will know to ignore the
3185 request if it has already been completed.
3186
3187 For example, consider a situation where you make an initial request and
3188 the request times out. If you make the request again with the same
3189 request ID, the server can check if original operation with the same
3190 request ID was received, and if so, will ignore the second request. This
3191 prevents clients from accidentally creating duplicate commitments.
3192
3193 The request ID must be
3194 a valid UUID with the exception that zero UUID is not supported
3195 (00000000-0000-0000-0000-000000000000).
3196 x__xgafv: string, V1 error format.
3197 Allowed values
3198 1 - v1 error format
3199 2 - v2 error format
3200
3201 Returns:
3202 An object of the form:
3203
3204 { # Represents an Operation resource.
3205 #
3206 # Google Compute Engine has three Operation resources:
3207 #
3208 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3209 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3210 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3211 #
3212 # You can use an operation resource to manage asynchronous API requests.
3213 # For more information, readHandling
3214 # API responses.
3215 #
3216 # Operations can be global, regional or zonal.
3217 #
3218 # - For global operations, use the `globalOperations`
3219 # resource.
3220 # - For regional operations, use the
3221 # `regionOperations` resource.
3222 # - For zonal operations, use
3223 # the `zoneOperations` resource.
3224 #
3225 #
3226 #
3227 # For more information, read
3228 # Global, Regional, and Zonal Resources.
3229 #
3230 # Note that completed Operation resources have a limited
3231 # retention period.
3232 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3233 # Not present otherwise.
3234 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3235 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3236 # set when the operation is created.
3237 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3238 # text format.
3239 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3240 # this field will be populated.
3241 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3242 # operation.
3243 {
3244 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3245 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3246 # details. There is a set of defined message types to use for providing
3247 # details.The syntax depends on the error code. For example,
3248 # QuotaExceededInfo will have details when the error code is
3249 # QUOTA_EXCEEDED.
3250 {
3251 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3252 #
3253 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3254 # is not enabled:
3255 #
3256 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3257 # &quot;domain&quot;: &quot;googleapis.com&quot;
3258 # &quot;metadata&quot;: {
3259 # &quot;resource&quot;: &quot;projects/123&quot;,
3260 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3261 # }
3262 # }
3263 #
3264 # This response indicates that the pubsub.googleapis.com API is not enabled.
3265 #
3266 # Example of an error that is returned when attempting to create a Spanner
3267 # instance in a region that is out of stock:
3268 #
3269 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3270 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3271 # &quot;metadata&quot;: {
3272 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3273 # }
3274 # }
3275 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3276 # is typically the registered service name of the tool or product that
3277 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3278 # generated by some common infrastructure, the error domain must be a
3279 # globally unique value that identifies the infrastructure. For Google API
3280 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3281 &quot;metadatas&quot;: { # Additional structured details about this error.
3282 #
3283 # Keys must match a regular expression of `a-z+` but should
3284 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3285 # length. When identifying the current value of an exceeded limit, the units
3286 # should be contained in the key, not the value. For example, rather than
3287 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3288 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3289 # instances that can be created in a single (batch) request.
3290 &quot;a_key&quot;: &quot;A String&quot;,
3291 },
3292 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3293 # proximate cause of the error. Error reasons are unique within a particular
3294 # domain of errors. This should be at most 63 characters and match a
3295 # regular expression of `A-Z+[A-Z0-9]`, which represents
3296 # UPPER_SNAKE_CASE.
3297 },
3298 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3299 #
3300 # For example, if a quota check failed with an error indicating the calling
3301 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3302 # directly to the right place in the developer console to flip the bit.
3303 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3304 { # Describes a URL link.
3305 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3306 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3307 },
3308 ],
3309 },
3310 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3311 # which can be attached to an RPC error.
3312 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3313 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3314 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3315 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3316 },
3317 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3318 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3319 &quot;a_key&quot;: &quot;A String&quot;,
3320 },
3321 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3322 # type or metric.
3323 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3324 # or metric.
3325 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3326 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3327 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3328 },
3329 },
3330 ],
3331 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3332 # This property is optional.
3333 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3334 },
3335 ],
3336 },
3337 &quot;getVersionOperationMetadata&quot;: {
3338 &quot;inlineSbomInfo&quot;: {
3339 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3340 # appropriate identifiers.
3341 &quot;a_key&quot;: &quot;A String&quot;,
3342 },
3343 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3344 # identifiers.
3345 &quot;a_key&quot;: &quot;A String&quot;,
3346 },
3347 },
3348 },
3349 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3350 # message that was returned, such as `NOT FOUND`.
3351 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3352 # status code that was returned. For example, a `404` means the
3353 # resource was not found.
3354 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3355 # defined by the server.
3356 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3357 # This value is inRFC3339
3358 # text format.
3359 &quot;instancesBulkInsertOperationMetadata&quot;: {
3360 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3361 # Example key: zones/us-central1-a
3362 &quot;a_key&quot;: {
3363 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3364 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3365 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3366 # error.
3367 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3368 # if the flow is rolling forward or rolling back.
3369 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3370 },
3371 },
3372 },
3373 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3374 # Operation resources.
3375 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3376 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3377 # group of operations results from a `bulkInsert` API request.
3378 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3379 # `update`, or `delete`, and so on.
3380 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3381 # There is no requirement that this be linear or support any granularity of
3382 # operations. This should not be used to guess when the operation will be
3383 # complete. This number should monotonically increase as the operation
3384 # progresses.
3385 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3386 # applicable when performing regional operations.
3387 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3388 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3389 # this field will contain information on all underlying zonal actions and
3390 # their state.
3391 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3392 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3393 # Example key: zones/us-central1-a
3394 &quot;a_key&quot;: {
3395 &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
3396 # populated.
3397 # different programming environments, including REST APIs and RPC APIs. It is
3398 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3399 # three pieces of data: error code, error message, and error details.
3400 #
3401 # You can find out more about this error model and how to work with it in the
3402 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3403 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3404 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3405 # message types for APIs to use.
3406 {
3407 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3408 },
3409 ],
3410 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3411 # user-facing error message should be localized and sent in the
3412 # google.rpc.Status.details field, or localized by the client.
3413 },
3414 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3415 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3416 },
3417 },
3418 },
3419 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3420 # This value is inRFC3339
3421 # text format.
3422 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3423 # following:
3424 # `PENDING`, `RUNNING`, or `DONE`.
3425 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3426 # operation.
3427 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3428 # of the target resource.
3429 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3430 # operations related to creating a snapshot, this points to the disk
3431 # that the snapshot was created from.
3432 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3433 # `[email protected]` or
3434 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3435 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3436 # operation, this field will be populated.
3437 {
3438 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3439 # Engine returns NO_RESULTS_ON_PAGE if there
3440 # are no results in the response.
3441 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3442 # value format. For example:
3443 #
3444 # &quot;data&quot;: [
3445 # {
3446 # &quot;key&quot;: &quot;scope&quot;,
3447 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3448 # }
3449 {
3450 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3451 # returned. For example, for warnings where there are no results in a list
3452 # request for a particular zone, this key might be scope and
3453 # the key value might be the zone name. Other examples might be a key
3454 # indicating a deprecated resource and a suggested replacement, or a
3455 # warning about invalid network settings (for example, if an instance
3456 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3457 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3458 },
3459 ],
3460 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3461 },
3462 ],
3463 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3464 # applicable when performing per-zone operations.
3465 }</pre>
3466 </div>
3467
3468 <div class="method">
3469 <code class="details" id="setUsageExportBucket">setUsageExportBucket(project, body=None, requestId=None, x__xgafv=None)</code>
3470 <pre>Enables the usage export feature and sets theusage export bucket
3471 where reports are stored. If you provide an empty request body using this
3472 method, the usage export feature will be disabled.
3473
3474 Args:
3475 project: string, Project ID for this request. (required)
3476 body: object, The request body.
3477 The object takes the form of:
3478
3479 { # The location in Cloud Storage and naming method of the daily usage
3480 # report. Contains bucket_name and report_name prefix.
3481 &quot;bucketName&quot;: &quot;A String&quot;, # The name of an existing bucket in Cloud Storage where the usage report
3482 # object is stored. The Google Service Account is granted write access to
3483 # this bucket. This can either be the bucket name by itself, such asexample-bucket, or the bucket name with gs://
3484 # or https://storage.googleapis.com/ in front of it, such
3485 # as gs://example-bucket.
3486 &quot;reportNamePrefix&quot;: &quot;A String&quot;, # An optional prefix for the name of the usage report object stored inbucketName. If not supplied, defaults tousage_gce. The report is stored as a CSV file namedreport_name_prefix_gce_YYYYMMDD.csv whereYYYYMMDD is the day of the usage according to Pacific Time.
3487 # If you supply a prefix, it should conform to Cloud Storageobject naming
3488 # conventions.
3489 }
3490
3491 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3492 that if you must retry your request, the server will know to ignore the
3493 request if it has already been completed.
3494
3495 For example, consider a situation where you make an initial request and
3496 the request times out. If you make the request again with the same
3497 request ID, the server can check if original operation with the same
3498 request ID was received, and if so, will ignore the second request. This
3499 prevents clients from accidentally creating duplicate commitments.
3500
3501 The request ID must be
3502 a valid UUID with the exception that zero UUID is not supported
3503 (00000000-0000-0000-0000-000000000000).
3504 x__xgafv: string, V1 error format.
3505 Allowed values
3506 1 - v1 error format
3507 2 - v2 error format
3508
3509 Returns:
3510 An object of the form:
3511
3512 { # Represents an Operation resource.
3513 #
3514 # Google Compute Engine has three Operation resources:
3515 #
3516 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3517 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3518 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3519 #
3520 # You can use an operation resource to manage asynchronous API requests.
3521 # For more information, readHandling
3522 # API responses.
3523 #
3524 # Operations can be global, regional or zonal.
3525 #
3526 # - For global operations, use the `globalOperations`
3527 # resource.
3528 # - For regional operations, use the
3529 # `regionOperations` resource.
3530 # - For zonal operations, use
3531 # the `zoneOperations` resource.
3532 #
3533 #
3534 #
3535 # For more information, read
3536 # Global, Regional, and Zonal Resources.
3537 #
3538 # Note that completed Operation resources have a limited
3539 # retention period.
3540 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3541 # Not present otherwise.
3542 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3543 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3544 # set when the operation is created.
3545 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3546 # text format.
3547 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3548 # this field will be populated.
3549 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3550 # operation.
3551 {
3552 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3553 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3554 # details. There is a set of defined message types to use for providing
3555 # details.The syntax depends on the error code. For example,
3556 # QuotaExceededInfo will have details when the error code is
3557 # QUOTA_EXCEEDED.
3558 {
3559 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3560 #
3561 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3562 # is not enabled:
3563 #
3564 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3565 # &quot;domain&quot;: &quot;googleapis.com&quot;
3566 # &quot;metadata&quot;: {
3567 # &quot;resource&quot;: &quot;projects/123&quot;,
3568 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3569 # }
3570 # }
3571 #
3572 # This response indicates that the pubsub.googleapis.com API is not enabled.
3573 #
3574 # Example of an error that is returned when attempting to create a Spanner
3575 # instance in a region that is out of stock:
3576 #
3577 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3578 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3579 # &quot;metadata&quot;: {
3580 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3581 # }
3582 # }
3583 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3584 # is typically the registered service name of the tool or product that
3585 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3586 # generated by some common infrastructure, the error domain must be a
3587 # globally unique value that identifies the infrastructure. For Google API
3588 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3589 &quot;metadatas&quot;: { # Additional structured details about this error.
3590 #
3591 # Keys must match a regular expression of `a-z+` but should
3592 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3593 # length. When identifying the current value of an exceeded limit, the units
3594 # should be contained in the key, not the value. For example, rather than
3595 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3596 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3597 # instances that can be created in a single (batch) request.
3598 &quot;a_key&quot;: &quot;A String&quot;,
3599 },
3600 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3601 # proximate cause of the error. Error reasons are unique within a particular
3602 # domain of errors. This should be at most 63 characters and match a
3603 # regular expression of `A-Z+[A-Z0-9]`, which represents
3604 # UPPER_SNAKE_CASE.
3605 },
3606 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3607 #
3608 # For example, if a quota check failed with an error indicating the calling
3609 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3610 # directly to the right place in the developer console to flip the bit.
3611 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3612 { # Describes a URL link.
3613 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3614 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3615 },
3616 ],
3617 },
3618 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3619 # which can be attached to an RPC error.
3620 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3621 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3622 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3623 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3624 },
3625 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3626 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3627 &quot;a_key&quot;: &quot;A String&quot;,
3628 },
3629 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3630 # type or metric.
3631 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3632 # or metric.
3633 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3634 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3635 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3636 },
3637 },
3638 ],
3639 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3640 # This property is optional.
3641 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3642 },
3643 ],
3644 },
3645 &quot;getVersionOperationMetadata&quot;: {
3646 &quot;inlineSbomInfo&quot;: {
3647 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3648 # appropriate identifiers.
3649 &quot;a_key&quot;: &quot;A String&quot;,
3650 },
3651 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3652 # identifiers.
3653 &quot;a_key&quot;: &quot;A String&quot;,
3654 },
3655 },
3656 },
3657 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3658 # message that was returned, such as `NOT FOUND`.
3659 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3660 # status code that was returned. For example, a `404` means the
3661 # resource was not found.
3662 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3663 # defined by the server.
3664 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3665 # This value is inRFC3339
3666 # text format.
3667 &quot;instancesBulkInsertOperationMetadata&quot;: {
3668 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3669 # Example key: zones/us-central1-a
3670 &quot;a_key&quot;: {
3671 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3672 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3673 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3674 # error.
3675 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3676 # if the flow is rolling forward or rolling back.
3677 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3678 },
3679 },
3680 },
3681 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3682 # Operation resources.
3683 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3684 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3685 # group of operations results from a `bulkInsert` API request.
3686 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3687 # `update`, or `delete`, and so on.
3688 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3689 # There is no requirement that this be linear or support any granularity of
3690 # operations. This should not be used to guess when the operation will be
3691 # complete. This number should monotonically increase as the operation
3692 # progresses.
3693 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3694 # applicable when performing regional operations.
3695 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3696 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3697 # this field will contain information on all underlying zonal actions and
3698 # their state.
3699 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3700 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3701 # Example key: zones/us-central1-a
3702 &quot;a_key&quot;: {
3703 &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
3704 # populated.
3705 # different programming environments, including REST APIs and RPC APIs. It is
3706 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3707 # three pieces of data: error code, error message, and error details.
3708 #
3709 # You can find out more about this error model and how to work with it in the
3710 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3711 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3712 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3713 # message types for APIs to use.
3714 {
3715 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3716 },
3717 ],
3718 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3719 # user-facing error message should be localized and sent in the
3720 # google.rpc.Status.details field, or localized by the client.
3721 },
3722 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3723 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3724 },
3725 },
3726 },
3727 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3728 # This value is inRFC3339
3729 # text format.
3730 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3731 # following:
3732 # `PENDING`, `RUNNING`, or `DONE`.
3733 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3734 # operation.
3735 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3736 # of the target resource.
3737 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3738 # operations related to creating a snapshot, this points to the disk
3739 # that the snapshot was created from.
3740 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3741 # `[email protected]` or
3742 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3743 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3744 # operation, this field will be populated.
3745 {
3746 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3747 # Engine returns NO_RESULTS_ON_PAGE if there
3748 # are no results in the response.
3749 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3750 # value format. For example:
3751 #
3752 # &quot;data&quot;: [
3753 # {
3754 # &quot;key&quot;: &quot;scope&quot;,
3755 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3756 # }
3757 {
3758 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3759 # returned. For example, for warnings where there are no results in a list
3760 # request for a particular zone, this key might be scope and
3761 # the key value might be the zone name. Other examples might be a key
3762 # indicating a deprecated resource and a suggested replacement, or a
3763 # warning about invalid network settings (for example, if an instance
3764 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3765 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3766 },
3767 ],
3768 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3769 },
3770 ],
3771 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3772 # applicable when performing per-zone operations.
3773 }</pre>
3774 </div>
3775
3776 </body></html>