Debian Codegraph @

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