Debian Codegraph @

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