Debian Codegraph @

docs/dyn/compute_beta.instances.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.instances.html">instances</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Adds an access config to an instance's network interface.</p>
80 <p class="toc_element">
81 <code><a href="#addNetworkInterface">addNetworkInterface(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Adds one dynamic network interface to an active instance.</p>
83 <p class="toc_element">
84 <code><a href="#addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Adds existing resource policies to an instance. You can only add one</p>
86 <p class="toc_element">
87 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves an aggregated list of all of the instances in your project</p>
89 <p class="toc_element">
90 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Attaches an existing Disk resource to an instance. You must first</p>
95 <p class="toc_element">
96 <code><a href="#bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates multiple instances. Count specifies the number of instances to</p>
98 <p class="toc_element">
99 <code><a href="#close">close()</a></code></p>
100 <p class="firstline">Close httplib2 connections.</p>
101 <p class="toc_element">
102 <code><a href="#delete">delete(project, zone, instance, noGracefulShutdown=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Deletes the specified Instance resource. For more information, seeDeleting</p>
104 <p class="toc_element">
105 <code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Deletes an access config from an instance's network interface.</p>
107 <p class="toc_element">
108 <code><a href="#deleteNetworkInterface">deleteNetworkInterface(project, zone, instance, networkInterfaceName, requestId=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Deletes one dynamic network interface from an active instance.</p>
110 <p class="toc_element">
111 <code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Detaches a disk from an instance.</p>
113 <p class="toc_element">
114 <code><a href="#get">get(project, zone, instance, view=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Returns the specified Instance resource.</p>
116 <p class="toc_element">
117 <code><a href="#getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</a></code></p>
118 <p class="firstline">Returns effective firewalls applied to an interface of the instance.</p>
119 <p class="toc_element">
120 <code><a href="#getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Returns the specified guest attributes entry.</p>
122 <p class="toc_element">
123 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
125 <p class="toc_element">
126 <code><a href="#getPartnerMetadata">getPartnerMetadata(project, zone, instance, namespaces=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Gets partner metadata of the specified instance and namespaces.</p>
128 <p class="toc_element">
129 <code><a href="#getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</a></code></p>
130 <p class="firstline">Returns the screenshot from the specified instance.</p>
131 <p class="toc_element">
132 <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None, x__xgafv=None)</a></code></p>
133 <p class="firstline">Returns the last 1 MB of serial port output from the specified instance.</p>
134 <p class="toc_element">
135 <code><a href="#getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance, x__xgafv=None)</a></code></p>
136 <p class="firstline">Returns the Shielded Instance Identity of an instance</p>
137 <p class="toc_element">
138 <code><a href="#getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance, x__xgafv=None)</a></code></p>
139 <p class="firstline">Returns the Shielded VM Identity of an instance</p>
140 <p class="toc_element">
141 <code><a href="#insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</a></code></p>
142 <p class="firstline">Creates an instance resource in the specified project using the data</p>
143 <p class="toc_element">
144 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Retrieves the list of instances contained within</p>
146 <p class="toc_element">
147 <code><a href="#listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
148 <p class="firstline">Retrieves a list of resources that refer to the VM instance specified in</p>
149 <p class="toc_element">
150 <code><a href="#listReferrers_next">listReferrers_next()</a></code></p>
151 <p class="firstline">Retrieves the next page of results.</p>
152 <p class="toc_element">
153 <code><a href="#list_next">list_next()</a></code></p>
154 <p class="firstline">Retrieves the next page of results.</p>
155 <p class="toc_element">
156 <code><a href="#patchPartnerMetadata">patchPartnerMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
157 <p class="firstline">Patches partner metadata of the specified instance.</p>
158 <p class="toc_element">
159 <code><a href="#performMaintenance">performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
160 <p class="firstline">Perform a manual maintenance on the instance.</p>
161 <p class="toc_element">
162 <code><a href="#removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
163 <p class="firstline">Removes resource policies from an instance.</p>
164 <p class="toc_element">
165 <code><a href="#reportHostAsFaulty">reportHostAsFaulty(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
166 <p class="firstline">Mark the host as faulty and try to restart the instance on a new host.</p>
167 <p class="toc_element">
168 <code><a href="#reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
169 <p class="firstline">Performs a reset on the instance. This is a hard reset. The VM</p>
170 <p class="toc_element">
171 <code><a href="#resume">resume(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
172 <p class="firstline">Resumes an instance that was suspended using theinstances().suspend</p>
173 <p class="toc_element">
174 <code><a href="#sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</a></code></p>
175 <p class="firstline">Sends diagnostic interrupt to the instance.</p>
176 <p class="toc_element">
177 <code><a href="#setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</a></code></p>
178 <p class="firstline">Sets deletion protection on the instance.</p>
179 <p class="toc_element">
180 <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</a></code></p>
181 <p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
182 <p class="toc_element">
183 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
184 <p class="firstline">Sets the access control policy on the specified resource.</p>
185 <p class="toc_element">
186 <code><a href="#setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
187 <p class="firstline">Sets labels on an instance. To learn more about labels, read theLabeling</p>
188 <p class="toc_element">
189 <code><a href="#setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
190 <p class="firstline">Changes the number and/or type of accelerator for a stopped instance to the</p>
191 <p class="toc_element">
192 <code><a href="#setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
193 <p class="firstline">Changes the machine type for a stopped instance to the machine</p>
194 <p class="toc_element">
195 <code><a href="#setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
196 <p class="firstline">Sets metadata for the specified instance to the data included</p>
197 <p class="toc_element">
198 <code><a href="#setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
199 <p class="firstline">Changes the minimum CPU platform that this instance should use.</p>
200 <p class="toc_element">
201 <code><a href="#setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
202 <p class="firstline">Sets name of an instance.</p>
203 <p class="toc_element">
204 <code><a href="#setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
205 <p class="firstline">Sets an instance's scheduling options. You can only call this method on astopped instance,</p>
206 <p class="toc_element">
207 <code><a href="#setSecurityPolicy">setSecurityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
208 <p class="firstline">Sets the Google Cloud Armor security policy for the specified instance.</p>
209 <p class="toc_element">
210 <code><a href="#setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
211 <p class="firstline">Sets the service account on the instance. For more information,</p>
212 <p class="toc_element">
213 <code><a href="#setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
214 <p class="firstline">Sets the Shielded Instance integrity policy for an instance. You can</p>
215 <p class="toc_element">
216 <code><a href="#setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
217 <p class="firstline">Sets the Shielded VM integrity policy for a VM instance. You can</p>
218 <p class="toc_element">
219 <code><a href="#setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
220 <p class="firstline">Sets network tags</p>
221 <p class="toc_element">
222 <code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, requestId=None, withExtendedNotifications=None, x__xgafv=None)</a></code></p>
223 <p class="firstline">Simulates a host maintenance event on a VM. For more information, see</p>
224 <p class="toc_element">
225 <code><a href="#start">start(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
226 <p class="firstline">Starts an instance that was stopped using theinstances().stop</p>
227 <p class="toc_element">
228 <code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
229 <p class="firstline">Starts an instance that was stopped using theinstances().stop</p>
230 <p class="toc_element">
231 <code><a href="#stop">stop(project, zone, instance, discardLocalSsd=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)</a></code></p>
232 <p class="firstline">Stops a running instance, shutting it down cleanly, and allows</p>
233 <p class="toc_element">
234 <code><a href="#suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</a></code></p>
235 <p class="firstline">This method suspends a running instance, saving its state to persistent</p>
236 <p class="toc_element">
237 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
238 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
239 <p class="toc_element">
240 <code><a href="#update">update(project, zone, instance, body=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</a></code></p>
241 <p class="firstline">Updates an instance only if the necessary resources are available. This</p>
242 <p class="toc_element">
243 <code><a href="#updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p>
244 <p class="firstline">Updates the specified access config from an instance's network interface</p>
245 <p class="toc_element">
246 <code><a href="#updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
247 <p class="firstline">Updates the Display config for a VM instance. You can</p>
248 <p class="toc_element">
249 <code><a href="#updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p>
250 <p class="firstline">Updates an instance's network interface. This method can only update an</p>
251 <p class="toc_element">
252 <code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
253 <p class="firstline">Updates the Shielded Instance config for an instance. You can</p>
254 <p class="toc_element">
255 <code><a href="#updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
256 <p class="firstline">Updates the Shielded VM config for a VM instance. You can</p>
257 <h3>Method Details</h3>
258 <div class="method">
259 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>
260 <pre>Adds an access config to an instance&#x27;s network interface.
261
262 Args:
263 project: string, Project ID for this request. (required)
264 zone: string, The name of the zone for this request. (required)
265 instance: string, The instance name for this request. (required)
266 networkInterface: string, The name of the network interface to add to this instance. (required)
267 body: object, The request body.
268 The object takes the form of:
269
270 { # An access configuration attached to an instance&#x27;s network interface.
271 # Only one access config per instance is supported.
272 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
273 # The first IPv6 address of the external IPv6 range associated
274 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
275 # use a static external IP address, it must be unused and in the same region
276 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
277 # assign an external IPv6 address from the instance&#x27;s subnetwork.
278 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
279 # external IPv6 range.
280 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
281 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
282 # (IPv4), the default and recommended name is External NAT, but
283 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
284 # recommend name is External IPv6.
285 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
286 # address associated with this instance. Specify an unused static
287 # external IP address available to the project or leave this field undefined
288 # to use an IP from a shared ephemeral IP address pool. If you specify a
289 # static external IP address, it must live in the same region as the zone of
290 # the instance.
291 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
292 # configuration and can only take the following values: PREMIUM,STANDARD.
293 #
294 # If an AccessConfig is specified without a valid external IP address, an
295 # ephemeral IP will be created with this networkTier.
296 #
297 # If an AccessConfig with a valid external IP address is specified, it must
298 # match that of the networkTier associated with the Address resource owning
299 # that IP.
300 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
301 #
302 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
303 # first IP in associated external IPv6 range.
304 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
305 # config.
306 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
307 # external IP address of the instance to a DNS domain name.
308 #
309 # This field is not used in ipv6AccessConfig. A default PTR
310 # record will be created if the VM has external IPv6 range associated.
311 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
312 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
313 }
314
315 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
316 that if you must retry your request, the server will know to ignore the
317 request if it has already been completed.
318
319 For example, consider a situation where you make an initial request and
320 the request times out. If you make the request again with the same
321 request ID, the server can check if original operation with the same
322 request ID was received, and if so, will ignore the second request. This
323 prevents clients from accidentally creating duplicate commitments.
324
325 The request ID must be
326 a valid UUID with the exception that zero UUID is not supported
327 (00000000-0000-0000-0000-000000000000).
328 x__xgafv: string, V1 error format.
329 Allowed values
330 1 - v1 error format
331 2 - v2 error format
332
333 Returns:
334 An object of the form:
335
336 { # Represents an Operation resource.
337 #
338 # Google Compute Engine has three Operation resources:
339 #
340 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
341 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
342 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
343 #
344 # You can use an operation resource to manage asynchronous API requests.
345 # For more information, readHandling
346 # API responses.
347 #
348 # Operations can be global, regional or zonal.
349 #
350 # - For global operations, use the `globalOperations`
351 # resource.
352 # - For regional operations, use the
353 # `regionOperations` resource.
354 # - For zonal operations, use
355 # the `zoneOperations` resource.
356 #
357 #
358 #
359 # For more information, read
360 # Global, Regional, and Zonal Resources.
361 #
362 # Note that completed Operation resources have a limited
363 # retention period.
364 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
365 # Not present otherwise.
366 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
367 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
368 # set when the operation is created.
369 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
370 # text format.
371 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
372 # this field will be populated.
373 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
374 # operation.
375 {
376 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
377 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
378 # details. There is a set of defined message types to use for providing
379 # details.The syntax depends on the error code. For example,
380 # QuotaExceededInfo will have details when the error code is
381 # QUOTA_EXCEEDED.
382 {
383 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
384 #
385 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
386 # is not enabled:
387 #
388 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
389 # &quot;domain&quot;: &quot;googleapis.com&quot;
390 # &quot;metadata&quot;: {
391 # &quot;resource&quot;: &quot;projects/123&quot;,
392 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
393 # }
394 # }
395 #
396 # This response indicates that the pubsub.googleapis.com API is not enabled.
397 #
398 # Example of an error that is returned when attempting to create a Spanner
399 # instance in a region that is out of stock:
400 #
401 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
402 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
403 # &quot;metadata&quot;: {
404 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
405 # }
406 # }
407 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
408 # is typically the registered service name of the tool or product that
409 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
410 # generated by some common infrastructure, the error domain must be a
411 # globally unique value that identifies the infrastructure. For Google API
412 # infrastructure, the error domain is &quot;googleapis.com&quot;.
413 &quot;metadatas&quot;: { # Additional structured details about this error.
414 #
415 # Keys must match a regular expression of `a-z+` but should
416 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
417 # length. When identifying the current value of an exceeded limit, the units
418 # should be contained in the key, not the value. For example, rather than
419 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
420 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
421 # instances that can be created in a single (batch) request.
422 &quot;a_key&quot;: &quot;A String&quot;,
423 },
424 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
425 # proximate cause of the error. Error reasons are unique within a particular
426 # domain of errors. This should be at most 63 characters and match a
427 # regular expression of `A-Z+[A-Z0-9]`, which represents
428 # UPPER_SNAKE_CASE.
429 },
430 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
431 #
432 # For example, if a quota check failed with an error indicating the calling
433 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
434 # directly to the right place in the developer console to flip the bit.
435 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
436 { # Describes a URL link.
437 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
438 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
439 },
440 ],
441 },
442 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
443 # which can be attached to an RPC error.
444 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
445 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
446 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
447 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
448 },
449 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
450 &quot;dimensions&quot;: { # The map holding related quota dimensions.
451 &quot;a_key&quot;: &quot;A String&quot;,
452 },
453 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
454 # type or metric.
455 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
456 # or metric.
457 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
458 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
459 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
460 },
461 },
462 ],
463 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
464 # This property is optional.
465 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
466 },
467 ],
468 },
469 &quot;getVersionOperationMetadata&quot;: {
470 &quot;inlineSbomInfo&quot;: {
471 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
472 # appropriate identifiers.
473 &quot;a_key&quot;: &quot;A String&quot;,
474 },
475 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
476 # identifiers.
477 &quot;a_key&quot;: &quot;A String&quot;,
478 },
479 },
480 },
481 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
482 # message that was returned, such as `NOT FOUND`.
483 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
484 # status code that was returned. For example, a `404` means the
485 # resource was not found.
486 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
487 # defined by the server.
488 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
489 # This value is inRFC3339
490 # text format.
491 &quot;instancesBulkInsertOperationMetadata&quot;: {
492 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
493 # Example key: zones/us-central1-a
494 &quot;a_key&quot;: {
495 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
496 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
497 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
498 # error.
499 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
500 # if the flow is rolling forward or rolling back.
501 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
502 },
503 },
504 },
505 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
506 # Operation resources.
507 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
508 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
509 # group of operations results from a `bulkInsert` API request.
510 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
511 # `update`, or `delete`, and so on.
512 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
513 # There is no requirement that this be linear or support any granularity of
514 # operations. This should not be used to guess when the operation will be
515 # complete. This number should monotonically increase as the operation
516 # progresses.
517 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
518 # applicable when performing regional operations.
519 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
520 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
521 # this field will contain information on all underlying zonal actions and
522 # their state.
523 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
524 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
525 # Example key: zones/us-central1-a
526 &quot;a_key&quot;: {
527 &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
528 # populated.
529 # different programming environments, including REST APIs and RPC APIs. It is
530 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
531 # three pieces of data: error code, error message, and error details.
532 #
533 # You can find out more about this error model and how to work with it in the
534 # [API Design Guide](https://cloud.google.com/apis/design/errors).
535 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
536 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
537 # message types for APIs to use.
538 {
539 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
540 },
541 ],
542 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
543 # user-facing error message should be localized and sent in the
544 # google.rpc.Status.details field, or localized by the client.
545 },
546 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
547 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
548 },
549 },
550 },
551 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
552 # This value is inRFC3339
553 # text format.
554 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
555 # following:
556 # `PENDING`, `RUNNING`, or `DONE`.
557 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
558 # operation.
559 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
560 # of the target resource.
561 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
562 # operations related to creating a snapshot, this points to the disk
563 # that the snapshot was created from.
564 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
565 # `[email protected]` or
566 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
567 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
568 # operation, this field will be populated.
569 {
570 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
571 # Engine returns NO_RESULTS_ON_PAGE if there
572 # are no results in the response.
573 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
574 # value format. For example:
575 #
576 # &quot;data&quot;: [
577 # {
578 # &quot;key&quot;: &quot;scope&quot;,
579 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
580 # }
581 {
582 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
583 # returned. For example, for warnings where there are no results in a list
584 # request for a particular zone, this key might be scope and
585 # the key value might be the zone name. Other examples might be a key
586 # indicating a deprecated resource and a suggested replacement, or a
587 # warning about invalid network settings (for example, if an instance
588 # attempts to perform IP forwarding but is not enabled for IP forwarding).
589 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
590 },
591 ],
592 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
593 },
594 ],
595 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
596 # applicable when performing per-zone operations.
597 }</pre>
598 </div>
599
600 <div class="method">
601 <code class="details" id="addNetworkInterface">addNetworkInterface(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
602 <pre>Adds one dynamic network interface to an active instance.
603
604 Args:
605 project: string, Project ID for this request. (required)
606 zone: string, The name of the zone for this request. (required)
607 instance: string, The instance name for this request stored as resource_id.
608 Name should conform to RFC1035 or be an unsigned long integer. (required)
609 body: object, The request body.
610 The object takes the form of:
611
612 { # A network interface resource attached to an instance.
613 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
614 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
615 # no external internet access.
616 { # An access configuration attached to an instance&#x27;s network interface.
617 # Only one access config per instance is supported.
618 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
619 # The first IPv6 address of the external IPv6 range associated
620 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
621 # use a static external IP address, it must be unused and in the same region
622 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
623 # assign an external IPv6 address from the instance&#x27;s subnetwork.
624 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
625 # external IPv6 range.
626 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
627 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
628 # (IPv4), the default and recommended name is External NAT, but
629 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
630 # recommend name is External IPv6.
631 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
632 # address associated with this instance. Specify an unused static
633 # external IP address available to the project or leave this field undefined
634 # to use an IP from a shared ephemeral IP address pool. If you specify a
635 # static external IP address, it must live in the same region as the zone of
636 # the instance.
637 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
638 # configuration and can only take the following values: PREMIUM,STANDARD.
639 #
640 # If an AccessConfig is specified without a valid external IP address, an
641 # ephemeral IP will be created with this networkTier.
642 #
643 # If an AccessConfig with a valid external IP address is specified, it must
644 # match that of the networkTier associated with the Address resource owning
645 # that IP.
646 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
647 #
648 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
649 # first IP in associated external IPv6 range.
650 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
651 # config.
652 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
653 # external IP address of the instance to a DNS domain name.
654 #
655 # This field is not used in ipv6AccessConfig. A default PTR
656 # record will be created if the VM has external IPv6 range associated.
657 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
658 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
659 },
660 ],
661 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
662 # You can only specify this field for network interfaces in VPC networks.
663 { # An alias IP range attached to an instance&#x27;s network interface.
664 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
665 # must belong to the specified subnetwork and cannot contain IP addresses
666 # reserved by system or used by other network interfaces. This range may be
667 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
668 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
669 # alias range. If not specified, the primary range of the subnetwork is used.
670 },
671 ],
672 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
673 # You can only specify this field for network interfaces in VPC networks.
674 { # An alias IP range attached to an instance&#x27;s network interface.
675 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
676 # must belong to the specified subnetwork and cannot contain IP addresses
677 # reserved by system or used by other network interfaces. This range may be
678 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
679 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
680 # alias range. If not specified, the primary range of the subnetwork is used.
681 },
682 ],
683 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
684 # with network_attachment.
685 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
686 # This field will be ignored when inserting an Instance or
687 # adding a NetworkInterface. An up-to-date
688 # fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
689 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
690 # or not. If enabled, also indicates the version of IGMP supported.
691 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
692 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
693 # one IPv6 access config, DIRECT_IPV6, is supported. If there
694 # is no ipv6AccessConfig specified, then this instance will
695 # have no external IPv6 Internet access.
696 { # An access configuration attached to an instance&#x27;s network interface.
697 # Only one access config per instance is supported.
698 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
699 # The first IPv6 address of the external IPv6 range associated
700 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
701 # use a static external IP address, it must be unused and in the same region
702 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
703 # assign an external IPv6 address from the instance&#x27;s subnetwork.
704 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
705 # external IPv6 range.
706 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
707 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
708 # (IPv4), the default and recommended name is External NAT, but
709 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
710 # recommend name is External IPv6.
711 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
712 # address associated with this instance. Specify an unused static
713 # external IP address available to the project or leave this field undefined
714 # to use an IP from a shared ephemeral IP address pool. If you specify a
715 # static external IP address, it must live in the same region as the zone of
716 # the instance.
717 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
718 # configuration and can only take the following values: PREMIUM,STANDARD.
719 #
720 # If an AccessConfig is specified without a valid external IP address, an
721 # ephemeral IP will be created with this networkTier.
722 #
723 # If an AccessConfig with a valid external IP address is specified, it must
724 # match that of the networkTier associated with the Address resource owning
725 # that IP.
726 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
727 #
728 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
729 # first IP in associated external IPv6 range.
730 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
731 # config.
732 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
733 # external IP address of the instance to a DNS domain name.
734 #
735 # This field is not used in ipv6AccessConfig. A default PTR
736 # record will be created if the VM has external IPv6 range associated.
737 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
738 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
739 },
740 ],
741 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
742 # accessed from the Internet. This field is always inherited from its
743 # subnetwork.
744 #
745 # Valid only if stackType is IPV4_IPV6.
746 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
747 # use a static internal IP address, it must be unused and in the same region
748 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
749 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
750 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
751 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
752 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
753 # server. For a VM, the network interface uses the nicN naming
754 # format. Where N is a value between 0 and7. The default interface value is nic0.
755 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
756 # instance, if neither the network nor the subnetwork is specified, the
757 # default network global/networks/default is used. If the
758 # selected project doesn&#x27;t have the default network, you must specify a
759 # network or subnet. If the network is not specified but the subnetwork is
760 # specified, the network is inferred.
761 #
762 # If you specify this property, you can specify the network as
763 # a full or partial URL. For example, the following are all valid URLs:
764 #
765 #
766 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
767 # - projects/project/global/networks/network
768 # - global/networks/default
769 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
770 # to in the following format:
771 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
772 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
773 # interface. If not specified by the user, an unused internal IP is
774 # assigned by the system.
775 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
776 # VirtioNet.
777 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
778 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
779 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
780 # if not specified by the users.
781 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
782 # interface. Can only be used with network_attachment. It is not possible to
783 # use on its own however, network_attachment can be used without
784 # service_class_id.
785 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
786 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
787 #
788 # This field can be both set at instance creation and update network
789 # interface operations.
790 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
791 # resource is inlegacy
792 # mode, do not specify this field. If the network is in auto subnet
793 # mode, specifying the subnetwork is optional. If the network is in custom
794 # subnet mode, specifying the subnetwork is required. If you specify this
795 # field, you can specify the subnetwork as a full or partial URL. For
796 # example, the following are all valid URLs:
797 #
798 #
799 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
800 # - regions/region/subnetworks/subnetwork
801 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
802 # from 2 to 255 inclusively.
803 }
804
805 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
806 that if you must retry your request, the server will know to ignore the
807 request if it has already been completed.
808
809 For example, consider a situation where you make an initial request and
810 the request times out. If you make the request again with the same
811 request ID, the server can check if original operation with the same
812 request ID was received, and if so, will ignore the second request. This
813 prevents clients from accidentally creating duplicate commitments.
814
815 The request ID must be
816 a valid UUID with the exception that zero UUID is not supported
817 (00000000-0000-0000-0000-000000000000).
818 x__xgafv: string, V1 error format.
819 Allowed values
820 1 - v1 error format
821 2 - v2 error format
822
823 Returns:
824 An object of the form:
825
826 { # Represents an Operation resource.
827 #
828 # Google Compute Engine has three Operation resources:
829 #
830 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
831 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
832 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
833 #
834 # You can use an operation resource to manage asynchronous API requests.
835 # For more information, readHandling
836 # API responses.
837 #
838 # Operations can be global, regional or zonal.
839 #
840 # - For global operations, use the `globalOperations`
841 # resource.
842 # - For regional operations, use the
843 # `regionOperations` resource.
844 # - For zonal operations, use
845 # the `zoneOperations` resource.
846 #
847 #
848 #
849 # For more information, read
850 # Global, Regional, and Zonal Resources.
851 #
852 # Note that completed Operation resources have a limited
853 # retention period.
854 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
855 # Not present otherwise.
856 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
857 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
858 # set when the operation is created.
859 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
860 # text format.
861 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
862 # this field will be populated.
863 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
864 # operation.
865 {
866 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
867 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
868 # details. There is a set of defined message types to use for providing
869 # details.The syntax depends on the error code. For example,
870 # QuotaExceededInfo will have details when the error code is
871 # QUOTA_EXCEEDED.
872 {
873 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
874 #
875 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
876 # is not enabled:
877 #
878 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
879 # &quot;domain&quot;: &quot;googleapis.com&quot;
880 # &quot;metadata&quot;: {
881 # &quot;resource&quot;: &quot;projects/123&quot;,
882 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
883 # }
884 # }
885 #
886 # This response indicates that the pubsub.googleapis.com API is not enabled.
887 #
888 # Example of an error that is returned when attempting to create a Spanner
889 # instance in a region that is out of stock:
890 #
891 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
892 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
893 # &quot;metadata&quot;: {
894 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
895 # }
896 # }
897 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
898 # is typically the registered service name of the tool or product that
899 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
900 # generated by some common infrastructure, the error domain must be a
901 # globally unique value that identifies the infrastructure. For Google API
902 # infrastructure, the error domain is &quot;googleapis.com&quot;.
903 &quot;metadatas&quot;: { # Additional structured details about this error.
904 #
905 # Keys must match a regular expression of `a-z+` but should
906 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
907 # length. When identifying the current value of an exceeded limit, the units
908 # should be contained in the key, not the value. For example, rather than
909 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
910 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
911 # instances that can be created in a single (batch) request.
912 &quot;a_key&quot;: &quot;A String&quot;,
913 },
914 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
915 # proximate cause of the error. Error reasons are unique within a particular
916 # domain of errors. This should be at most 63 characters and match a
917 # regular expression of `A-Z+[A-Z0-9]`, which represents
918 # UPPER_SNAKE_CASE.
919 },
920 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
921 #
922 # For example, if a quota check failed with an error indicating the calling
923 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
924 # directly to the right place in the developer console to flip the bit.
925 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
926 { # Describes a URL link.
927 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
928 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
929 },
930 ],
931 },
932 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
933 # which can be attached to an RPC error.
934 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
935 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
936 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
937 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
938 },
939 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
940 &quot;dimensions&quot;: { # The map holding related quota dimensions.
941 &quot;a_key&quot;: &quot;A String&quot;,
942 },
943 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
944 # type or metric.
945 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
946 # or metric.
947 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
948 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
949 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
950 },
951 },
952 ],
953 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
954 # This property is optional.
955 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
956 },
957 ],
958 },
959 &quot;getVersionOperationMetadata&quot;: {
960 &quot;inlineSbomInfo&quot;: {
961 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
962 # appropriate identifiers.
963 &quot;a_key&quot;: &quot;A String&quot;,
964 },
965 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
966 # identifiers.
967 &quot;a_key&quot;: &quot;A String&quot;,
968 },
969 },
970 },
971 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
972 # message that was returned, such as `NOT FOUND`.
973 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
974 # status code that was returned. For example, a `404` means the
975 # resource was not found.
976 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
977 # defined by the server.
978 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
979 # This value is inRFC3339
980 # text format.
981 &quot;instancesBulkInsertOperationMetadata&quot;: {
982 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
983 # Example key: zones/us-central1-a
984 &quot;a_key&quot;: {
985 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
986 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
987 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
988 # error.
989 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
990 # if the flow is rolling forward or rolling back.
991 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
992 },
993 },
994 },
995 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
996 # Operation resources.
997 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
998 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
999 # group of operations results from a `bulkInsert` API request.
1000 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1001 # `update`, or `delete`, and so on.
1002 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1003 # There is no requirement that this be linear or support any granularity of
1004 # operations. This should not be used to guess when the operation will be
1005 # complete. This number should monotonically increase as the operation
1006 # progresses.
1007 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1008 # applicable when performing regional operations.
1009 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1010 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1011 # this field will contain information on all underlying zonal actions and
1012 # their state.
1013 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1014 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1015 # Example key: zones/us-central1-a
1016 &quot;a_key&quot;: {
1017 &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
1018 # populated.
1019 # different programming environments, including REST APIs and RPC APIs. It is
1020 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1021 # three pieces of data: error code, error message, and error details.
1022 #
1023 # You can find out more about this error model and how to work with it in the
1024 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1025 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1026 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1027 # message types for APIs to use.
1028 {
1029 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1030 },
1031 ],
1032 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1033 # user-facing error message should be localized and sent in the
1034 # google.rpc.Status.details field, or localized by the client.
1035 },
1036 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1037 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1038 },
1039 },
1040 },
1041 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1042 # This value is inRFC3339
1043 # text format.
1044 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1045 # following:
1046 # `PENDING`, `RUNNING`, or `DONE`.
1047 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1048 # operation.
1049 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1050 # of the target resource.
1051 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1052 # operations related to creating a snapshot, this points to the disk
1053 # that the snapshot was created from.
1054 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1055 # `[email protected]` or
1056 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1057 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1058 # operation, this field will be populated.
1059 {
1060 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1061 # Engine returns NO_RESULTS_ON_PAGE if there
1062 # are no results in the response.
1063 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1064 # value format. For example:
1065 #
1066 # &quot;data&quot;: [
1067 # {
1068 # &quot;key&quot;: &quot;scope&quot;,
1069 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1070 # }
1071 {
1072 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1073 # returned. For example, for warnings where there are no results in a list
1074 # request for a particular zone, this key might be scope and
1075 # the key value might be the zone name. Other examples might be a key
1076 # indicating a deprecated resource and a suggested replacement, or a
1077 # warning about invalid network settings (for example, if an instance
1078 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1079 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1080 },
1081 ],
1082 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1083 },
1084 ],
1085 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1086 # applicable when performing per-zone operations.
1087 }</pre>
1088 </div>
1089
1090 <div class="method">
1091 <code class="details" id="addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
1092 <pre>Adds existing resource policies to an instance. You can only add one
1093 policy right now which will be applied to this instance for scheduling live
1094 migrations.
1095
1096 Args:
1097 project: string, Project ID for this request. (required)
1098 zone: string, The name of the zone for this request. (required)
1099 instance: string, The instance name for this request. (required)
1100 body: object, The request body.
1101 The object takes the form of:
1102
1103 {
1104 &quot;resourcePolicies&quot;: [ # Resource policies to be added to this instance.
1105 &quot;A String&quot;,
1106 ],
1107 }
1108
1109 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1110 that if you must retry your request, the server will know to ignore the
1111 request if it has already been completed.
1112
1113 For example, consider a situation where you make an initial request and
1114 the request times out. If you make the request again with the same
1115 request ID, the server can check if original operation with the same
1116 request ID was received, and if so, will ignore the second request. This
1117 prevents clients from accidentally creating duplicate commitments.
1118
1119 The request ID must be
1120 a valid UUID with the exception that zero UUID is not supported
1121 (00000000-0000-0000-0000-000000000000).
1122 x__xgafv: string, V1 error format.
1123 Allowed values
1124 1 - v1 error format
1125 2 - v2 error format
1126
1127 Returns:
1128 An object of the form:
1129
1130 { # Represents an Operation resource.
1131 #
1132 # Google Compute Engine has three Operation resources:
1133 #
1134 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1135 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1136 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1137 #
1138 # You can use an operation resource to manage asynchronous API requests.
1139 # For more information, readHandling
1140 # API responses.
1141 #
1142 # Operations can be global, regional or zonal.
1143 #
1144 # - For global operations, use the `globalOperations`
1145 # resource.
1146 # - For regional operations, use the
1147 # `regionOperations` resource.
1148 # - For zonal operations, use
1149 # the `zoneOperations` resource.
1150 #
1151 #
1152 #
1153 # For more information, read
1154 # Global, Regional, and Zonal Resources.
1155 #
1156 # Note that completed Operation resources have a limited
1157 # retention period.
1158 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1159 # Not present otherwise.
1160 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1161 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1162 # set when the operation is created.
1163 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1164 # text format.
1165 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1166 # this field will be populated.
1167 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1168 # operation.
1169 {
1170 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1171 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1172 # details. There is a set of defined message types to use for providing
1173 # details.The syntax depends on the error code. For example,
1174 # QuotaExceededInfo will have details when the error code is
1175 # QUOTA_EXCEEDED.
1176 {
1177 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1178 #
1179 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1180 # is not enabled:
1181 #
1182 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1183 # &quot;domain&quot;: &quot;googleapis.com&quot;
1184 # &quot;metadata&quot;: {
1185 # &quot;resource&quot;: &quot;projects/123&quot;,
1186 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1187 # }
1188 # }
1189 #
1190 # This response indicates that the pubsub.googleapis.com API is not enabled.
1191 #
1192 # Example of an error that is returned when attempting to create a Spanner
1193 # instance in a region that is out of stock:
1194 #
1195 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1196 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1197 # &quot;metadata&quot;: {
1198 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1199 # }
1200 # }
1201 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1202 # is typically the registered service name of the tool or product that
1203 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1204 # generated by some common infrastructure, the error domain must be a
1205 # globally unique value that identifies the infrastructure. For Google API
1206 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1207 &quot;metadatas&quot;: { # Additional structured details about this error.
1208 #
1209 # Keys must match a regular expression of `a-z+` but should
1210 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1211 # length. When identifying the current value of an exceeded limit, the units
1212 # should be contained in the key, not the value. For example, rather than
1213 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1214 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1215 # instances that can be created in a single (batch) request.
1216 &quot;a_key&quot;: &quot;A String&quot;,
1217 },
1218 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1219 # proximate cause of the error. Error reasons are unique within a particular
1220 # domain of errors. This should be at most 63 characters and match a
1221 # regular expression of `A-Z+[A-Z0-9]`, which represents
1222 # UPPER_SNAKE_CASE.
1223 },
1224 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1225 #
1226 # For example, if a quota check failed with an error indicating the calling
1227 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1228 # directly to the right place in the developer console to flip the bit.
1229 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1230 { # Describes a URL link.
1231 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1232 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1233 },
1234 ],
1235 },
1236 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1237 # which can be attached to an RPC error.
1238 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1239 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1240 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1241 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1242 },
1243 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1244 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1245 &quot;a_key&quot;: &quot;A String&quot;,
1246 },
1247 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1248 # type or metric.
1249 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1250 # or metric.
1251 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1252 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1253 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1254 },
1255 },
1256 ],
1257 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1258 # This property is optional.
1259 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1260 },
1261 ],
1262 },
1263 &quot;getVersionOperationMetadata&quot;: {
1264 &quot;inlineSbomInfo&quot;: {
1265 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1266 # appropriate identifiers.
1267 &quot;a_key&quot;: &quot;A String&quot;,
1268 },
1269 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1270 # identifiers.
1271 &quot;a_key&quot;: &quot;A String&quot;,
1272 },
1273 },
1274 },
1275 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1276 # message that was returned, such as `NOT FOUND`.
1277 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1278 # status code that was returned. For example, a `404` means the
1279 # resource was not found.
1280 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1281 # defined by the server.
1282 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1283 # This value is inRFC3339
1284 # text format.
1285 &quot;instancesBulkInsertOperationMetadata&quot;: {
1286 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1287 # Example key: zones/us-central1-a
1288 &quot;a_key&quot;: {
1289 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1290 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1291 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1292 # error.
1293 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1294 # if the flow is rolling forward or rolling back.
1295 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1296 },
1297 },
1298 },
1299 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1300 # Operation resources.
1301 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1302 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1303 # group of operations results from a `bulkInsert` API request.
1304 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1305 # `update`, or `delete`, and so on.
1306 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1307 # There is no requirement that this be linear or support any granularity of
1308 # operations. This should not be used to guess when the operation will be
1309 # complete. This number should monotonically increase as the operation
1310 # progresses.
1311 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1312 # applicable when performing regional operations.
1313 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1314 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1315 # this field will contain information on all underlying zonal actions and
1316 # their state.
1317 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1318 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1319 # Example key: zones/us-central1-a
1320 &quot;a_key&quot;: {
1321 &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
1322 # populated.
1323 # different programming environments, including REST APIs and RPC APIs. It is
1324 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1325 # three pieces of data: error code, error message, and error details.
1326 #
1327 # You can find out more about this error model and how to work with it in the
1328 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1329 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1330 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1331 # message types for APIs to use.
1332 {
1333 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1334 },
1335 ],
1336 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1337 # user-facing error message should be localized and sent in the
1338 # google.rpc.Status.details field, or localized by the client.
1339 },
1340 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1341 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1342 },
1343 },
1344 },
1345 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1346 # This value is inRFC3339
1347 # text format.
1348 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1349 # following:
1350 # `PENDING`, `RUNNING`, or `DONE`.
1351 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1352 # operation.
1353 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1354 # of the target resource.
1355 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1356 # operations related to creating a snapshot, this points to the disk
1357 # that the snapshot was created from.
1358 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1359 # `[email protected]` or
1360 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1361 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1362 # operation, this field will be populated.
1363 {
1364 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1365 # Engine returns NO_RESULTS_ON_PAGE if there
1366 # are no results in the response.
1367 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1368 # value format. For example:
1369 #
1370 # &quot;data&quot;: [
1371 # {
1372 # &quot;key&quot;: &quot;scope&quot;,
1373 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1374 # }
1375 {
1376 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1377 # returned. For example, for warnings where there are no results in a list
1378 # request for a particular zone, this key might be scope and
1379 # the key value might be the zone name. Other examples might be a key
1380 # indicating a deprecated resource and a suggested replacement, or a
1381 # warning about invalid network settings (for example, if an instance
1382 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1383 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1384 },
1385 ],
1386 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1387 },
1388 ],
1389 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1390 # applicable when performing per-zone operations.
1391 }</pre>
1392 </div>
1393
1394 <div class="method">
1395 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
1396 <pre>Retrieves an aggregated list of all of the instances in your project
1397 across all regions and zones.
1398
1399 The performance of this method degrades when a filter is specified on a
1400 project that has a very large number of instances.
1401
1402 To prevent failure, Google recommends that you set the
1403 `returnPartialSuccess` parameter to `true`.
1404
1405 Args:
1406 project: string, Project ID for this request. (required)
1407 filter: string, A filter expression that filters resources listed in the response. Most
1408 Compute resources support two types of filter expressions:
1409 expressions that support regular expressions and expressions that follow
1410 API improvement proposal AIP-160.
1411 These two types of filter expressions cannot be mixed in one request.
1412
1413 If you want to use AIP-160, your expression must specify the field name, an
1414 operator, and the value that you want to use for filtering. The value
1415 must be a string, a number, or a boolean. The operator
1416 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1417
1418 For example, if you are filtering Compute Engine instances, you can
1419 exclude instances named `example-instance` by specifying
1420 `name != example-instance`.
1421
1422 The `:*` comparison can be used to test whether a key has been defined.
1423 For example, to find all objects with `owner` label use:
1424 ```
1425 labels.owner:*
1426 ```
1427
1428 You can also filter nested fields. For example, you could specify
1429 `scheduling.automaticRestart = false` to include instances only
1430 if they are not scheduled for automatic restarts. You can use filtering
1431 on nested fields to filter based onresource labels.
1432
1433 To filter on multiple expressions, provide each separate expression within
1434 parentheses. For example:
1435 ```
1436 (scheduling.automaticRestart = true)
1437 (cpuPlatform = &quot;Intel Skylake&quot;)
1438 ```
1439 By default, each expression is an `AND` expression. However, you
1440 can include `AND` and `OR` expressions explicitly.
1441 For example:
1442 ```
1443 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1444 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1445 (scheduling.automaticRestart = true)
1446 ```
1447
1448 If you want to use a regular expression, use the `eq` (equal) or `ne`
1449 (not equal) operator against a single un-parenthesized expression with or
1450 without quotes or against multiple parenthesized expressions. Examples:
1451
1452 `fieldname eq unquoted literal`
1453 `fieldname eq &#x27;single quoted literal&#x27;`
1454 `fieldname eq &quot;double quoted literal&quot;`
1455 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1456
1457 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1458 The literal value must match the entire field.
1459
1460 For example, to filter for instances that do not end with name &quot;instance&quot;,
1461 you would use `name ne .*instance`.
1462
1463 You cannot combine constraints on multiple fields using regular
1464 expressions.
1465 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
1466 global) should be included in the response. For new resource types added
1467 after this field, the flag has no effect as new resource types will always
1468 include every visible scope for each scope type in response. For resource
1469 types which predate this field, if this flag is omitted or false, only
1470 scopes of the scope types where the resource type is expected to be found
1471 will be included.
1472 maxResults: integer, The maximum number of results per page that should be returned.
1473 If the number of available results is larger than `maxResults`,
1474 Compute Engine returns a `nextPageToken` that can be used to get
1475 the next page of results in subsequent list requests. Acceptable values are
1476 `0` to `500`, inclusive. (Default: `500`)
1477 orderBy: string, Sorts list results by a certain order. By default, results
1478 are returned in alphanumerical order based on the resource name.
1479
1480 You can also sort results in descending order based on the creation
1481 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1482 results based on the `creationTimestamp` field in
1483 reverse chronological order (newest result first). Use this to sort
1484 resources like operations so that the newest operation is returned first.
1485
1486 Currently, only sorting by `name` or
1487 `creationTimestamp desc` is supported.
1488 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1489 `nextPageToken` returned by a previous list request to get
1490 the next page of results.
1491 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1492 of failure. The default value is false.
1493
1494 For example, when partial success behavior is enabled, aggregatedList for a
1495 single zone scope either returns all resources in the zone or no resources,
1496 with an error code.
1497 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
1498 aggregated list request is invoked for subnetworks list-usable api.
1499 x__xgafv: string, V1 error format.
1500 Allowed values
1501 1 - v1 error format
1502 2 - v2 error format
1503
1504 Returns:
1505 An object of the form:
1506
1507 {
1508 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1509 &quot;items&quot;: { # An object that contains a list of instances scoped by zone.
1510 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of instances.
1511 &quot;instances&quot;: [ # [Output Only] A list of instances contained in this scope.
1512 { # Represents an Instance resource.
1513 #
1514 # An instance is a virtual machine that is hosted on Google Cloud Platform.
1515 # For more information, readVirtual Machine Instances.
1516 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
1517 # Options that would traditionally be configured in a BIOS belong
1518 # here. Features that require operating system support may have
1519 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
1520 # disabled).
1521 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
1522 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
1523 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
1524 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
1525 # multithreading (SMT) set this to 1. If unset, the maximum number
1526 # of threads supported per core by the underlying processor is
1527 # assumed.
1528 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
1529 # Supported modes include:
1530 # * ALL_CORE_MAX
1531 #
1532 # Using empty string or not setting this field will use the platform-specific
1533 # default turbo mode.
1534 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
1535 # the number of threads per core to compute the total number of virtual
1536 # CPUs to expose to the instance. If unset, the number of cores is
1537 # inferred from the instance&#x27;s nominal CPU count and the underlying
1538 # platform&#x27;s SMT width.
1539 },
1540 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
1541 # destination or source IPs. This is required if you plan to use this
1542 # instance to forward routes. For more information, seeEnabling IP Forwarding.
1543 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
1544 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
1545 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
1546 },
1547 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
1548 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
1549 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
1550 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1551 # create the resource.
1552 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
1553 # created before you can assign them.
1554 { # An instance-attached disk resource.
1555 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
1556 # or X86_64.
1557 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
1558 # deleted (but not when the disk is detached from the instance).
1559 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
1560 # partition of the disk for its root filesystem.
1561 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
1562 # running within the instance. This name can be used to reference the device
1563 # for mounting, resizing, and so on, from within the instance.
1564 #
1565 # If not specified, the server chooses a default device name to apply to this
1566 # disk, in the form persistent-disk-x, where x is a number
1567 # assigned by Google Compute Engine. This field is only applicable for
1568 # persistent disks.
1569 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
1570 # encryption key.
1571 #
1572 # If you are creating a new disk, this field encrypts the new disk using
1573 # an encryption key that you provide. If you are attaching an existing
1574 # disk that is already encrypted, this field decrypts the disk using
1575 # the customer-supplied encryption key.
1576 #
1577 # If you encrypt a disk using a customer-supplied key, you must provide the
1578 # same key again when you attempt to use this resource at a later time. For
1579 # example, you must provide the key when you create a snapshot or an image
1580 # from the disk or when you attach the disk to a virtual machine instance.
1581 #
1582 # If you do not provide an encryption key, then the disk will be encrypted
1583 # using an automatically generated key and you do not need to provide a key
1584 # to use the disk later.
1585 #
1586 # Note:
1587 #
1588 # Instance templates do not storecustomer-supplied
1589 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
1590 #
1591 # You cannot create VMs that have disks with customer-supplied keys using
1592 # the bulk
1593 # insert method.
1594 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1595 # For example:
1596 #
1597 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1598 # key_region/cryptoKeys/key
1599 #
1600 # The fully-qualifed key name may be returned for resource GET requests. For
1601 # example:
1602 #
1603 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1604 # key_region/cryptoKeys/key
1605 # /cryptoKeyVersions/1
1606 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1607 # key. If absent, the Compute Engine default service account is used.
1608 # For example:
1609 #
1610 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1611 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1612 # encryption key, encoded in RFC
1613 # 4648 base64 to either encrypt or decrypt this resource. You can
1614 # provide either the rawKey or thersaEncryptedKey.
1615 # For example:
1616 #
1617 # &quot;rawKey&quot;:
1618 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1619 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1620 # customer-supplied encryption key to either encrypt or decrypt this
1621 # resource. You can provide either the rawKey or thersaEncryptedKey.
1622 # For example:
1623 #
1624 # &quot;rsaEncryptedKey&quot;:
1625 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1626 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1627 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1628 #
1629 # The key must meet the following requirements before you can provide it to
1630 # Compute Engine:
1631 #
1632 # 1. The key is wrapped using a RSA public key certificate provided by
1633 # Google.
1634 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1635 # encoding.
1636 #
1637 # Gets the RSA public key certificate provided by Google at:
1638 #
1639 #
1640 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1641 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1642 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1643 # encryption key that protects this resource.
1644 },
1645 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
1646 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
1647 # currently attached to another instance. If you try to force attach a zonal
1648 # disk to an instance, you will receive an error.
1649 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
1650 # only for bootable images. Read
1651 # Enabling guest operating system features to see a list of available
1652 # options.
1653 { # Guest OS features.
1654 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1655 # separate values. Set to one or more of the following values:
1656 #
1657 # - VIRTIO_SCSI_MULTIQUEUE
1658 # - WINDOWS
1659 # - MULTI_IP_SUBNET
1660 # - UEFI_COMPATIBLE
1661 # - GVNIC
1662 # - SEV_CAPABLE
1663 # - SUSPEND_RESUME_COMPATIBLE
1664 # - SEV_LIVE_MIGRATABLE_V2
1665 # - SEV_SNP_CAPABLE
1666 # - TDX_CAPABLE
1667 # - IDPF
1668 # - SNP_SVSM_CAPABLE
1669 # - CCA_CAPABLE
1670 #
1671 #
1672 # For more information, see
1673 # Enabling guest operating system features.
1674 },
1675 ],
1676 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
1677 # boot disk. If you have many disks attached to an instance, each
1678 # disk would have a unique index number.
1679 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
1680 # alongside the new instance. Use initialization parameters to create boot
1681 # disks or local SSDs attached to the new instance.
1682 #
1683 # This property is mutually exclusive with the source property;
1684 # you can only define one or the other, but not both.
1685 # alongside the new instance. Use initialization parameters to create boot
1686 # disks or local SSDs attached to the new instance.
1687 #
1688 # This field is persisted and returned for instanceTemplate and not returned
1689 # in the context of instance.
1690 #
1691 # This property is mutually exclusive with the source property;
1692 # you can only define one or the other, but not both.
1693 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
1694 # arm64 or x86_64.
1695 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
1696 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
1697 # of the instance. If a disk with the same name already exists in the given
1698 # region, the existing disk is attached to the new instance and the
1699 # new disk is not created.
1700 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
1701 # 10 GB. If you specify a sourceImage, which is required for
1702 # boot disks, the default size is the size of the sourceImage.
1703 # If you do not specify a sourceImage, the default disk size
1704 # is 500 GB.
1705 &quot;diskType&quot;: &quot;A String&quot;,
1706 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
1707 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
1708 # only for bootable images. Read
1709 # Enabling guest operating system features to see a list of available
1710 # options.
1711 #
1712 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
1713 { # Guest OS features.
1714 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1715 # separate values. Set to one or more of the following values:
1716 #
1717 # - VIRTIO_SCSI_MULTIQUEUE
1718 # - WINDOWS
1719 # - MULTI_IP_SUBNET
1720 # - UEFI_COMPATIBLE
1721 # - GVNIC
1722 # - SEV_CAPABLE
1723 # - SUSPEND_RESUME_COMPATIBLE
1724 # - SEV_LIVE_MIGRATABLE_V2
1725 # - SEV_SNP_CAPABLE
1726 # - TDX_CAPABLE
1727 # - IDPF
1728 # - SNP_SVSM_CAPABLE
1729 # - CCA_CAPABLE
1730 #
1731 #
1732 # For more information, see
1733 # Enabling guest operating system features.
1734 },
1735 ],
1736 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
1737 # persistent disks.
1738 &quot;a_key&quot;: &quot;A String&quot;,
1739 },
1740 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
1741 &quot;A String&quot;,
1742 ],
1743 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
1744 # more than one instance.
1745 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
1746 # is to use the existing disk.
1747 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
1748 # of I/O operations per second that the disk can handle. Values must be
1749 # between 10,000 and 120,000. For more details, see theExtreme persistent
1750 # disk documentation.
1751 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
1752 # number of throughput mb per second that the disk can handle. Values must
1753 # greater than or equal to 1.
1754 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
1755 # the URLs of the zones where the disk should be replicated to.
1756 # You must provide exactly two replica zones, and one zone must be the same
1757 # as the instance zone.
1758 &quot;A String&quot;,
1759 ],
1760 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
1761 # have the same definition as resource
1762 # manager tags. Keys and values can be either in numeric format,
1763 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1764 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1765 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
1766 # empty.
1767 &quot;a_key&quot;: &quot;A String&quot;,
1768 },
1769 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
1770 # Specified using the full or partial URL. For instance template, specify
1771 # only the resource policy name.
1772 &quot;A String&quot;,
1773 ],
1774 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
1775 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
1776 # is required.
1777 #
1778 # To create a disk with one of the public operating system
1779 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
1780 #
1781 # projects/debian-cloud/global/images/family/debian-9
1782 #
1783 #
1784 # Alternatively, use a specific version of a public operating system image:
1785 #
1786 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
1787 #
1788 #
1789 # To create a disk with a custom image that you created, specify the
1790 # image name in the following format:
1791 #
1792 # global/images/my-custom-image
1793 #
1794 #
1795 # You can also specify a custom image by its image family, which returns
1796 # the latest version of the image in that family. Replace the image name
1797 # with family/family-name:
1798 #
1799 # global/images/family/my-image-family
1800 #
1801 #
1802 # If the source image is deleted later, this field will not be set.
1803 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
1804 # encryption key of the source image. Required if the source image is
1805 # protected by a customer-supplied encryption key.
1806 #
1807 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
1808 # encryption keys, so you cannot create disks for instances in a managed instance group if the
1809 # source images are encrypted with your own keys.
1810 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1811 # For example:
1812 #
1813 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1814 # key_region/cryptoKeys/key
1815 #
1816 # The fully-qualifed key name may be returned for resource GET requests. For
1817 # example:
1818 #
1819 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1820 # key_region/cryptoKeys/key
1821 # /cryptoKeyVersions/1
1822 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1823 # key. If absent, the Compute Engine default service account is used.
1824 # For example:
1825 #
1826 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1827 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1828 # encryption key, encoded in RFC
1829 # 4648 base64 to either encrypt or decrypt this resource. You can
1830 # provide either the rawKey or thersaEncryptedKey.
1831 # For example:
1832 #
1833 # &quot;rawKey&quot;:
1834 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1835 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1836 # customer-supplied encryption key to either encrypt or decrypt this
1837 # resource. You can provide either the rawKey or thersaEncryptedKey.
1838 # For example:
1839 #
1840 # &quot;rsaEncryptedKey&quot;:
1841 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1842 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1843 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1844 #
1845 # The key must meet the following requirements before you can provide it to
1846 # Compute Engine:
1847 #
1848 # 1. The key is wrapped using a RSA public key certificate provided by
1849 # Google.
1850 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1851 # encoding.
1852 #
1853 # Gets the RSA public key certificate provided by Google at:
1854 #
1855 #
1856 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1857 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1858 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1859 # encryption key that protects this resource.
1860 },
1861 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
1862 # instance boot disk, one of initializeParams.sourceSnapshot
1863 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
1864 # is required.
1865 #
1866 # To create a disk with a snapshot that you created, specify the
1867 # snapshot name in the following format:
1868 #
1869 # us-central1-a/instantSnapshots/my-backup
1870 #
1871 #
1872 # If the source instant-snapshot is deleted later, this field will not be
1873 # set.
1874 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
1875 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
1876 # is required.
1877 #
1878 # To create a disk with a snapshot that you created, specify the
1879 # snapshot name in the following format:
1880 #
1881 # global/snapshots/my-backup
1882 #
1883 #
1884 # If the source snapshot is deleted later, this field will not be set.
1885 #
1886 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
1887 # an image instead when you create VMs using
1888 # the bulk
1889 # insert method.
1890 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
1891 # encryption key of the source snapshot.
1892 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1893 # For example:
1894 #
1895 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1896 # key_region/cryptoKeys/key
1897 #
1898 # The fully-qualifed key name may be returned for resource GET requests. For
1899 # example:
1900 #
1901 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1902 # key_region/cryptoKeys/key
1903 # /cryptoKeyVersions/1
1904 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1905 # key. If absent, the Compute Engine default service account is used.
1906 # For example:
1907 #
1908 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1909 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1910 # encryption key, encoded in RFC
1911 # 4648 base64 to either encrypt or decrypt this resource. You can
1912 # provide either the rawKey or thersaEncryptedKey.
1913 # For example:
1914 #
1915 # &quot;rawKey&quot;:
1916 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1917 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1918 # customer-supplied encryption key to either encrypt or decrypt this
1919 # resource. You can provide either the rawKey or thersaEncryptedKey.
1920 # For example:
1921 #
1922 # &quot;rsaEncryptedKey&quot;:
1923 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1924 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1925 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1926 #
1927 # The key must meet the following requirements before you can provide it to
1928 # Compute Engine:
1929 #
1930 # 1. The key is wrapped using a RSA public key certificate provided by
1931 # Google.
1932 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1933 # encoding.
1934 #
1935 # Gets the RSA public key certificate provided by Google at:
1936 #
1937 #
1938 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1939 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1940 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1941 # encryption key that protects this resource.
1942 },
1943 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
1944 # this as a partial or full URL to the resource. For example, the following
1945 # are valid values:
1946 #
1947 #
1948 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
1949 # - projects/project/zones/zone/storagePools/storagePool
1950 # - zones/zone/storagePools/storagePool
1951 },
1952 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
1953 # either SCSI or NVME. For most machine types, the
1954 # default is SCSI. Local SSDs can use either NVME or SCSI.
1955 # In certain configurations, persistent disks can use NVMe. For more
1956 # information, seeAbout
1957 # persistent disks.
1958 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
1959 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
1960 &quot;A String&quot;,
1961 ],
1962 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
1963 # disk is not allowed to be detached from the instance, or to be used as the
1964 # source of the snapshot creation, and the image creation. The instance with
1965 # at least one locked attached disk is not allow to be used as source of
1966 # machine image creation, instant snapshot creation, and not allowed to be
1967 # deleted with --keep-disk parameter set to true for locked disks.
1968 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
1969 # in READ_WRITE mode.
1970 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
1971 # field is set to PRESERVED if the LocalSSD data has been saved
1972 # to a persistent location by customer request. (see the
1973 # discard_local_ssd option on Stop/Suspend).
1974 # Read-only in the api.
1975 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
1976 # these are public keys which are safe to store in public
1977 &quot;dbs&quot;: [ # The Key Database (db).
1978 {
1979 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1980 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1981 },
1982 ],
1983 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
1984 {
1985 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1986 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1987 },
1988 ],
1989 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
1990 {
1991 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1992 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1993 },
1994 ],
1995 &quot;pk&quot;: { # The Platform Key (PK).
1996 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1997 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1998 },
1999 },
2000 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
2001 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
2002 # is required.
2003 #
2004 # If desired, you can also attach existing non-root persistent disks using
2005 # this property. This field is only applicable for persistent disks.
2006 #
2007 # Note that for InstanceTemplate, specify the disk name for zonal disk,
2008 # and the URL for regional disk.
2009 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
2010 },
2011 ],
2012 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
2013 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
2014 },
2015 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
2016 # machine image should erase Windows specific VSS signature.
2017 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
2018 # the instance&#x27;s contents and used for optimistic locking. The
2019 # fingerprint is initially generated by Compute Engine and changes after
2020 # every request to modify or update the instance. You must always provide an
2021 # up-to-date fingerprint hash in order to update the instance.
2022 #
2023 # To see the latest fingerprint, make get() request to the
2024 # instance.
2025 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
2026 { # A specification of the type and number of accelerator cards attached to the
2027 # instance.
2028 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
2029 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
2030 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
2031 # If you are creating an instance template, specify only the
2032 # accelerator name.
2033 # See GPUs on Compute Engine
2034 # for a full list of accelerator types.
2035 },
2036 ],
2037 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
2038 # RFC1035 compliant. If hostname is not specified, the default hostname is
2039 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
2040 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
2041 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2042 # defined by the server.
2043 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
2044 # encryption key.
2045 #
2046 # If you are creating a new instance, this field will encrypt the local SSD
2047 # and in-memory contents of the instance during the suspend operation.
2048 #
2049 # If you do not provide an encryption key when creating the instance, then
2050 # the local SSD and in-memory contents will be encrypted using
2051 # an automatically generated key during the suspend operation.
2052 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2053 # For example:
2054 #
2055 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2056 # key_region/cryptoKeys/key
2057 #
2058 # The fully-qualifed key name may be returned for resource GET requests. For
2059 # example:
2060 #
2061 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2062 # key_region/cryptoKeys/key
2063 # /cryptoKeyVersions/1
2064 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2065 # key. If absent, the Compute Engine default service account is used.
2066 # For example:
2067 #
2068 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2069 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2070 # encryption key, encoded in RFC
2071 # 4648 base64 to either encrypt or decrypt this resource. You can
2072 # provide either the rawKey or thersaEncryptedKey.
2073 # For example:
2074 #
2075 # &quot;rawKey&quot;:
2076 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2077 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2078 # customer-supplied encryption key to either encrypt or decrypt this
2079 # resource. You can provide either the rawKey or thersaEncryptedKey.
2080 # For example:
2081 #
2082 # &quot;rsaEncryptedKey&quot;:
2083 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2084 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2085 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2086 #
2087 # The key must meet the following requirements before you can provide it to
2088 # Compute Engine:
2089 #
2090 # 1. The key is wrapped using a RSA public key certificate provided by
2091 # Google.
2092 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2093 # encoding.
2094 #
2095 # Gets the RSA public key certificate provided by Google at:
2096 #
2097 #
2098 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2099 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2100 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2101 # encryption key that protects this resource.
2102 },
2103 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
2104 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
2105 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
2106 # for instances.
2107 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
2108 # the label&#x27;s contents and used for optimistic locking. The
2109 # fingerprint is initially generated by Compute Engine and changes after
2110 # every request to modify or update labels. You must always provide an
2111 # up-to-date fingerprint hash in order to update or change labels.
2112 #
2113 # To see the latest fingerprint, make get() request to the
2114 # instance.
2115 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
2116 # the setLabels method.
2117 &quot;a_key&quot;: &quot;A String&quot;,
2118 },
2119 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
2120 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
2121 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
2122 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
2123 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
2124 # when the instance is created. For example, the following is a valid partial
2125 # url to a predefined
2126 # machine type:
2127 #
2128 # zones/us-central1-f/machineTypes/n1-standard-1
2129 #
2130 #
2131 # To create acustom
2132 # machine type, provide a URL to a machine type in the following format,
2133 # where CPUS is 1 or an even number up to 32 (2,
2134 # 4, 6, ... 24, etc), and MEMORY is the total
2135 # memory for this instance. Memory must be a multiple of 256 MB and must
2136 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
2137 #
2138 # zones/zone/machineTypes/custom-CPUS-MEMORY
2139 #
2140 #
2141 # For example: zones/us-central1-f/machineTypes/custom-4-5120
2142 # For a full list of restrictions, read theSpecifications
2143 # for custom machine types.
2144 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
2145 # to this instance. This includes metadata keys that were explicitly defined
2146 # for the instance.
2147 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
2148 # the metadata&#x27;s contents and used for optimistic locking. The
2149 # fingerprint is initially generated by Compute Engine and changes after
2150 # every request to modify or update metadata. You must always provide an
2151 # up-to-date fingerprint hash in order to update or change metadata,
2152 # otherwise the request will fail with error412 conditionNotMet.
2153 #
2154 # To see the latest fingerprint, make a get() request to
2155 # retrieve the resource.
2156 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
2157 # less than 512 KB.
2158 { # Metadata
2159 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
2160 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
2161 # This is reflected as part of a URL in the metadata server. Additionally, to
2162 # avoid ambiguity, keys must not conflict with any other metadata keys
2163 # for the project.
2164 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
2165 # have meaning as interpreted by the image running in the instance. The
2166 # only restriction placed on values is that their size must be less than
2167 # or equal to 262144 bytes (256 KiB).
2168 },
2169 ],
2170 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
2171 # for metadata.
2172 },
2173 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
2174 # platform for the VM instance. Applicable values are the friendly names
2175 # of CPU platforms, such as minCpuPlatform: &quot;Intel
2176 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
2177 # Bridge&quot;.
2178 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
2179 # the resource. The resource name must be 1-63 characters long, and comply
2180 # withRFC1035.
2181 # Specifically, the name must be 1-63 characters long and match the regular
2182 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2183 # character must be a lowercase letter, and all following characters must be
2184 # a dash, lowercase letter, or digit, except the last character, which cannot
2185 # be a dash.
2186 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
2187 # interfaces are configured to interact with other network services, such as
2188 # connecting to the internet. Multiple interfaces are supported
2189 # per instance.
2190 { # A network interface resource attached to an instance.
2191 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
2192 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
2193 # no external internet access.
2194 { # An access configuration attached to an instance&#x27;s network interface.
2195 # Only one access config per instance is supported.
2196 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
2197 # The first IPv6 address of the external IPv6 range associated
2198 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
2199 # use a static external IP address, it must be unused and in the same region
2200 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2201 # assign an external IPv6 address from the instance&#x27;s subnetwork.
2202 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
2203 # external IPv6 range.
2204 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
2205 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
2206 # (IPv4), the default and recommended name is External NAT, but
2207 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
2208 # recommend name is External IPv6.
2209 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
2210 # address associated with this instance. Specify an unused static
2211 # external IP address available to the project or leave this field undefined
2212 # to use an IP from a shared ephemeral IP address pool. If you specify a
2213 # static external IP address, it must live in the same region as the zone of
2214 # the instance.
2215 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
2216 # configuration and can only take the following values: PREMIUM,STANDARD.
2217 #
2218 # If an AccessConfig is specified without a valid external IP address, an
2219 # ephemeral IP will be created with this networkTier.
2220 #
2221 # If an AccessConfig with a valid external IP address is specified, it must
2222 # match that of the networkTier associated with the Address resource owning
2223 # that IP.
2224 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
2225 #
2226 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
2227 # first IP in associated external IPv6 range.
2228 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
2229 # config.
2230 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
2231 # external IP address of the instance to a DNS domain name.
2232 #
2233 # This field is not used in ipv6AccessConfig. A default PTR
2234 # record will be created if the VM has external IPv6 range associated.
2235 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
2236 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
2237 },
2238 ],
2239 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
2240 # You can only specify this field for network interfaces in VPC networks.
2241 { # An alias IP range attached to an instance&#x27;s network interface.
2242 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
2243 # must belong to the specified subnetwork and cannot contain IP addresses
2244 # reserved by system or used by other network interfaces. This range may be
2245 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
2246 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
2247 # alias range. If not specified, the primary range of the subnetwork is used.
2248 },
2249 ],
2250 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
2251 # You can only specify this field for network interfaces in VPC networks.
2252 { # An alias IP range attached to an instance&#x27;s network interface.
2253 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
2254 # must belong to the specified subnetwork and cannot contain IP addresses
2255 # reserved by system or used by other network interfaces. This range may be
2256 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
2257 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
2258 # alias range. If not specified, the primary range of the subnetwork is used.
2259 },
2260 ],
2261 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
2262 # with network_attachment.
2263 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
2264 # This field will be ignored when inserting an Instance or
2265 # adding a NetworkInterface. An up-to-date
2266 # fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
2267 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
2268 # or not. If enabled, also indicates the version of IGMP supported.
2269 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
2270 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
2271 # one IPv6 access config, DIRECT_IPV6, is supported. If there
2272 # is no ipv6AccessConfig specified, then this instance will
2273 # have no external IPv6 Internet access.
2274 { # An access configuration attached to an instance&#x27;s network interface.
2275 # Only one access config per instance is supported.
2276 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
2277 # The first IPv6 address of the external IPv6 range associated
2278 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
2279 # use a static external IP address, it must be unused and in the same region
2280 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2281 # assign an external IPv6 address from the instance&#x27;s subnetwork.
2282 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
2283 # external IPv6 range.
2284 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
2285 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
2286 # (IPv4), the default and recommended name is External NAT, but
2287 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
2288 # recommend name is External IPv6.
2289 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
2290 # address associated with this instance. Specify an unused static
2291 # external IP address available to the project or leave this field undefined
2292 # to use an IP from a shared ephemeral IP address pool. If you specify a
2293 # static external IP address, it must live in the same region as the zone of
2294 # the instance.
2295 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
2296 # configuration and can only take the following values: PREMIUM,STANDARD.
2297 #
2298 # If an AccessConfig is specified without a valid external IP address, an
2299 # ephemeral IP will be created with this networkTier.
2300 #
2301 # If an AccessConfig with a valid external IP address is specified, it must
2302 # match that of the networkTier associated with the Address resource owning
2303 # that IP.
2304 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
2305 #
2306 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
2307 # first IP in associated external IPv6 range.
2308 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
2309 # config.
2310 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
2311 # external IP address of the instance to a DNS domain name.
2312 #
2313 # This field is not used in ipv6AccessConfig. A default PTR
2314 # record will be created if the VM has external IPv6 range associated.
2315 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
2316 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
2317 },
2318 ],
2319 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
2320 # accessed from the Internet. This field is always inherited from its
2321 # subnetwork.
2322 #
2323 # Valid only if stackType is IPV4_IPV6.
2324 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
2325 # use a static internal IP address, it must be unused and in the same region
2326 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2327 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
2328 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
2329 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
2330 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
2331 # server. For a VM, the network interface uses the nicN naming
2332 # format. Where N is a value between 0 and7. The default interface value is nic0.
2333 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
2334 # instance, if neither the network nor the subnetwork is specified, the
2335 # default network global/networks/default is used. If the
2336 # selected project doesn&#x27;t have the default network, you must specify a
2337 # network or subnet. If the network is not specified but the subnetwork is
2338 # specified, the network is inferred.
2339 #
2340 # If you specify this property, you can specify the network as
2341 # a full or partial URL. For example, the following are all valid URLs:
2342 #
2343 #
2344 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
2345 # - projects/project/global/networks/network
2346 # - global/networks/default
2347 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
2348 # to in the following format:
2349 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
2350 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
2351 # interface. If not specified by the user, an unused internal IP is
2352 # assigned by the system.
2353 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
2354 # VirtioNet.
2355 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
2356 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
2357 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
2358 # if not specified by the users.
2359 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
2360 # interface. Can only be used with network_attachment. It is not possible to
2361 # use on its own however, network_attachment can be used without
2362 # service_class_id.
2363 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
2364 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
2365 #
2366 # This field can be both set at instance creation and update network
2367 # interface operations.
2368 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
2369 # resource is inlegacy
2370 # mode, do not specify this field. If the network is in auto subnet
2371 # mode, specifying the subnetwork is optional. If the network is in custom
2372 # subnet mode, specifying the subnetwork is required. If you specify this
2373 # field, you can specify the subnetwork as a full or partial URL. For
2374 # example, the following are all valid URLs:
2375 #
2376 #
2377 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
2378 # - regions/region/subnetworks/subnetwork
2379 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
2380 # from 2 to 255 inclusively.
2381 },
2382 ],
2383 &quot;networkPerformanceConfig&quot;: {
2384 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
2385 },
2386 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
2387 # as part of resource payload.
2388 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
2389 # Instances.Insert API.
2390 # as a count of seconds and fractions of seconds at nanosecond
2391 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2392 # or &quot;month&quot;. Range is approximately 10,000 years.
2393 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2394 # Durations less than one second are represented with a 0
2395 # `seconds` field and a positive `nanos` field. Must be from 0
2396 # to 999,999,999 inclusive.
2397 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2398 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2399 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2400 },
2401 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
2402 # have the same definition as resource
2403 # manager tags. Keys and values can be either in numeric format,
2404 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2405 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2406 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2407 # PATCH) when empty.
2408 &quot;a_key&quot;: &quot;A String&quot;,
2409 },
2410 },
2411 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
2412 # (namespace) to entries map.
2413 &quot;a_key&quot;: {
2414 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
2415 # It accepts any value including google.protobuf.Struct.
2416 &quot;a_key&quot;: &quot;&quot;,
2417 },
2418 },
2419 },
2420 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
2421 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
2422 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
2423 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
2424 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
2425 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
2426 # Consuming reserved instances for examples.
2427 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
2428 # the name of your reservation as its value.
2429 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
2430 # either a name to a reservation in the same project or
2431 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
2432 # shared reservation in the same zone but in a different project.
2433 &quot;A String&quot;,
2434 ],
2435 },
2436 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
2437 &quot;A String&quot;,
2438 ],
2439 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
2440 # compared to the values requested by user in the corresponding input only
2441 # field.
2442 # Use this sub-message for actual values set on Instance attributes as compared
2443 # to the value requested by the user (intent) in their instance CRUD calls.
2444 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
2445 # zonal instance settings, and instance-level predefined metadata keys to
2446 # provide the overridden value for those metadata keys at the instance level.
2447 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
2448 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
2449 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
2450 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
2451 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
2452 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
2453 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
2454 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
2455 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
2456 },
2457 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
2458 # center, including the block, sub-block, and host. The field is formatted as
2459 # follows: blockId/subBlockId/hostId.
2460 &quot;physicalHostTopology&quot;: { # Represents the physical host topology of the host on which the VM is # Output only. [Output Only] A series of fields containing the global name of the Compute
2461 # Engine cluster, as well as the ID of the block, sub-block, and host on
2462 # which the running instance is located.
2463 # running.
2464 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
2465 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
2466 # example
2467 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
2468 # the location ID of the topologies.
2469 &quot;a_key&quot;: &quot;A String&quot;,
2470 },
2471 },
2472 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
2473 # located. Instances within the same block experience low network latency.
2474 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
2475 # running instance is located.
2476 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
2477 # Instances on the same host experience the lowest possible network
2478 # latency.
2479 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
2480 # located. Instances in the same sub-block experience lower network latency
2481 # than instances in the same block.
2482 },
2483 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
2484 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
2485 # instance is consuming from.
2486 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
2487 # instance is consuming from.
2488 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
2489 # this instance is consuming from.
2490 },
2491 &quot;scheduling&quot;: {
2492 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
2493 # must be a number between 1 and the number of availability domains
2494 # specified in the spread placement policy attached to the instance.
2495 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
2496 },
2497 &quot;shutdownDetails&quot;: { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state.
2498 # programmed stop scheduled.
2499 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
2500 # `stop_state=PENDING_STOP`.
2501 # as a count of seconds and fractions of seconds at nanosecond
2502 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2503 # or &quot;month&quot;. Range is approximately 10,000 years.
2504 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2505 # Durations less than one second are represented with a 0
2506 # `seconds` field and a positive `nanos` field. Must be from 0
2507 # to 999,999,999 inclusive.
2508 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2509 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2510 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2511 },
2512 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
2513 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
2514 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
2515 },
2516 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
2517 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
2518 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
2519 # This timestamp value is in RFC3339 text format.
2520 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
2521 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
2522 &quot;A String&quot;,
2523 ],
2524 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
2525 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
2526 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
2527 # This timestamp value is in RFC3339 text format.
2528 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
2529 # This timestamp value is in RFC3339 text format.
2530 },
2531 },
2532 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2533 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2534 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
2535 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
2536 # terminated by Compute Engine (not terminated by a user). You can only set
2537 # the automatic restart option for standard instances.Preemptible instances
2538 # cannot be automatically restarted.
2539 #
2540 # By default, this is set to true so an instance is
2541 # automatically restarted if it is terminated by Compute Engine.
2542 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
2543 # must be a number between 1 and the number of availability domains
2544 # specified in the spread placement policy attached to the instance.
2545 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
2546 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
2547 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the
2548 # graceful shutdown isn&#x27;t complete after this time, then the instance
2549 # transitions to the STOPPING state.
2550 # as a count of seconds and fractions of seconds at nanosecond
2551 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2552 # or &quot;month&quot;. Range is approximately 10,000 years.
2553 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2554 # Durations less than one second are represented with a 0
2555 # `seconds` field and a positive `nanos` field. Must be from 0
2556 # to 999,999,999 inclusive.
2557 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2558 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2559 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2560 },
2561 },
2562 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
2563 # within the range of [90, 330] with the increment of 30, if unset, the
2564 # default behavior of host error recovery will be used.
2565 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
2566 &quot;localSsdRecoveryTimeout&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
2567 # recovery of the Local Ssd state is attempted. Its value should be in
2568 # between 0 and 168 hours with hour granularity and the default value being 1
2569 # hour.
2570 # as a count of seconds and fractions of seconds at nanosecond
2571 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2572 # or &quot;month&quot;. Range is approximately 10,000 years.
2573 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2574 # Durations less than one second are represented with a 0
2575 # `seconds` field and a positive `nanos` field. Must be from 0
2576 # to 999,999,999 inclusive.
2577 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2578 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2579 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2580 },
2581 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
2582 # resources.
2583 # This field is for use by internal tools that use the public API.
2584 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
2585 # be scheduled for maintenance.
2586 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
2587 # are: `PERIODIC`.
2588 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
2589 # the instance termination action will be performed at the end of the run
2590 # duration.
2591 # as a count of seconds and fractions of seconds at nanosecond
2592 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2593 # or &quot;month&quot;. Range is approximately 10,000 years.
2594 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2595 # Durations less than one second are represented with a 0
2596 # `seconds` field and a positive `nanos` field. Must be from 0
2597 # to 999,999,999 inclusive.
2598 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2599 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2600 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2601 },
2602 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
2603 # on a sole-tenant node.
2604 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
2605 # affinity for more information.
2606 # Overrides reservationAffinity.
2607 { # Node Affinity: the configuration of desired nodes onto which this Instance
2608 # could be scheduled.
2609 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
2610 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
2611 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
2612 &quot;A String&quot;,
2613 ],
2614 },
2615 ],
2616 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
2617 # the default behavior is MIGRATE. Forpreemptible instances,
2618 # the default and only possible behavior is TERMINATE. For more
2619 # information, see
2620 # Set
2621 # VM host maintenance policy.
2622 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
2623 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
2624 # else, the Local SSD data will be preserved when the instance is stopped
2625 # at the end of the run duration/termination time.
2626 },
2627 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
2628 # instance creation or while the instance isstopped and
2629 # therefore, in a `TERMINATED` state. SeeInstance Life
2630 # Cycle for more information on the possible instance states.
2631 &quot;preemptionNoticeDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
2632 # Off signal is triggered for Spot
2633 # VMs only. If not specified, there will be no wait before the G2 Soft
2634 # Off signal is triggered.
2635 # as a count of seconds and fractions of seconds at nanosecond
2636 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2637 # or &quot;month&quot;. Range is approximately 10,000 years.
2638 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2639 # Durations less than one second are represented with a 0
2640 # `seconds` field and a positive `nanos` field. Must be from 0
2641 # to 999,999,999 inclusive.
2642 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2643 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2644 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2645 },
2646 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
2647 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
2648 # Off and ACPI G3 Mechanical
2649 # Off for Standard VMs and 30 seconds for Spot VMs.
2650 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
2651 # termination action will be performed at the termination time.
2652 },
2653 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2654 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
2655 # this instance. Only one service account per VM instance is supported.
2656 #
2657 # Service accounts generate access tokens that can be accessed
2658 # through the metadata server and used to authenticate applications on the
2659 # instance. SeeService Accounts
2660 # for more information.
2661 { # A service account.
2662 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
2663 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
2664 &quot;A String&quot;,
2665 ],
2666 },
2667 ],
2668 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
2669 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
2670 # default.
2671 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
2672 # default.
2673 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
2674 # default.
2675 },
2676 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
2677 # Instance boot integrity is measured.
2678 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
2679 # measurements from the VM instance&#x27;s most recent boot.
2680 },
2681 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
2682 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
2683 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
2684 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
2685 },
2686 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
2687 # VM instance boot integrity is measured.
2688 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
2689 # measurements from the VM instance&#x27;s most recent boot.
2690 },
2691 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
2692 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
2693 # machine image.
2694 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2695 # For example:
2696 #
2697 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2698 # key_region/cryptoKeys/key
2699 #
2700 # The fully-qualifed key name may be returned for resource GET requests. For
2701 # example:
2702 #
2703 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2704 # key_region/cryptoKeys/key
2705 # /cryptoKeyVersions/1
2706 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2707 # key. If absent, the Compute Engine default service account is used.
2708 # For example:
2709 #
2710 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2711 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2712 # encryption key, encoded in RFC
2713 # 4648 base64 to either encrypt or decrypt this resource. You can
2714 # provide either the rawKey or thersaEncryptedKey.
2715 # For example:
2716 #
2717 # &quot;rawKey&quot;:
2718 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2719 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2720 # customer-supplied encryption key to either encrypt or decrypt this
2721 # resource. You can provide either the rawKey or thersaEncryptedKey.
2722 # For example:
2723 #
2724 # &quot;rsaEncryptedKey&quot;:
2725 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2726 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2727 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2728 #
2729 # The key must meet the following requirements before you can provide it to
2730 # Compute Engine:
2731 #
2732 # 1. The key is wrapped using a RSA public key certificate provided by
2733 # Google.
2734 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2735 # encoding.
2736 #
2737 # Gets the RSA public key certificate provided by Google at:
2738 #
2739 #
2740 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2741 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2742 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2743 # encryption key that protects this resource.
2744 },
2745 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
2746 # Engine has detected suspicious activity.
2747 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
2748 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
2749 # instance, see
2750 # Instance life cycle.
2751 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
2752 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
2753 # sources or targets for network firewalls and are specified by the client
2754 # during instance creation. The tags can be later modified by the setTags
2755 # method. Each tag within the list must comply withRFC1035.
2756 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
2757 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
2758 # the tags&#x27; contents and used for optimistic locking. The
2759 # fingerprint is initially generated by Compute Engine and changes after
2760 # every request to modify or update tags. You must always provide an
2761 # up-to-date fingerprint hash in order to update or change tags.
2762 #
2763 # To see the latest fingerprint, make get() request to the
2764 # instance.
2765 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
2766 # with RFC1035.
2767 &quot;A String&quot;,
2768 ],
2769 },
2770 &quot;workloadIdentityConfig&quot;: {
2771 &quot;identity&quot;: &quot;A String&quot;,
2772 &quot;identityCertificateEnabled&quot;: True or False,
2773 },
2774 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
2775 # You must specify this field as part of the HTTP request URL. It is
2776 # not settable as a field in the request body.
2777 },
2778 ],
2779 &quot;warning&quot;: { # [Output Only] Informational warning which replaces the list of instances
2780 # when the list is empty.
2781 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2782 # Engine returns NO_RESULTS_ON_PAGE if there
2783 # are no results in the response.
2784 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2785 # value format. For example:
2786 #
2787 # &quot;data&quot;: [
2788 # {
2789 # &quot;key&quot;: &quot;scope&quot;,
2790 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2791 # }
2792 {
2793 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2794 # returned. For example, for warnings where there are no results in a list
2795 # request for a particular zone, this key might be scope and
2796 # the key value might be the zone name. Other examples might be a key
2797 # indicating a deprecated resource and a suggested replacement, or a
2798 # warning about invalid network settings (for example, if an instance
2799 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2800 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2801 },
2802 ],
2803 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2804 },
2805 },
2806 },
2807 &quot;kind&quot;: &quot;compute#instanceAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#instanceAggregatedList for aggregated lists of
2808 # Instance resources.
2809 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2810 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2811 # the query parameter pageToken in the next list request.
2812 # Subsequent list requests will have their own nextPageToken to
2813 # continue paging through the results.
2814 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2815 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
2816 &quot;A String&quot;,
2817 ],
2818 &quot;warning&quot;: { # [Output Only] Informational warning message.
2819 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2820 # Engine returns NO_RESULTS_ON_PAGE if there
2821 # are no results in the response.
2822 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2823 # value format. For example:
2824 #
2825 # &quot;data&quot;: [
2826 # {
2827 # &quot;key&quot;: &quot;scope&quot;,
2828 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2829 # }
2830 {
2831 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2832 # returned. For example, for warnings where there are no results in a list
2833 # request for a particular zone, this key might be scope and
2834 # the key value might be the zone name. Other examples might be a key
2835 # indicating a deprecated resource and a suggested replacement, or a
2836 # warning about invalid network settings (for example, if an instance
2837 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2838 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2839 },
2840 ],
2841 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2842 },
2843 }</pre>
2844 </div>
2845
2846 <div class="method">
2847 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
2848 <pre>Retrieves the next page of results.
2849
2850 Args:
2851 previous_request: The request for the previous page. (required)
2852 previous_response: The response from the request for the previous page. (required)
2853
2854 Returns:
2855 A request object that you can call &#x27;execute()&#x27; on to request the next
2856 page. Returns None if there are no more items in the collection.
2857 </pre>
2858 </div>
2859
2860 <div class="method">
2861 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None, x__xgafv=None)</code>
2862 <pre>Attaches an existing Disk resource to an instance. You must first
2863 create the disk before you can attach it. It is not possible to create
2864 and attach a disk at the same time. For more information, readAdding a
2865 persistent disk to your instance.
2866
2867 Args:
2868 project: string, Project ID for this request. (required)
2869 zone: string, The name of the zone for this request. (required)
2870 instance: string, The instance name for this request. (required)
2871 body: object, The request body.
2872 The object takes the form of:
2873
2874 { # An instance-attached disk resource.
2875 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
2876 # or X86_64.
2877 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
2878 # deleted (but not when the disk is detached from the instance).
2879 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
2880 # partition of the disk for its root filesystem.
2881 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
2882 # running within the instance. This name can be used to reference the device
2883 # for mounting, resizing, and so on, from within the instance.
2884 #
2885 # If not specified, the server chooses a default device name to apply to this
2886 # disk, in the form persistent-disk-x, where x is a number
2887 # assigned by Google Compute Engine. This field is only applicable for
2888 # persistent disks.
2889 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
2890 # encryption key.
2891 #
2892 # If you are creating a new disk, this field encrypts the new disk using
2893 # an encryption key that you provide. If you are attaching an existing
2894 # disk that is already encrypted, this field decrypts the disk using
2895 # the customer-supplied encryption key.
2896 #
2897 # If you encrypt a disk using a customer-supplied key, you must provide the
2898 # same key again when you attempt to use this resource at a later time. For
2899 # example, you must provide the key when you create a snapshot or an image
2900 # from the disk or when you attach the disk to a virtual machine instance.
2901 #
2902 # If you do not provide an encryption key, then the disk will be encrypted
2903 # using an automatically generated key and you do not need to provide a key
2904 # to use the disk later.
2905 #
2906 # Note:
2907 #
2908 # Instance templates do not storecustomer-supplied
2909 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
2910 #
2911 # You cannot create VMs that have disks with customer-supplied keys using
2912 # the bulk
2913 # insert method.
2914 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2915 # For example:
2916 #
2917 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2918 # key_region/cryptoKeys/key
2919 #
2920 # The fully-qualifed key name may be returned for resource GET requests. For
2921 # example:
2922 #
2923 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2924 # key_region/cryptoKeys/key
2925 # /cryptoKeyVersions/1
2926 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2927 # key. If absent, the Compute Engine default service account is used.
2928 # For example:
2929 #
2930 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2931 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2932 # encryption key, encoded in RFC
2933 # 4648 base64 to either encrypt or decrypt this resource. You can
2934 # provide either the rawKey or thersaEncryptedKey.
2935 # For example:
2936 #
2937 # &quot;rawKey&quot;:
2938 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2939 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2940 # customer-supplied encryption key to either encrypt or decrypt this
2941 # resource. You can provide either the rawKey or thersaEncryptedKey.
2942 # For example:
2943 #
2944 # &quot;rsaEncryptedKey&quot;:
2945 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2946 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2947 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2948 #
2949 # The key must meet the following requirements before you can provide it to
2950 # Compute Engine:
2951 #
2952 # 1. The key is wrapped using a RSA public key certificate provided by
2953 # Google.
2954 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2955 # encoding.
2956 #
2957 # Gets the RSA public key certificate provided by Google at:
2958 #
2959 #
2960 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2961 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2962 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2963 # encryption key that protects this resource.
2964 },
2965 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
2966 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
2967 # currently attached to another instance. If you try to force attach a zonal
2968 # disk to an instance, you will receive an error.
2969 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
2970 # only for bootable images. Read
2971 # Enabling guest operating system features to see a list of available
2972 # options.
2973 { # Guest OS features.
2974 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
2975 # separate values. Set to one or more of the following values:
2976 #
2977 # - VIRTIO_SCSI_MULTIQUEUE
2978 # - WINDOWS
2979 # - MULTI_IP_SUBNET
2980 # - UEFI_COMPATIBLE
2981 # - GVNIC
2982 # - SEV_CAPABLE
2983 # - SUSPEND_RESUME_COMPATIBLE
2984 # - SEV_LIVE_MIGRATABLE_V2
2985 # - SEV_SNP_CAPABLE
2986 # - TDX_CAPABLE
2987 # - IDPF
2988 # - SNP_SVSM_CAPABLE
2989 # - CCA_CAPABLE
2990 #
2991 #
2992 # For more information, see
2993 # Enabling guest operating system features.
2994 },
2995 ],
2996 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
2997 # boot disk. If you have many disks attached to an instance, each
2998 # disk would have a unique index number.
2999 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
3000 # alongside the new instance. Use initialization parameters to create boot
3001 # disks or local SSDs attached to the new instance.
3002 #
3003 # This property is mutually exclusive with the source property;
3004 # you can only define one or the other, but not both.
3005 # alongside the new instance. Use initialization parameters to create boot
3006 # disks or local SSDs attached to the new instance.
3007 #
3008 # This field is persisted and returned for instanceTemplate and not returned
3009 # in the context of instance.
3010 #
3011 # This property is mutually exclusive with the source property;
3012 # you can only define one or the other, but not both.
3013 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
3014 # arm64 or x86_64.
3015 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
3016 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
3017 # of the instance. If a disk with the same name already exists in the given
3018 # region, the existing disk is attached to the new instance and the
3019 # new disk is not created.
3020 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
3021 # 10 GB. If you specify a sourceImage, which is required for
3022 # boot disks, the default size is the size of the sourceImage.
3023 # If you do not specify a sourceImage, the default disk size
3024 # is 500 GB.
3025 &quot;diskType&quot;: &quot;A String&quot;,
3026 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
3027 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3028 # only for bootable images. Read
3029 # Enabling guest operating system features to see a list of available
3030 # options.
3031 #
3032 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
3033 { # Guest OS features.
3034 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3035 # separate values. Set to one or more of the following values:
3036 #
3037 # - VIRTIO_SCSI_MULTIQUEUE
3038 # - WINDOWS
3039 # - MULTI_IP_SUBNET
3040 # - UEFI_COMPATIBLE
3041 # - GVNIC
3042 # - SEV_CAPABLE
3043 # - SUSPEND_RESUME_COMPATIBLE
3044 # - SEV_LIVE_MIGRATABLE_V2
3045 # - SEV_SNP_CAPABLE
3046 # - TDX_CAPABLE
3047 # - IDPF
3048 # - SNP_SVSM_CAPABLE
3049 # - CCA_CAPABLE
3050 #
3051 #
3052 # For more information, see
3053 # Enabling guest operating system features.
3054 },
3055 ],
3056 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
3057 # persistent disks.
3058 &quot;a_key&quot;: &quot;A String&quot;,
3059 },
3060 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
3061 &quot;A String&quot;,
3062 ],
3063 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
3064 # more than one instance.
3065 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
3066 # is to use the existing disk.
3067 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
3068 # of I/O operations per second that the disk can handle. Values must be
3069 # between 10,000 and 120,000. For more details, see theExtreme persistent
3070 # disk documentation.
3071 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
3072 # number of throughput mb per second that the disk can handle. Values must
3073 # greater than or equal to 1.
3074 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
3075 # the URLs of the zones where the disk should be replicated to.
3076 # You must provide exactly two replica zones, and one zone must be the same
3077 # as the instance zone.
3078 &quot;A String&quot;,
3079 ],
3080 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
3081 # have the same definition as resource
3082 # manager tags. Keys and values can be either in numeric format,
3083 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3084 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3085 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
3086 # empty.
3087 &quot;a_key&quot;: &quot;A String&quot;,
3088 },
3089 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
3090 # Specified using the full or partial URL. For instance template, specify
3091 # only the resource policy name.
3092 &quot;A String&quot;,
3093 ],
3094 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
3095 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3096 # is required.
3097 #
3098 # To create a disk with one of the public operating system
3099 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
3100 #
3101 # projects/debian-cloud/global/images/family/debian-9
3102 #
3103 #
3104 # Alternatively, use a specific version of a public operating system image:
3105 #
3106 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
3107 #
3108 #
3109 # To create a disk with a custom image that you created, specify the
3110 # image name in the following format:
3111 #
3112 # global/images/my-custom-image
3113 #
3114 #
3115 # You can also specify a custom image by its image family, which returns
3116 # the latest version of the image in that family. Replace the image name
3117 # with family/family-name:
3118 #
3119 # global/images/family/my-image-family
3120 #
3121 #
3122 # If the source image is deleted later, this field will not be set.
3123 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
3124 # encryption key of the source image. Required if the source image is
3125 # protected by a customer-supplied encryption key.
3126 #
3127 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
3128 # encryption keys, so you cannot create disks for instances in a managed instance group if the
3129 # source images are encrypted with your own keys.
3130 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3131 # For example:
3132 #
3133 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3134 # key_region/cryptoKeys/key
3135 #
3136 # The fully-qualifed key name may be returned for resource GET requests. For
3137 # example:
3138 #
3139 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3140 # key_region/cryptoKeys/key
3141 # /cryptoKeyVersions/1
3142 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3143 # key. If absent, the Compute Engine default service account is used.
3144 # For example:
3145 #
3146 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3147 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3148 # encryption key, encoded in RFC
3149 # 4648 base64 to either encrypt or decrypt this resource. You can
3150 # provide either the rawKey or thersaEncryptedKey.
3151 # For example:
3152 #
3153 # &quot;rawKey&quot;:
3154 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3155 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3156 # customer-supplied encryption key to either encrypt or decrypt this
3157 # resource. You can provide either the rawKey or thersaEncryptedKey.
3158 # For example:
3159 #
3160 # &quot;rsaEncryptedKey&quot;:
3161 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3162 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3163 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3164 #
3165 # The key must meet the following requirements before you can provide it to
3166 # Compute Engine:
3167 #
3168 # 1. The key is wrapped using a RSA public key certificate provided by
3169 # Google.
3170 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3171 # encoding.
3172 #
3173 # Gets the RSA public key certificate provided by Google at:
3174 #
3175 #
3176 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3177 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3178 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3179 # encryption key that protects this resource.
3180 },
3181 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
3182 # instance boot disk, one of initializeParams.sourceSnapshot
3183 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
3184 # is required.
3185 #
3186 # To create a disk with a snapshot that you created, specify the
3187 # snapshot name in the following format:
3188 #
3189 # us-central1-a/instantSnapshots/my-backup
3190 #
3191 #
3192 # If the source instant-snapshot is deleted later, this field will not be
3193 # set.
3194 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
3195 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
3196 # is required.
3197 #
3198 # To create a disk with a snapshot that you created, specify the
3199 # snapshot name in the following format:
3200 #
3201 # global/snapshots/my-backup
3202 #
3203 #
3204 # If the source snapshot is deleted later, this field will not be set.
3205 #
3206 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
3207 # an image instead when you create VMs using
3208 # the bulk
3209 # insert method.
3210 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
3211 # encryption key of the source snapshot.
3212 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3213 # For example:
3214 #
3215 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3216 # key_region/cryptoKeys/key
3217 #
3218 # The fully-qualifed key name may be returned for resource GET requests. For
3219 # example:
3220 #
3221 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3222 # key_region/cryptoKeys/key
3223 # /cryptoKeyVersions/1
3224 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3225 # key. If absent, the Compute Engine default service account is used.
3226 # For example:
3227 #
3228 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3229 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3230 # encryption key, encoded in RFC
3231 # 4648 base64 to either encrypt or decrypt this resource. You can
3232 # provide either the rawKey or thersaEncryptedKey.
3233 # For example:
3234 #
3235 # &quot;rawKey&quot;:
3236 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3237 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3238 # customer-supplied encryption key to either encrypt or decrypt this
3239 # resource. You can provide either the rawKey or thersaEncryptedKey.
3240 # For example:
3241 #
3242 # &quot;rsaEncryptedKey&quot;:
3243 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3244 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3245 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3246 #
3247 # The key must meet the following requirements before you can provide it to
3248 # Compute Engine:
3249 #
3250 # 1. The key is wrapped using a RSA public key certificate provided by
3251 # Google.
3252 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3253 # encoding.
3254 #
3255 # Gets the RSA public key certificate provided by Google at:
3256 #
3257 #
3258 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3259 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3260 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3261 # encryption key that protects this resource.
3262 },
3263 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
3264 # this as a partial or full URL to the resource. For example, the following
3265 # are valid values:
3266 #
3267 #
3268 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
3269 # - projects/project/zones/zone/storagePools/storagePool
3270 # - zones/zone/storagePools/storagePool
3271 },
3272 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
3273 # either SCSI or NVME. For most machine types, the
3274 # default is SCSI. Local SSDs can use either NVME or SCSI.
3275 # In certain configurations, persistent disks can use NVMe. For more
3276 # information, seeAbout
3277 # persistent disks.
3278 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
3279 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
3280 &quot;A String&quot;,
3281 ],
3282 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
3283 # disk is not allowed to be detached from the instance, or to be used as the
3284 # source of the snapshot creation, and the image creation. The instance with
3285 # at least one locked attached disk is not allow to be used as source of
3286 # machine image creation, instant snapshot creation, and not allowed to be
3287 # deleted with --keep-disk parameter set to true for locked disks.
3288 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
3289 # in READ_WRITE mode.
3290 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
3291 # field is set to PRESERVED if the LocalSSD data has been saved
3292 # to a persistent location by customer request. (see the
3293 # discard_local_ssd option on Stop/Suspend).
3294 # Read-only in the api.
3295 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
3296 # these are public keys which are safe to store in public
3297 &quot;dbs&quot;: [ # The Key Database (db).
3298 {
3299 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3300 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3301 },
3302 ],
3303 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
3304 {
3305 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3306 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3307 },
3308 ],
3309 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
3310 {
3311 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3312 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3313 },
3314 ],
3315 &quot;pk&quot;: { # The Platform Key (PK).
3316 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3317 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3318 },
3319 },
3320 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
3321 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3322 # is required.
3323 #
3324 # If desired, you can also attach existing non-root persistent disks using
3325 # this property. This field is only applicable for persistent disks.
3326 #
3327 # Note that for InstanceTemplate, specify the disk name for zonal disk,
3328 # and the URL for regional disk.
3329 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
3330 }
3331
3332 forceAttach: boolean, Whether to force attach the regional disk even if it&#x27;s currently attached
3333 to another instance. If you try to force attach a zonal disk to an
3334 instance, you will receive an error.
3335 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3336 that if you must retry your request, the server will know to ignore the
3337 request if it has already been completed.
3338
3339 For example, consider a situation where you make an initial request and
3340 the request times out. If you make the request again with the same
3341 request ID, the server can check if original operation with the same
3342 request ID was received, and if so, will ignore the second request. This
3343 prevents clients from accidentally creating duplicate commitments.
3344
3345 The request ID must be
3346 a valid UUID with the exception that zero UUID is not supported
3347 (00000000-0000-0000-0000-000000000000).
3348 x__xgafv: string, V1 error format.
3349 Allowed values
3350 1 - v1 error format
3351 2 - v2 error format
3352
3353 Returns:
3354 An object of the form:
3355
3356 { # Represents an Operation resource.
3357 #
3358 # Google Compute Engine has three Operation resources:
3359 #
3360 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
3361 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
3362 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
3363 #
3364 # You can use an operation resource to manage asynchronous API requests.
3365 # For more information, readHandling
3366 # API responses.
3367 #
3368 # Operations can be global, regional or zonal.
3369 #
3370 # - For global operations, use the `globalOperations`
3371 # resource.
3372 # - For regional operations, use the
3373 # `regionOperations` resource.
3374 # - For zonal operations, use
3375 # the `zoneOperations` resource.
3376 #
3377 #
3378 #
3379 # For more information, read
3380 # Global, Regional, and Zonal Resources.
3381 #
3382 # Note that completed Operation resources have a limited
3383 # retention period.
3384 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3385 # Not present otherwise.
3386 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3387 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3388 # set when the operation is created.
3389 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3390 # text format.
3391 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3392 # this field will be populated.
3393 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3394 # operation.
3395 {
3396 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3397 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3398 # details. There is a set of defined message types to use for providing
3399 # details.The syntax depends on the error code. For example,
3400 # QuotaExceededInfo will have details when the error code is
3401 # QUOTA_EXCEEDED.
3402 {
3403 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3404 #
3405 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3406 # is not enabled:
3407 #
3408 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3409 # &quot;domain&quot;: &quot;googleapis.com&quot;
3410 # &quot;metadata&quot;: {
3411 # &quot;resource&quot;: &quot;projects/123&quot;,
3412 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3413 # }
3414 # }
3415 #
3416 # This response indicates that the pubsub.googleapis.com API is not enabled.
3417 #
3418 # Example of an error that is returned when attempting to create a Spanner
3419 # instance in a region that is out of stock:
3420 #
3421 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3422 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3423 # &quot;metadata&quot;: {
3424 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3425 # }
3426 # }
3427 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3428 # is typically the registered service name of the tool or product that
3429 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3430 # generated by some common infrastructure, the error domain must be a
3431 # globally unique value that identifies the infrastructure. For Google API
3432 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3433 &quot;metadatas&quot;: { # Additional structured details about this error.
3434 #
3435 # Keys must match a regular expression of `a-z+` but should
3436 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3437 # length. When identifying the current value of an exceeded limit, the units
3438 # should be contained in the key, not the value. For example, rather than
3439 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3440 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3441 # instances that can be created in a single (batch) request.
3442 &quot;a_key&quot;: &quot;A String&quot;,
3443 },
3444 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3445 # proximate cause of the error. Error reasons are unique within a particular
3446 # domain of errors. This should be at most 63 characters and match a
3447 # regular expression of `A-Z+[A-Z0-9]`, which represents
3448 # UPPER_SNAKE_CASE.
3449 },
3450 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3451 #
3452 # For example, if a quota check failed with an error indicating the calling
3453 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3454 # directly to the right place in the developer console to flip the bit.
3455 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3456 { # Describes a URL link.
3457 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3458 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3459 },
3460 ],
3461 },
3462 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3463 # which can be attached to an RPC error.
3464 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3465 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3466 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3467 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3468 },
3469 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3470 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3471 &quot;a_key&quot;: &quot;A String&quot;,
3472 },
3473 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3474 # type or metric.
3475 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3476 # or metric.
3477 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3478 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3479 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3480 },
3481 },
3482 ],
3483 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3484 # This property is optional.
3485 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3486 },
3487 ],
3488 },
3489 &quot;getVersionOperationMetadata&quot;: {
3490 &quot;inlineSbomInfo&quot;: {
3491 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3492 # appropriate identifiers.
3493 &quot;a_key&quot;: &quot;A String&quot;,
3494 },
3495 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3496 # identifiers.
3497 &quot;a_key&quot;: &quot;A String&quot;,
3498 },
3499 },
3500 },
3501 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3502 # message that was returned, such as `NOT FOUND`.
3503 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3504 # status code that was returned. For example, a `404` means the
3505 # resource was not found.
3506 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3507 # defined by the server.
3508 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3509 # This value is inRFC3339
3510 # text format.
3511 &quot;instancesBulkInsertOperationMetadata&quot;: {
3512 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3513 # Example key: zones/us-central1-a
3514 &quot;a_key&quot;: {
3515 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3516 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3517 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3518 # error.
3519 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3520 # if the flow is rolling forward or rolling back.
3521 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3522 },
3523 },
3524 },
3525 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3526 # Operation resources.
3527 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3528 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3529 # group of operations results from a `bulkInsert` API request.
3530 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3531 # `update`, or `delete`, and so on.
3532 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3533 # There is no requirement that this be linear or support any granularity of
3534 # operations. This should not be used to guess when the operation will be
3535 # complete. This number should monotonically increase as the operation
3536 # progresses.
3537 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3538 # applicable when performing regional operations.
3539 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3540 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3541 # this field will contain information on all underlying zonal actions and
3542 # their state.
3543 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3544 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3545 # Example key: zones/us-central1-a
3546 &quot;a_key&quot;: {
3547 &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
3548 # populated.
3549 # different programming environments, including REST APIs and RPC APIs. It is
3550 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3551 # three pieces of data: error code, error message, and error details.
3552 #
3553 # You can find out more about this error model and how to work with it in the
3554 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3555 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3556 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3557 # message types for APIs to use.
3558 {
3559 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3560 },
3561 ],
3562 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3563 # user-facing error message should be localized and sent in the
3564 # google.rpc.Status.details field, or localized by the client.
3565 },
3566 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3567 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3568 },
3569 },
3570 },
3571 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3572 # This value is inRFC3339
3573 # text format.
3574 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3575 # following:
3576 # `PENDING`, `RUNNING`, or `DONE`.
3577 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3578 # operation.
3579 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3580 # of the target resource.
3581 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3582 # operations related to creating a snapshot, this points to the disk
3583 # that the snapshot was created from.
3584 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3585 # `[email protected]` or
3586 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3587 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3588 # operation, this field will be populated.
3589 {
3590 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3591 # Engine returns NO_RESULTS_ON_PAGE if there
3592 # are no results in the response.
3593 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3594 # value format. For example:
3595 #
3596 # &quot;data&quot;: [
3597 # {
3598 # &quot;key&quot;: &quot;scope&quot;,
3599 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3600 # }
3601 {
3602 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3603 # returned. For example, for warnings where there are no results in a list
3604 # request for a particular zone, this key might be scope and
3605 # the key value might be the zone name. Other examples might be a key
3606 # indicating a deprecated resource and a suggested replacement, or a
3607 # warning about invalid network settings (for example, if an instance
3608 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3609 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3610 },
3611 ],
3612 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3613 },
3614 ],
3615 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3616 # applicable when performing per-zone operations.
3617 }</pre>
3618 </div>
3619
3620 <div class="method">
3621 <code class="details" id="bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
3622 <pre>Creates multiple instances. Count specifies the number of instances to
3623 create. For more information, seeAbout bulk
3624 creation of VMs.
3625
3626 Args:
3627 project: string, Project ID for this request. (required)
3628 zone: string, The name of the zone for this request. (required)
3629 body: object, The request body.
3630 The object takes the form of:
3631
3632 { # A transient resource used in compute.instances.bulkInsert and
3633 # compute.regionInstances.bulkInsert . This resource is not persisted
3634 # anywhere, it is used only for processing the requests.
3635 &quot;count&quot;: &quot;A String&quot;, # The maximum number of instances to create.
3636 &quot;instanceFlexibilityPolicy&quot;: { # A flexible specification of machine types for instances to create. # A flexible specification of machine type of instances to create.
3637 &quot;instanceSelections&quot;: { # Specification of alternative, flexible instance subsets.
3638 # One of them will be selected to create the instances
3639 # based on various criteria, like:
3640 # - ranks,
3641 # - location policy,
3642 # - current capacity,
3643 # - available reservations (you can specify affinity in
3644 # InstanceProperties),
3645 # - SWAN/GOOSE limitations.
3646 # Key is an arbitrary, unique RFC1035 string that identifies the instance
3647 # selection.
3648 &quot;a_key&quot;: { # Specification of machine type to use. Every position inside this message
3649 # is an alternative.
3650 # The count specified in the shape flexibility must not exceed the number
3651 # of entries in per_instance_properties or the capacity of the
3652 # name_pattern, if used.
3653 &quot;disks&quot;: [ # Disks to be attached to the instances created from in this selection.
3654 # They override the disks specified in the instance properties.
3655 { # An instance-attached disk resource.
3656 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
3657 # or X86_64.
3658 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
3659 # deleted (but not when the disk is detached from the instance).
3660 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
3661 # partition of the disk for its root filesystem.
3662 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
3663 # running within the instance. This name can be used to reference the device
3664 # for mounting, resizing, and so on, from within the instance.
3665 #
3666 # If not specified, the server chooses a default device name to apply to this
3667 # disk, in the form persistent-disk-x, where x is a number
3668 # assigned by Google Compute Engine. This field is only applicable for
3669 # persistent disks.
3670 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
3671 # encryption key.
3672 #
3673 # If you are creating a new disk, this field encrypts the new disk using
3674 # an encryption key that you provide. If you are attaching an existing
3675 # disk that is already encrypted, this field decrypts the disk using
3676 # the customer-supplied encryption key.
3677 #
3678 # If you encrypt a disk using a customer-supplied key, you must provide the
3679 # same key again when you attempt to use this resource at a later time. For
3680 # example, you must provide the key when you create a snapshot or an image
3681 # from the disk or when you attach the disk to a virtual machine instance.
3682 #
3683 # If you do not provide an encryption key, then the disk will be encrypted
3684 # using an automatically generated key and you do not need to provide a key
3685 # to use the disk later.
3686 #
3687 # Note:
3688 #
3689 # Instance templates do not storecustomer-supplied
3690 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
3691 #
3692 # You cannot create VMs that have disks with customer-supplied keys using
3693 # the bulk
3694 # insert method.
3695 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3696 # For example:
3697 #
3698 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3699 # key_region/cryptoKeys/key
3700 #
3701 # The fully-qualifed key name may be returned for resource GET requests. For
3702 # example:
3703 #
3704 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3705 # key_region/cryptoKeys/key
3706 # /cryptoKeyVersions/1
3707 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3708 # key. If absent, the Compute Engine default service account is used.
3709 # For example:
3710 #
3711 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3712 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3713 # encryption key, encoded in RFC
3714 # 4648 base64 to either encrypt or decrypt this resource. You can
3715 # provide either the rawKey or thersaEncryptedKey.
3716 # For example:
3717 #
3718 # &quot;rawKey&quot;:
3719 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3720 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3721 # customer-supplied encryption key to either encrypt or decrypt this
3722 # resource. You can provide either the rawKey or thersaEncryptedKey.
3723 # For example:
3724 #
3725 # &quot;rsaEncryptedKey&quot;:
3726 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3727 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3728 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3729 #
3730 # The key must meet the following requirements before you can provide it to
3731 # Compute Engine:
3732 #
3733 # 1. The key is wrapped using a RSA public key certificate provided by
3734 # Google.
3735 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3736 # encoding.
3737 #
3738 # Gets the RSA public key certificate provided by Google at:
3739 #
3740 #
3741 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3742 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3743 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3744 # encryption key that protects this resource.
3745 },
3746 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
3747 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
3748 # currently attached to another instance. If you try to force attach a zonal
3749 # disk to an instance, you will receive an error.
3750 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3751 # only for bootable images. Read
3752 # Enabling guest operating system features to see a list of available
3753 # options.
3754 { # Guest OS features.
3755 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3756 # separate values. Set to one or more of the following values:
3757 #
3758 # - VIRTIO_SCSI_MULTIQUEUE
3759 # - WINDOWS
3760 # - MULTI_IP_SUBNET
3761 # - UEFI_COMPATIBLE
3762 # - GVNIC
3763 # - SEV_CAPABLE
3764 # - SUSPEND_RESUME_COMPATIBLE
3765 # - SEV_LIVE_MIGRATABLE_V2
3766 # - SEV_SNP_CAPABLE
3767 # - TDX_CAPABLE
3768 # - IDPF
3769 # - SNP_SVSM_CAPABLE
3770 # - CCA_CAPABLE
3771 #
3772 #
3773 # For more information, see
3774 # Enabling guest operating system features.
3775 },
3776 ],
3777 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
3778 # boot disk. If you have many disks attached to an instance, each
3779 # disk would have a unique index number.
3780 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
3781 # alongside the new instance. Use initialization parameters to create boot
3782 # disks or local SSDs attached to the new instance.
3783 #
3784 # This property is mutually exclusive with the source property;
3785 # you can only define one or the other, but not both.
3786 # alongside the new instance. Use initialization parameters to create boot
3787 # disks or local SSDs attached to the new instance.
3788 #
3789 # This field is persisted and returned for instanceTemplate and not returned
3790 # in the context of instance.
3791 #
3792 # This property is mutually exclusive with the source property;
3793 # you can only define one or the other, but not both.
3794 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
3795 # arm64 or x86_64.
3796 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
3797 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
3798 # of the instance. If a disk with the same name already exists in the given
3799 # region, the existing disk is attached to the new instance and the
3800 # new disk is not created.
3801 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
3802 # 10 GB. If you specify a sourceImage, which is required for
3803 # boot disks, the default size is the size of the sourceImage.
3804 # If you do not specify a sourceImage, the default disk size
3805 # is 500 GB.
3806 &quot;diskType&quot;: &quot;A String&quot;,
3807 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
3808 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3809 # only for bootable images. Read
3810 # Enabling guest operating system features to see a list of available
3811 # options.
3812 #
3813 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
3814 { # Guest OS features.
3815 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3816 # separate values. Set to one or more of the following values:
3817 #
3818 # - VIRTIO_SCSI_MULTIQUEUE
3819 # - WINDOWS
3820 # - MULTI_IP_SUBNET
3821 # - UEFI_COMPATIBLE
3822 # - GVNIC
3823 # - SEV_CAPABLE
3824 # - SUSPEND_RESUME_COMPATIBLE
3825 # - SEV_LIVE_MIGRATABLE_V2
3826 # - SEV_SNP_CAPABLE
3827 # - TDX_CAPABLE
3828 # - IDPF
3829 # - SNP_SVSM_CAPABLE
3830 # - CCA_CAPABLE
3831 #
3832 #
3833 # For more information, see
3834 # Enabling guest operating system features.
3835 },
3836 ],
3837 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
3838 # persistent disks.
3839 &quot;a_key&quot;: &quot;A String&quot;,
3840 },
3841 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
3842 &quot;A String&quot;,
3843 ],
3844 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
3845 # more than one instance.
3846 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
3847 # is to use the existing disk.
3848 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
3849 # of I/O operations per second that the disk can handle. Values must be
3850 # between 10,000 and 120,000. For more details, see theExtreme persistent
3851 # disk documentation.
3852 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
3853 # number of throughput mb per second that the disk can handle. Values must
3854 # greater than or equal to 1.
3855 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
3856 # the URLs of the zones where the disk should be replicated to.
3857 # You must provide exactly two replica zones, and one zone must be the same
3858 # as the instance zone.
3859 &quot;A String&quot;,
3860 ],
3861 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
3862 # have the same definition as resource
3863 # manager tags. Keys and values can be either in numeric format,
3864 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3865 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3866 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
3867 # empty.
3868 &quot;a_key&quot;: &quot;A String&quot;,
3869 },
3870 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
3871 # Specified using the full or partial URL. For instance template, specify
3872 # only the resource policy name.
3873 &quot;A String&quot;,
3874 ],
3875 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
3876 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3877 # is required.
3878 #
3879 # To create a disk with one of the public operating system
3880 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
3881 #
3882 # projects/debian-cloud/global/images/family/debian-9
3883 #
3884 #
3885 # Alternatively, use a specific version of a public operating system image:
3886 #
3887 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
3888 #
3889 #
3890 # To create a disk with a custom image that you created, specify the
3891 # image name in the following format:
3892 #
3893 # global/images/my-custom-image
3894 #
3895 #
3896 # You can also specify a custom image by its image family, which returns
3897 # the latest version of the image in that family. Replace the image name
3898 # with family/family-name:
3899 #
3900 # global/images/family/my-image-family
3901 #
3902 #
3903 # If the source image is deleted later, this field will not be set.
3904 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
3905 # encryption key of the source image. Required if the source image is
3906 # protected by a customer-supplied encryption key.
3907 #
3908 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
3909 # encryption keys, so you cannot create disks for instances in a managed instance group if the
3910 # source images are encrypted with your own keys.
3911 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3912 # For example:
3913 #
3914 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3915 # key_region/cryptoKeys/key
3916 #
3917 # The fully-qualifed key name may be returned for resource GET requests. For
3918 # example:
3919 #
3920 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3921 # key_region/cryptoKeys/key
3922 # /cryptoKeyVersions/1
3923 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3924 # key. If absent, the Compute Engine default service account is used.
3925 # For example:
3926 #
3927 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3928 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3929 # encryption key, encoded in RFC
3930 # 4648 base64 to either encrypt or decrypt this resource. You can
3931 # provide either the rawKey or thersaEncryptedKey.
3932 # For example:
3933 #
3934 # &quot;rawKey&quot;:
3935 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3936 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3937 # customer-supplied encryption key to either encrypt or decrypt this
3938 # resource. You can provide either the rawKey or thersaEncryptedKey.
3939 # For example:
3940 #
3941 # &quot;rsaEncryptedKey&quot;:
3942 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3943 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3944 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3945 #
3946 # The key must meet the following requirements before you can provide it to
3947 # Compute Engine:
3948 #
3949 # 1. The key is wrapped using a RSA public key certificate provided by
3950 # Google.
3951 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3952 # encoding.
3953 #
3954 # Gets the RSA public key certificate provided by Google at:
3955 #
3956 #
3957 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3958 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3959 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3960 # encryption key that protects this resource.
3961 },
3962 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
3963 # instance boot disk, one of initializeParams.sourceSnapshot
3964 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
3965 # is required.
3966 #
3967 # To create a disk with a snapshot that you created, specify the
3968 # snapshot name in the following format:
3969 #
3970 # us-central1-a/instantSnapshots/my-backup
3971 #
3972 #
3973 # If the source instant-snapshot is deleted later, this field will not be
3974 # set.
3975 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
3976 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
3977 # is required.
3978 #
3979 # To create a disk with a snapshot that you created, specify the
3980 # snapshot name in the following format:
3981 #
3982 # global/snapshots/my-backup
3983 #
3984 #
3985 # If the source snapshot is deleted later, this field will not be set.
3986 #
3987 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
3988 # an image instead when you create VMs using
3989 # the bulk
3990 # insert method.
3991 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
3992 # encryption key of the source snapshot.
3993 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3994 # For example:
3995 #
3996 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3997 # key_region/cryptoKeys/key
3998 #
3999 # The fully-qualifed key name may be returned for resource GET requests. For
4000 # example:
4001 #
4002 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4003 # key_region/cryptoKeys/key
4004 # /cryptoKeyVersions/1
4005 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4006 # key. If absent, the Compute Engine default service account is used.
4007 # For example:
4008 #
4009 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4010 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4011 # encryption key, encoded in RFC
4012 # 4648 base64 to either encrypt or decrypt this resource. You can
4013 # provide either the rawKey or thersaEncryptedKey.
4014 # For example:
4015 #
4016 # &quot;rawKey&quot;:
4017 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4018 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4019 # customer-supplied encryption key to either encrypt or decrypt this
4020 # resource. You can provide either the rawKey or thersaEncryptedKey.
4021 # For example:
4022 #
4023 # &quot;rsaEncryptedKey&quot;:
4024 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4025 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4026 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4027 #
4028 # The key must meet the following requirements before you can provide it to
4029 # Compute Engine:
4030 #
4031 # 1. The key is wrapped using a RSA public key certificate provided by
4032 # Google.
4033 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4034 # encoding.
4035 #
4036 # Gets the RSA public key certificate provided by Google at:
4037 #
4038 #
4039 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4040 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4041 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4042 # encryption key that protects this resource.
4043 },
4044 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
4045 # this as a partial or full URL to the resource. For example, the following
4046 # are valid values:
4047 #
4048 #
4049 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
4050 # - projects/project/zones/zone/storagePools/storagePool
4051 # - zones/zone/storagePools/storagePool
4052 },
4053 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
4054 # either SCSI or NVME. For most machine types, the
4055 # default is SCSI. Local SSDs can use either NVME or SCSI.
4056 # In certain configurations, persistent disks can use NVMe. For more
4057 # information, seeAbout
4058 # persistent disks.
4059 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
4060 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
4061 &quot;A String&quot;,
4062 ],
4063 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
4064 # disk is not allowed to be detached from the instance, or to be used as the
4065 # source of the snapshot creation, and the image creation. The instance with
4066 # at least one locked attached disk is not allow to be used as source of
4067 # machine image creation, instant snapshot creation, and not allowed to be
4068 # deleted with --keep-disk parameter set to true for locked disks.
4069 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
4070 # in READ_WRITE mode.
4071 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
4072 # field is set to PRESERVED if the LocalSSD data has been saved
4073 # to a persistent location by customer request. (see the
4074 # discard_local_ssd option on Stop/Suspend).
4075 # Read-only in the api.
4076 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
4077 # these are public keys which are safe to store in public
4078 &quot;dbs&quot;: [ # The Key Database (db).
4079 {
4080 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4081 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4082 },
4083 ],
4084 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
4085 {
4086 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4087 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4088 },
4089 ],
4090 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
4091 {
4092 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4093 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4094 },
4095 ],
4096 &quot;pk&quot;: { # The Platform Key (PK).
4097 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4098 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4099 },
4100 },
4101 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
4102 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4103 # is required.
4104 #
4105 # If desired, you can also attach existing non-root persistent disks using
4106 # this property. This field is only applicable for persistent disks.
4107 #
4108 # Note that for InstanceTemplate, specify the disk name for zonal disk,
4109 # and the URL for regional disk.
4110 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
4111 },
4112 ],
4113 &quot;machineTypes&quot;: [ # Alternative machine types to use for instances that are created from
4114 # these properties. This field only accepts a machine type names, for
4115 # example `n2-standard-4` and not URLs or partial URLs.
4116 &quot;A String&quot;,
4117 ],
4118 &quot;rank&quot;: &quot;A String&quot;, # Rank when prioritizing the shape flexibilities.
4119 # The instance selections with rank are considered
4120 # first, in the ascending order of the rank.
4121 # If not set, defaults to 0.
4122 },
4123 },
4124 },
4125 &quot;instanceProperties&quot;: { # The instance properties defining the VM instances to be created. Required
4126 # if sourceInstanceTemplate is not provided.
4127 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
4128 # Note that for MachineImage, this is not supported yet.
4129 # Options that would traditionally be configured in a BIOS belong
4130 # here. Features that require operating system support may have
4131 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
4132 # disabled).
4133 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
4134 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
4135 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
4136 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
4137 # multithreading (SMT) set this to 1. If unset, the maximum number
4138 # of threads supported per core by the underlying processor is
4139 # assumed.
4140 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
4141 # Supported modes include:
4142 # * ALL_CORE_MAX
4143 #
4144 # Using empty string or not setting this field will use the platform-specific
4145 # default turbo mode.
4146 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
4147 # the number of threads per core to compute the total number of virtual
4148 # CPUs to expose to the instance. If unset, the number of cores is
4149 # inferred from the instance&#x27;s nominal CPU count and the underlying
4150 # platform&#x27;s SMT width.
4151 },
4152 &quot;canIpForward&quot;: True or False, # Enables instances created based on these properties to send packets with
4153 # source IP addresses other than their own and receive packets with
4154 # destination IP addresses other than their own. If these instances will be
4155 # used as an IP gateway or it will be set as the next-hop in a Route
4156 # resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding
4157 # documentation for more information.
4158 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
4159 # Note that for MachineImage, this is not supported yet.
4160 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
4161 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
4162 },
4163 &quot;description&quot;: &quot;A String&quot;, # An optional text description for the instances that are created from these
4164 # properties.
4165 &quot;disks&quot;: [ # An array of disks that are associated with the instances that are created
4166 # from these properties.
4167 { # An instance-attached disk resource.
4168 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
4169 # or X86_64.
4170 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
4171 # deleted (but not when the disk is detached from the instance).
4172 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
4173 # partition of the disk for its root filesystem.
4174 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
4175 # running within the instance. This name can be used to reference the device
4176 # for mounting, resizing, and so on, from within the instance.
4177 #
4178 # If not specified, the server chooses a default device name to apply to this
4179 # disk, in the form persistent-disk-x, where x is a number
4180 # assigned by Google Compute Engine. This field is only applicable for
4181 # persistent disks.
4182 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
4183 # encryption key.
4184 #
4185 # If you are creating a new disk, this field encrypts the new disk using
4186 # an encryption key that you provide. If you are attaching an existing
4187 # disk that is already encrypted, this field decrypts the disk using
4188 # the customer-supplied encryption key.
4189 #
4190 # If you encrypt a disk using a customer-supplied key, you must provide the
4191 # same key again when you attempt to use this resource at a later time. For
4192 # example, you must provide the key when you create a snapshot or an image
4193 # from the disk or when you attach the disk to a virtual machine instance.
4194 #
4195 # If you do not provide an encryption key, then the disk will be encrypted
4196 # using an automatically generated key and you do not need to provide a key
4197 # to use the disk later.
4198 #
4199 # Note:
4200 #
4201 # Instance templates do not storecustomer-supplied
4202 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
4203 #
4204 # You cannot create VMs that have disks with customer-supplied keys using
4205 # the bulk
4206 # insert method.
4207 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4208 # For example:
4209 #
4210 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4211 # key_region/cryptoKeys/key
4212 #
4213 # The fully-qualifed key name may be returned for resource GET requests. For
4214 # example:
4215 #
4216 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4217 # key_region/cryptoKeys/key
4218 # /cryptoKeyVersions/1
4219 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4220 # key. If absent, the Compute Engine default service account is used.
4221 # For example:
4222 #
4223 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4224 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4225 # encryption key, encoded in RFC
4226 # 4648 base64 to either encrypt or decrypt this resource. You can
4227 # provide either the rawKey or thersaEncryptedKey.
4228 # For example:
4229 #
4230 # &quot;rawKey&quot;:
4231 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4232 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4233 # customer-supplied encryption key to either encrypt or decrypt this
4234 # resource. You can provide either the rawKey or thersaEncryptedKey.
4235 # For example:
4236 #
4237 # &quot;rsaEncryptedKey&quot;:
4238 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4239 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4240 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4241 #
4242 # The key must meet the following requirements before you can provide it to
4243 # Compute Engine:
4244 #
4245 # 1. The key is wrapped using a RSA public key certificate provided by
4246 # Google.
4247 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4248 # encoding.
4249 #
4250 # Gets the RSA public key certificate provided by Google at:
4251 #
4252 #
4253 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4254 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4255 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4256 # encryption key that protects this resource.
4257 },
4258 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
4259 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
4260 # currently attached to another instance. If you try to force attach a zonal
4261 # disk to an instance, you will receive an error.
4262 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4263 # only for bootable images. Read
4264 # Enabling guest operating system features to see a list of available
4265 # options.
4266 { # Guest OS features.
4267 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4268 # separate values. Set to one or more of the following values:
4269 #
4270 # - VIRTIO_SCSI_MULTIQUEUE
4271 # - WINDOWS
4272 # - MULTI_IP_SUBNET
4273 # - UEFI_COMPATIBLE
4274 # - GVNIC
4275 # - SEV_CAPABLE
4276 # - SUSPEND_RESUME_COMPATIBLE
4277 # - SEV_LIVE_MIGRATABLE_V2
4278 # - SEV_SNP_CAPABLE
4279 # - TDX_CAPABLE
4280 # - IDPF
4281 # - SNP_SVSM_CAPABLE
4282 # - CCA_CAPABLE
4283 #
4284 #
4285 # For more information, see
4286 # Enabling guest operating system features.
4287 },
4288 ],
4289 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
4290 # boot disk. If you have many disks attached to an instance, each
4291 # disk would have a unique index number.
4292 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
4293 # alongside the new instance. Use initialization parameters to create boot
4294 # disks or local SSDs attached to the new instance.
4295 #
4296 # This property is mutually exclusive with the source property;
4297 # you can only define one or the other, but not both.
4298 # alongside the new instance. Use initialization parameters to create boot
4299 # disks or local SSDs attached to the new instance.
4300 #
4301 # This field is persisted and returned for instanceTemplate and not returned
4302 # in the context of instance.
4303 #
4304 # This property is mutually exclusive with the source property;
4305 # you can only define one or the other, but not both.
4306 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
4307 # arm64 or x86_64.
4308 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
4309 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
4310 # of the instance. If a disk with the same name already exists in the given
4311 # region, the existing disk is attached to the new instance and the
4312 # new disk is not created.
4313 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
4314 # 10 GB. If you specify a sourceImage, which is required for
4315 # boot disks, the default size is the size of the sourceImage.
4316 # If you do not specify a sourceImage, the default disk size
4317 # is 500 GB.
4318 &quot;diskType&quot;: &quot;A String&quot;,
4319 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
4320 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4321 # only for bootable images. Read
4322 # Enabling guest operating system features to see a list of available
4323 # options.
4324 #
4325 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
4326 { # Guest OS features.
4327 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4328 # separate values. Set to one or more of the following values:
4329 #
4330 # - VIRTIO_SCSI_MULTIQUEUE
4331 # - WINDOWS
4332 # - MULTI_IP_SUBNET
4333 # - UEFI_COMPATIBLE
4334 # - GVNIC
4335 # - SEV_CAPABLE
4336 # - SUSPEND_RESUME_COMPATIBLE
4337 # - SEV_LIVE_MIGRATABLE_V2
4338 # - SEV_SNP_CAPABLE
4339 # - TDX_CAPABLE
4340 # - IDPF
4341 # - SNP_SVSM_CAPABLE
4342 # - CCA_CAPABLE
4343 #
4344 #
4345 # For more information, see
4346 # Enabling guest operating system features.
4347 },
4348 ],
4349 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
4350 # persistent disks.
4351 &quot;a_key&quot;: &quot;A String&quot;,
4352 },
4353 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
4354 &quot;A String&quot;,
4355 ],
4356 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
4357 # more than one instance.
4358 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
4359 # is to use the existing disk.
4360 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
4361 # of I/O operations per second that the disk can handle. Values must be
4362 # between 10,000 and 120,000. For more details, see theExtreme persistent
4363 # disk documentation.
4364 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
4365 # number of throughput mb per second that the disk can handle. Values must
4366 # greater than or equal to 1.
4367 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
4368 # the URLs of the zones where the disk should be replicated to.
4369 # You must provide exactly two replica zones, and one zone must be the same
4370 # as the instance zone.
4371 &quot;A String&quot;,
4372 ],
4373 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
4374 # have the same definition as resource
4375 # manager tags. Keys and values can be either in numeric format,
4376 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4377 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4378 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
4379 # empty.
4380 &quot;a_key&quot;: &quot;A String&quot;,
4381 },
4382 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
4383 # Specified using the full or partial URL. For instance template, specify
4384 # only the resource policy name.
4385 &quot;A String&quot;,
4386 ],
4387 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
4388 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4389 # is required.
4390 #
4391 # To create a disk with one of the public operating system
4392 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
4393 #
4394 # projects/debian-cloud/global/images/family/debian-9
4395 #
4396 #
4397 # Alternatively, use a specific version of a public operating system image:
4398 #
4399 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
4400 #
4401 #
4402 # To create a disk with a custom image that you created, specify the
4403 # image name in the following format:
4404 #
4405 # global/images/my-custom-image
4406 #
4407 #
4408 # You can also specify a custom image by its image family, which returns
4409 # the latest version of the image in that family. Replace the image name
4410 # with family/family-name:
4411 #
4412 # global/images/family/my-image-family
4413 #
4414 #
4415 # If the source image is deleted later, this field will not be set.
4416 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
4417 # encryption key of the source image. Required if the source image is
4418 # protected by a customer-supplied encryption key.
4419 #
4420 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
4421 # encryption keys, so you cannot create disks for instances in a managed instance group if the
4422 # source images are encrypted with your own keys.
4423 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4424 # For example:
4425 #
4426 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4427 # key_region/cryptoKeys/key
4428 #
4429 # The fully-qualifed key name may be returned for resource GET requests. For
4430 # example:
4431 #
4432 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4433 # key_region/cryptoKeys/key
4434 # /cryptoKeyVersions/1
4435 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4436 # key. If absent, the Compute Engine default service account is used.
4437 # For example:
4438 #
4439 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4440 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4441 # encryption key, encoded in RFC
4442 # 4648 base64 to either encrypt or decrypt this resource. You can
4443 # provide either the rawKey or thersaEncryptedKey.
4444 # For example:
4445 #
4446 # &quot;rawKey&quot;:
4447 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4448 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4449 # customer-supplied encryption key to either encrypt or decrypt this
4450 # resource. You can provide either the rawKey or thersaEncryptedKey.
4451 # For example:
4452 #
4453 # &quot;rsaEncryptedKey&quot;:
4454 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4455 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4456 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4457 #
4458 # The key must meet the following requirements before you can provide it to
4459 # Compute Engine:
4460 #
4461 # 1. The key is wrapped using a RSA public key certificate provided by
4462 # Google.
4463 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4464 # encoding.
4465 #
4466 # Gets the RSA public key certificate provided by Google at:
4467 #
4468 #
4469 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4470 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4471 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4472 # encryption key that protects this resource.
4473 },
4474 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
4475 # instance boot disk, one of initializeParams.sourceSnapshot
4476 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
4477 # is required.
4478 #
4479 # To create a disk with a snapshot that you created, specify the
4480 # snapshot name in the following format:
4481 #
4482 # us-central1-a/instantSnapshots/my-backup
4483 #
4484 #
4485 # If the source instant-snapshot is deleted later, this field will not be
4486 # set.
4487 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
4488 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
4489 # is required.
4490 #
4491 # To create a disk with a snapshot that you created, specify the
4492 # snapshot name in the following format:
4493 #
4494 # global/snapshots/my-backup
4495 #
4496 #
4497 # If the source snapshot is deleted later, this field will not be set.
4498 #
4499 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
4500 # an image instead when you create VMs using
4501 # the bulk
4502 # insert method.
4503 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
4504 # encryption key of the source snapshot.
4505 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4506 # For example:
4507 #
4508 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4509 # key_region/cryptoKeys/key
4510 #
4511 # The fully-qualifed key name may be returned for resource GET requests. For
4512 # example:
4513 #
4514 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4515 # key_region/cryptoKeys/key
4516 # /cryptoKeyVersions/1
4517 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4518 # key. If absent, the Compute Engine default service account is used.
4519 # For example:
4520 #
4521 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4522 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4523 # encryption key, encoded in RFC
4524 # 4648 base64 to either encrypt or decrypt this resource. You can
4525 # provide either the rawKey or thersaEncryptedKey.
4526 # For example:
4527 #
4528 # &quot;rawKey&quot;:
4529 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4530 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4531 # customer-supplied encryption key to either encrypt or decrypt this
4532 # resource. You can provide either the rawKey or thersaEncryptedKey.
4533 # For example:
4534 #
4535 # &quot;rsaEncryptedKey&quot;:
4536 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4537 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4538 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4539 #
4540 # The key must meet the following requirements before you can provide it to
4541 # Compute Engine:
4542 #
4543 # 1. The key is wrapped using a RSA public key certificate provided by
4544 # Google.
4545 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4546 # encoding.
4547 #
4548 # Gets the RSA public key certificate provided by Google at:
4549 #
4550 #
4551 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4552 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4553 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4554 # encryption key that protects this resource.
4555 },
4556 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
4557 # this as a partial or full URL to the resource. For example, the following
4558 # are valid values:
4559 #
4560 #
4561 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
4562 # - projects/project/zones/zone/storagePools/storagePool
4563 # - zones/zone/storagePools/storagePool
4564 },
4565 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
4566 # either SCSI or NVME. For most machine types, the
4567 # default is SCSI. Local SSDs can use either NVME or SCSI.
4568 # In certain configurations, persistent disks can use NVMe. For more
4569 # information, seeAbout
4570 # persistent disks.
4571 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
4572 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
4573 &quot;A String&quot;,
4574 ],
4575 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
4576 # disk is not allowed to be detached from the instance, or to be used as the
4577 # source of the snapshot creation, and the image creation. The instance with
4578 # at least one locked attached disk is not allow to be used as source of
4579 # machine image creation, instant snapshot creation, and not allowed to be
4580 # deleted with --keep-disk parameter set to true for locked disks.
4581 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
4582 # in READ_WRITE mode.
4583 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
4584 # field is set to PRESERVED if the LocalSSD data has been saved
4585 # to a persistent location by customer request. (see the
4586 # discard_local_ssd option on Stop/Suspend).
4587 # Read-only in the api.
4588 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
4589 # these are public keys which are safe to store in public
4590 &quot;dbs&quot;: [ # The Key Database (db).
4591 {
4592 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4593 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4594 },
4595 ],
4596 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
4597 {
4598 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4599 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4600 },
4601 ],
4602 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
4603 {
4604 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4605 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4606 },
4607 ],
4608 &quot;pk&quot;: { # The Platform Key (PK).
4609 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4610 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4611 },
4612 },
4613 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
4614 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4615 # is required.
4616 #
4617 # If desired, you can also attach existing non-root persistent disks using
4618 # this property. This field is only applicable for persistent disks.
4619 #
4620 # Note that for InstanceTemplate, specify the disk name for zonal disk,
4621 # and the URL for regional disk.
4622 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
4623 },
4624 ],
4625 &quot;displayDevice&quot;: { # A set of Display Device options # Display Device properties to enable support
4626 # for remote display products like: Teradici,
4627 # VNC and TeamViewer
4628 # Note that for MachineImage, this is not supported yet.
4629 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
4630 },
4631 &quot;guestAccelerators&quot;: [ # A list of guest accelerator cards&#x27; type and count to use for instances
4632 # created from these properties.
4633 { # A specification of the type and number of accelerator cards attached to the
4634 # instance.
4635 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
4636 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
4637 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
4638 # If you are creating an instance template, specify only the
4639 # accelerator name.
4640 # See GPUs on Compute Engine
4641 # for a full list of accelerator types.
4642 },
4643 ],
4644 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
4645 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
4646 &quot;labels&quot;: { # Labels to apply to instances that are created from these properties.
4647 &quot;a_key&quot;: &quot;A String&quot;,
4648 },
4649 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for instances that are created from these
4650 # properties.
4651 # This field only accepts a machine type name, for example `n2-standard-4`.
4652 # If you use the machine type full or partial URL, for example
4653 # `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
4654 # the request will result in an `INTERNAL_ERROR`.
4655 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
4656 # these properties. These pairs can consist of custom metadata or predefined
4657 # keys. SeeProject and
4658 # instance metadata for more information.
4659 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
4660 # the metadata&#x27;s contents and used for optimistic locking. The
4661 # fingerprint is initially generated by Compute Engine and changes after
4662 # every request to modify or update metadata. You must always provide an
4663 # up-to-date fingerprint hash in order to update or change metadata,
4664 # otherwise the request will fail with error412 conditionNotMet.
4665 #
4666 # To see the latest fingerprint, make a get() request to
4667 # retrieve the resource.
4668 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
4669 # less than 512 KB.
4670 { # Metadata
4671 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
4672 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
4673 # This is reflected as part of a URL in the metadata server. Additionally, to
4674 # avoid ambiguity, keys must not conflict with any other metadata keys
4675 # for the project.
4676 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
4677 # have meaning as interpreted by the image running in the instance. The
4678 # only restriction placed on values is that their size must be less than
4679 # or equal to 262144 bytes (256 KiB).
4680 },
4681 ],
4682 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
4683 # for metadata.
4684 },
4685 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform to be used by instances. The instance may be
4686 # scheduled on the specified or newer cpu/platform. Applicable values are the
4687 # friendly names of CPU platforms, such asminCpuPlatform: &quot;Intel Haswell&quot; orminCpuPlatform: &quot;Intel Sandy Bridge&quot;. For more
4688 # information, read Specifying a
4689 # Minimum CPU Platform.
4690 &quot;networkInterfaces&quot;: [ # An array of network access configurations for this interface.
4691 { # A network interface resource attached to an instance.
4692 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
4693 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
4694 # no external internet access.
4695 { # An access configuration attached to an instance&#x27;s network interface.
4696 # Only one access config per instance is supported.
4697 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
4698 # The first IPv6 address of the external IPv6 range associated
4699 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
4700 # use a static external IP address, it must be unused and in the same region
4701 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
4702 # assign an external IPv6 address from the instance&#x27;s subnetwork.
4703 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
4704 # external IPv6 range.
4705 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
4706 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
4707 # (IPv4), the default and recommended name is External NAT, but
4708 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
4709 # recommend name is External IPv6.
4710 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
4711 # address associated with this instance. Specify an unused static
4712 # external IP address available to the project or leave this field undefined
4713 # to use an IP from a shared ephemeral IP address pool. If you specify a
4714 # static external IP address, it must live in the same region as the zone of
4715 # the instance.
4716 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
4717 # configuration and can only take the following values: PREMIUM,STANDARD.
4718 #
4719 # If an AccessConfig is specified without a valid external IP address, an
4720 # ephemeral IP will be created with this networkTier.
4721 #
4722 # If an AccessConfig with a valid external IP address is specified, it must
4723 # match that of the networkTier associated with the Address resource owning
4724 # that IP.
4725 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
4726 #
4727 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
4728 # first IP in associated external IPv6 range.
4729 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
4730 # config.
4731 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
4732 # external IP address of the instance to a DNS domain name.
4733 #
4734 # This field is not used in ipv6AccessConfig. A default PTR
4735 # record will be created if the VM has external IPv6 range associated.
4736 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
4737 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
4738 },
4739 ],
4740 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
4741 # You can only specify this field for network interfaces in VPC networks.
4742 { # An alias IP range attached to an instance&#x27;s network interface.
4743 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
4744 # must belong to the specified subnetwork and cannot contain IP addresses
4745 # reserved by system or used by other network interfaces. This range may be
4746 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
4747 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
4748 # alias range. If not specified, the primary range of the subnetwork is used.
4749 },
4750 ],
4751 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
4752 # You can only specify this field for network interfaces in VPC networks.
4753 { # An alias IP range attached to an instance&#x27;s network interface.
4754 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
4755 # must belong to the specified subnetwork and cannot contain IP addresses
4756 # reserved by system or used by other network interfaces. This range may be
4757 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
4758 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
4759 # alias range. If not specified, the primary range of the subnetwork is used.
4760 },
4761 ],
4762 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
4763 # with network_attachment.
4764 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
4765 # This field will be ignored when inserting an Instance or
4766 # adding a NetworkInterface. An up-to-date
4767 # fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
4768 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
4769 # or not. If enabled, also indicates the version of IGMP supported.
4770 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
4771 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
4772 # one IPv6 access config, DIRECT_IPV6, is supported. If there
4773 # is no ipv6AccessConfig specified, then this instance will
4774 # have no external IPv6 Internet access.
4775 { # An access configuration attached to an instance&#x27;s network interface.
4776 # Only one access config per instance is supported.
4777 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
4778 # The first IPv6 address of the external IPv6 range associated
4779 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
4780 # use a static external IP address, it must be unused and in the same region
4781 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
4782 # assign an external IPv6 address from the instance&#x27;s subnetwork.
4783 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
4784 # external IPv6 range.
4785 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
4786 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
4787 # (IPv4), the default and recommended name is External NAT, but
4788 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
4789 # recommend name is External IPv6.
4790 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
4791 # address associated with this instance. Specify an unused static
4792 # external IP address available to the project or leave this field undefined
4793 # to use an IP from a shared ephemeral IP address pool. If you specify a
4794 # static external IP address, it must live in the same region as the zone of
4795 # the instance.
4796 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
4797 # configuration and can only take the following values: PREMIUM,STANDARD.
4798 #
4799 # If an AccessConfig is specified without a valid external IP address, an
4800 # ephemeral IP will be created with this networkTier.
4801 #
4802 # If an AccessConfig with a valid external IP address is specified, it must
4803 # match that of the networkTier associated with the Address resource owning
4804 # that IP.
4805 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
4806 #
4807 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
4808 # first IP in associated external IPv6 range.
4809 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
4810 # config.
4811 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
4812 # external IP address of the instance to a DNS domain name.
4813 #
4814 # This field is not used in ipv6AccessConfig. A default PTR
4815 # record will be created if the VM has external IPv6 range associated.
4816 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
4817 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
4818 },
4819 ],
4820 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
4821 # accessed from the Internet. This field is always inherited from its
4822 # subnetwork.
4823 #
4824 # Valid only if stackType is IPV4_IPV6.
4825 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
4826 # use a static internal IP address, it must be unused and in the same region
4827 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
4828 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
4829 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
4830 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
4831 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
4832 # server. For a VM, the network interface uses the nicN naming
4833 # format. Where N is a value between 0 and7. The default interface value is nic0.
4834 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
4835 # instance, if neither the network nor the subnetwork is specified, the
4836 # default network global/networks/default is used. If the
4837 # selected project doesn&#x27;t have the default network, you must specify a
4838 # network or subnet. If the network is not specified but the subnetwork is
4839 # specified, the network is inferred.
4840 #
4841 # If you specify this property, you can specify the network as
4842 # a full or partial URL. For example, the following are all valid URLs:
4843 #
4844 #
4845 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
4846 # - projects/project/global/networks/network
4847 # - global/networks/default
4848 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
4849 # to in the following format:
4850 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
4851 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
4852 # interface. If not specified by the user, an unused internal IP is
4853 # assigned by the system.
4854 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
4855 # VirtioNet.
4856 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
4857 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
4858 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
4859 # if not specified by the users.
4860 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
4861 # interface. Can only be used with network_attachment. It is not possible to
4862 # use on its own however, network_attachment can be used without
4863 # service_class_id.
4864 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
4865 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
4866 #
4867 # This field can be both set at instance creation and update network
4868 # interface operations.
4869 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
4870 # resource is inlegacy
4871 # mode, do not specify this field. If the network is in auto subnet
4872 # mode, specifying the subnetwork is optional. If the network is in custom
4873 # subnet mode, specifying the subnetwork is required. If you specify this
4874 # field, you can specify the subnetwork as a full or partial URL. For
4875 # example, the following are all valid URLs:
4876 #
4877 #
4878 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
4879 # - regions/region/subnetworks/subnetwork
4880 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
4881 # from 2 to 255 inclusively.
4882 },
4883 ],
4884 &quot;networkPerformanceConfig&quot;: { # Note that for MachineImage, this is not supported yet.
4885 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
4886 },
4887 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance properties. A map from a
4888 # subdomain (namespace) to entries map.
4889 &quot;a_key&quot;: {
4890 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
4891 # It accepts any value including google.protobuf.Struct.
4892 &quot;a_key&quot;: &quot;&quot;,
4893 },
4894 },
4895 },
4896 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
4897 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for VMs.
4898 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
4899 # Note that for MachineImage, this is not supported yet.
4900 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
4901 # Note that for MachineImage, this is not supported yet.
4902 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
4903 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
4904 # Consuming reserved instances for examples.
4905 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
4906 # the name of your reservation as its value.
4907 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
4908 # either a name to a reservation in the same project or
4909 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
4910 # shared reservation in the same zone but in a different project.
4911 &quot;A String&quot;,
4912 ],
4913 },
4914 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
4915 # have the same definition as resource
4916 # manager tags. Keys and values can be either in numeric format,
4917 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4918 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4919 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
4920 # PATCH) when empty.
4921 &quot;a_key&quot;: &quot;A String&quot;,
4922 },
4923 &quot;resourcePolicies&quot;: [ # Resource policies (names, not URLs) applied to instances created from
4924 # these properties.
4925 # Note that for MachineImage, this is not supported yet.
4926 &quot;A String&quot;,
4927 ],
4928 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
4929 # these properties.
4930 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
4931 # terminated by Compute Engine (not terminated by a user). You can only set
4932 # the automatic restart option for standard instances.Preemptible instances
4933 # cannot be automatically restarted.
4934 #
4935 # By default, this is set to true so an instance is
4936 # automatically restarted if it is terminated by Compute Engine.
4937 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
4938 # must be a number between 1 and the number of availability domains
4939 # specified in the spread placement policy attached to the instance.
4940 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
4941 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
4942 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the
4943 # graceful shutdown isn&#x27;t complete after this time, then the instance
4944 # transitions to the STOPPING state.
4945 # as a count of seconds and fractions of seconds at nanosecond
4946 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4947 # or &quot;month&quot;. Range is approximately 10,000 years.
4948 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4949 # Durations less than one second are represented with a 0
4950 # `seconds` field and a positive `nanos` field. Must be from 0
4951 # to 999,999,999 inclusive.
4952 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4953 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4954 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4955 },
4956 },
4957 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
4958 # within the range of [90, 330] with the increment of 30, if unset, the
4959 # default behavior of host error recovery will be used.
4960 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
4961 &quot;localSsdRecoveryTimeout&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
4962 # recovery of the Local Ssd state is attempted. Its value should be in
4963 # between 0 and 168 hours with hour granularity and the default value being 1
4964 # hour.
4965 # as a count of seconds and fractions of seconds at nanosecond
4966 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4967 # or &quot;month&quot;. Range is approximately 10,000 years.
4968 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4969 # Durations less than one second are represented with a 0
4970 # `seconds` field and a positive `nanos` field. Must be from 0
4971 # to 999,999,999 inclusive.
4972 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4973 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4974 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4975 },
4976 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
4977 # resources.
4978 # This field is for use by internal tools that use the public API.
4979 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
4980 # be scheduled for maintenance.
4981 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
4982 # are: `PERIODIC`.
4983 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
4984 # the instance termination action will be performed at the end of the run
4985 # duration.
4986 # as a count of seconds and fractions of seconds at nanosecond
4987 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4988 # or &quot;month&quot;. Range is approximately 10,000 years.
4989 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4990 # Durations less than one second are represented with a 0
4991 # `seconds` field and a positive `nanos` field. Must be from 0
4992 # to 999,999,999 inclusive.
4993 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4994 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4995 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4996 },
4997 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
4998 # on a sole-tenant node.
4999 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
5000 # affinity for more information.
5001 # Overrides reservationAffinity.
5002 { # Node Affinity: the configuration of desired nodes onto which this Instance
5003 # could be scheduled.
5004 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
5005 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
5006 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
5007 &quot;A String&quot;,
5008 ],
5009 },
5010 ],
5011 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
5012 # the default behavior is MIGRATE. Forpreemptible instances,
5013 # the default and only possible behavior is TERMINATE. For more
5014 # information, see
5015 # Set
5016 # VM host maintenance policy.
5017 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
5018 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
5019 # else, the Local SSD data will be preserved when the instance is stopped
5020 # at the end of the run duration/termination time.
5021 },
5022 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
5023 # instance creation or while the instance isstopped and
5024 # therefore, in a `TERMINATED` state. SeeInstance Life
5025 # Cycle for more information on the possible instance states.
5026 &quot;preemptionNoticeDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
5027 # Off signal is triggered for Spot
5028 # VMs only. If not specified, there will be no wait before the G2 Soft
5029 # Off signal is triggered.
5030 # as a count of seconds and fractions of seconds at nanosecond
5031 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5032 # or &quot;month&quot;. Range is approximately 10,000 years.
5033 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5034 # Durations less than one second are represented with a 0
5035 # `seconds` field and a positive `nanos` field. Must be from 0
5036 # to 999,999,999 inclusive.
5037 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5038 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5039 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5040 },
5041 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
5042 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
5043 # Off and ACPI G3 Mechanical
5044 # Off for Standard VMs and 30 seconds for Spot VMs.
5045 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
5046 # termination action will be performed at the termination time.
5047 },
5048 &quot;serviceAccounts&quot;: [ # A list of service accounts with specified scopes. Access tokens for these
5049 # service accounts are available to the instances that are created from
5050 # these properties. Use metadata queries to obtain the access tokens for
5051 # these instances.
5052 { # A service account.
5053 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
5054 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
5055 &quot;A String&quot;,
5056 ],
5057 },
5058 ],
5059 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet.
5060 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
5061 # default.
5062 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
5063 # default.
5064 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
5065 # default.
5066 },
5067 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from
5068 # these properties.
5069 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
5070 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
5071 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
5072 },
5073 &quot;tags&quot;: { # A set of instance tags. # A list of tags to apply to the instances that are created from these
5074 # properties. The tags identify valid sources or targets for network
5075 # firewalls. The setTags method can modify this list of tags. Each tag within
5076 # the list must comply with RFC1035.
5077 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
5078 # the tags&#x27; contents and used for optimistic locking. The
5079 # fingerprint is initially generated by Compute Engine and changes after
5080 # every request to modify or update tags. You must always provide an
5081 # up-to-date fingerprint hash in order to update or change tags.
5082 #
5083 # To see the latest fingerprint, make get() request to the
5084 # instance.
5085 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
5086 # with RFC1035.
5087 &quot;A String&quot;,
5088 ],
5089 },
5090 &quot;workloadIdentityConfig&quot;: {
5091 &quot;identity&quot;: &quot;A String&quot;,
5092 &quot;identityCertificateEnabled&quot;: True or False,
5093 },
5094 },
5095 &quot;locationPolicy&quot;: { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
5096 # bulk.
5097 # (e.g. preferences for zone selection among zones in a single region).
5098 &quot;locations&quot;: { # Location configurations mapped by location name.
5099 # Currently only zone names are supported and must be represented as valid
5100 # internal URLs, such as zones/us-central1-a.
5101 # The bulkInsert operation doesn&#x27;t create instances in an AI zone, even if
5102 # an AI zone is available in the specified region. For example, if you set a
5103 # DENY preference for us-central1-a, Compute Engine will consider
5104 # us-central1-b and us-central1-c for instance creation, but not
5105 # us-central1-ai1a. Also, you can&#x27;t use the locations[] configuration to
5106 # allow instance creation in an AI zone. To include an AI zone in bulkInsert
5107 # operations, use the locationPolicy.zones[] field.
5108 &quot;a_key&quot;: {
5109 &quot;constraints&quot;: { # Per-zone constraints on location policy for this zone. # Constraints that the caller requires on the result distribution
5110 # in this zone.
5111 &quot;maxCount&quot;: 42, # Maximum number of items that are allowed to be placed in this zone.
5112 # The value must be non-negative.
5113 },
5114 &quot;preference&quot;: &quot;A String&quot;, # Preference for a given location. Set to either ALLOW orDENY.
5115 },
5116 },
5117 &quot;targetShape&quot;: &quot;A String&quot;, # Strategy for distributing VMs across zones in a region.
5118 &quot;zones&quot;: [ # The bulkInsert operation applies any preferences set in the locations
5119 # field to the specific zones listed in the zones field if the same zones
5120 # are specified in both fields.
5121 {
5122 &quot;zone&quot;: &quot;A String&quot;, # The URL of the zone.
5123 # The zone must exist in the region where the request is called.
5124 # Zones must be represented as valid partial URLs,
5125 # such as zones/us-central1-a.
5126 },
5127 ],
5128 },
5129 &quot;minCount&quot;: &quot;A String&quot;, # The minimum number of instances to create. If no min_count is
5130 # specified then count is used as the default value. Ifmin_count instances cannot be created, then no instances will
5131 # be created and instances already created will be deleted.
5132 &quot;namePattern&quot;: &quot;A String&quot;, # The string pattern used for the names of the VMs.
5133 # Either name_pattern or per_instance_properties
5134 # must be set. The pattern must contain one continuous sequence of
5135 # placeholder hash characters (#) with each character corresponding to one
5136 # digit of the generated instance name. Example: a name_pattern
5137 # of inst-#### generates instance names such asinst-0001 and inst-0002. If existing instances
5138 # in the same project and zone have names that match the name pattern
5139 # then the generated instance numbers start after the biggest
5140 # existing number. For example, if there exists an instance with nameinst-0050, then instance names generated using the patterninst-#### begin with inst-0051. The name pattern
5141 # placeholder #...# can contain up to 18 characters.
5142 &quot;perInstanceProperties&quot;: { # Per-instance properties to be set on individual instances.
5143 # Keys of this map specify requested instance names.
5144 # Can be empty if name_pattern is used.
5145 &quot;a_key&quot;: { # Per-instance properties to be set on individual instances.
5146 # To be extended in the future.
5147 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. More details in:
5148 # https://cloud.google.com/compute/docs/instances/custom-hostname-vm#naming_convention
5149 &quot;name&quot;: &quot;A String&quot;, # Output only. This field is only temporary. It will be removed. Do not use it.
5150 },
5151 },
5152 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template from which to create instances. You may
5153 # combine sourceInstanceTemplate withinstanceProperties to override specific values from an
5154 # existing instance template. Bulk API follows the semantics of JSON Merge
5155 # Patch described by RFC
5156 # 7396.
5157 #
5158 # It can be a full or partial URL. For example, the following are
5159 # all valid URLs to an instance template:
5160 #
5161 #
5162 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
5163 # - projects/project/global/instanceTemplates/instanceTemplate
5164 # - global/instanceTemplates/instanceTemplate
5165 #
5166 #
5167 #
5168 # This field is optional.
5169 }
5170
5171 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5172 that if you must retry your request, the server will know to ignore the
5173 request if it has already been completed.
5174
5175 For example, consider a situation where you make an initial request and
5176 the request times out. If you make the request again with the same
5177 request ID, the server can check if original operation with the same
5178 request ID was received, and if so, will ignore the second request. This
5179 prevents clients from accidentally creating duplicate commitments.
5180
5181 The request ID must be
5182 a valid UUID with the exception that zero UUID is not supported
5183 (00000000-0000-0000-0000-000000000000).
5184 x__xgafv: string, V1 error format.
5185 Allowed values
5186 1 - v1 error format
5187 2 - v2 error format
5188
5189 Returns:
5190 An object of the form:
5191
5192 { # Represents an Operation resource.
5193 #
5194 # Google Compute Engine has three Operation resources:
5195 #
5196 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
5197 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
5198 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
5199 #
5200 # You can use an operation resource to manage asynchronous API requests.
5201 # For more information, readHandling
5202 # API responses.
5203 #
5204 # Operations can be global, regional or zonal.
5205 #
5206 # - For global operations, use the `globalOperations`
5207 # resource.
5208 # - For regional operations, use the
5209 # `regionOperations` resource.
5210 # - For zonal operations, use
5211 # the `zoneOperations` resource.
5212 #
5213 #
5214 #
5215 # For more information, read
5216 # Global, Regional, and Zonal Resources.
5217 #
5218 # Note that completed Operation resources have a limited
5219 # retention period.
5220 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5221 # Not present otherwise.
5222 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5223 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5224 # set when the operation is created.
5225 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5226 # text format.
5227 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5228 # this field will be populated.
5229 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5230 # operation.
5231 {
5232 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5233 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5234 # details. There is a set of defined message types to use for providing
5235 # details.The syntax depends on the error code. For example,
5236 # QuotaExceededInfo will have details when the error code is
5237 # QUOTA_EXCEEDED.
5238 {
5239 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5240 #
5241 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5242 # is not enabled:
5243 #
5244 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5245 # &quot;domain&quot;: &quot;googleapis.com&quot;
5246 # &quot;metadata&quot;: {
5247 # &quot;resource&quot;: &quot;projects/123&quot;,
5248 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5249 # }
5250 # }
5251 #
5252 # This response indicates that the pubsub.googleapis.com API is not enabled.
5253 #
5254 # Example of an error that is returned when attempting to create a Spanner
5255 # instance in a region that is out of stock:
5256 #
5257 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5258 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5259 # &quot;metadata&quot;: {
5260 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5261 # }
5262 # }
5263 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5264 # is typically the registered service name of the tool or product that
5265 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5266 # generated by some common infrastructure, the error domain must be a
5267 # globally unique value that identifies the infrastructure. For Google API
5268 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5269 &quot;metadatas&quot;: { # Additional structured details about this error.
5270 #
5271 # Keys must match a regular expression of `a-z+` but should
5272 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5273 # length. When identifying the current value of an exceeded limit, the units
5274 # should be contained in the key, not the value. For example, rather than
5275 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5276 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5277 # instances that can be created in a single (batch) request.
5278 &quot;a_key&quot;: &quot;A String&quot;,
5279 },
5280 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5281 # proximate cause of the error. Error reasons are unique within a particular
5282 # domain of errors. This should be at most 63 characters and match a
5283 # regular expression of `A-Z+[A-Z0-9]`, which represents
5284 # UPPER_SNAKE_CASE.
5285 },
5286 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5287 #
5288 # For example, if a quota check failed with an error indicating the calling
5289 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5290 # directly to the right place in the developer console to flip the bit.
5291 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5292 { # Describes a URL link.
5293 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5294 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5295 },
5296 ],
5297 },
5298 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5299 # which can be attached to an RPC error.
5300 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5301 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5302 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5303 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5304 },
5305 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5306 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5307 &quot;a_key&quot;: &quot;A String&quot;,
5308 },
5309 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5310 # type or metric.
5311 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5312 # or metric.
5313 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5314 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5315 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5316 },
5317 },
5318 ],
5319 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5320 # This property is optional.
5321 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5322 },
5323 ],
5324 },
5325 &quot;getVersionOperationMetadata&quot;: {
5326 &quot;inlineSbomInfo&quot;: {
5327 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5328 # appropriate identifiers.
5329 &quot;a_key&quot;: &quot;A String&quot;,
5330 },
5331 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5332 # identifiers.
5333 &quot;a_key&quot;: &quot;A String&quot;,
5334 },
5335 },
5336 },
5337 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5338 # message that was returned, such as `NOT FOUND`.
5339 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5340 # status code that was returned. For example, a `404` means the
5341 # resource was not found.
5342 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5343 # defined by the server.
5344 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5345 # This value is inRFC3339
5346 # text format.
5347 &quot;instancesBulkInsertOperationMetadata&quot;: {
5348 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5349 # Example key: zones/us-central1-a
5350 &quot;a_key&quot;: {
5351 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5352 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5353 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5354 # error.
5355 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5356 # if the flow is rolling forward or rolling back.
5357 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5358 },
5359 },
5360 },
5361 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5362 # Operation resources.
5363 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5364 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5365 # group of operations results from a `bulkInsert` API request.
5366 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5367 # `update`, or `delete`, and so on.
5368 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5369 # There is no requirement that this be linear or support any granularity of
5370 # operations. This should not be used to guess when the operation will be
5371 # complete. This number should monotonically increase as the operation
5372 # progresses.
5373 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5374 # applicable when performing regional operations.
5375 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5376 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5377 # this field will contain information on all underlying zonal actions and
5378 # their state.
5379 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5380 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5381 # Example key: zones/us-central1-a
5382 &quot;a_key&quot;: {
5383 &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
5384 # populated.
5385 # different programming environments, including REST APIs and RPC APIs. It is
5386 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5387 # three pieces of data: error code, error message, and error details.
5388 #
5389 # You can find out more about this error model and how to work with it in the
5390 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5391 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5392 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5393 # message types for APIs to use.
5394 {
5395 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5396 },
5397 ],
5398 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5399 # user-facing error message should be localized and sent in the
5400 # google.rpc.Status.details field, or localized by the client.
5401 },
5402 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5403 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5404 },
5405 },
5406 },
5407 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5408 # This value is inRFC3339
5409 # text format.
5410 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5411 # following:
5412 # `PENDING`, `RUNNING`, or `DONE`.
5413 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5414 # operation.
5415 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5416 # of the target resource.
5417 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5418 # operations related to creating a snapshot, this points to the disk
5419 # that the snapshot was created from.
5420 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5421 # `[email protected]` or
5422 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5423 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5424 # operation, this field will be populated.
5425 {
5426 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5427 # Engine returns NO_RESULTS_ON_PAGE if there
5428 # are no results in the response.
5429 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5430 # value format. For example:
5431 #
5432 # &quot;data&quot;: [
5433 # {
5434 # &quot;key&quot;: &quot;scope&quot;,
5435 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5436 # }
5437 {
5438 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5439 # returned. For example, for warnings where there are no results in a list
5440 # request for a particular zone, this key might be scope and
5441 # the key value might be the zone name. Other examples might be a key
5442 # indicating a deprecated resource and a suggested replacement, or a
5443 # warning about invalid network settings (for example, if an instance
5444 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5445 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5446 },
5447 ],
5448 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5449 },
5450 ],
5451 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5452 # applicable when performing per-zone operations.
5453 }</pre>
5454 </div>
5455
5456 <div class="method">
5457 <code class="details" id="close">close()</code>
5458 <pre>Close httplib2 connections.</pre>
5459 </div>
5460
5461 <div class="method">
5462 <code class="details" id="delete">delete(project, zone, instance, noGracefulShutdown=None, requestId=None, x__xgafv=None)</code>
5463 <pre>Deletes the specified Instance resource. For more information, seeDeleting
5464 an instance.
5465
5466 Args:
5467 project: string, Project ID for this request. (required)
5468 zone: string, The name of the zone for this request. (required)
5469 instance: string, Name of the instance resource to delete. (required)
5470 noGracefulShutdown: boolean, If set to true, Graceful Shutdown is skipped.
5471 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5472 that if you must retry your request, the server will know to ignore the
5473 request if it has already been completed.
5474
5475 For example, consider a situation where you make an initial request and
5476 the request times out. If you make the request again with the same
5477 request ID, the server can check if original operation with the same
5478 request ID was received, and if so, will ignore the second request. This
5479 prevents clients from accidentally creating duplicate commitments.
5480
5481 The request ID must be
5482 a valid UUID with the exception that zero UUID is not supported
5483 (00000000-0000-0000-0000-000000000000).
5484 x__xgafv: string, V1 error format.
5485 Allowed values
5486 1 - v1 error format
5487 2 - v2 error format
5488
5489 Returns:
5490 An object of the form:
5491
5492 { # Represents an Operation resource.
5493 #
5494 # Google Compute Engine has three Operation resources:
5495 #
5496 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
5497 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
5498 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
5499 #
5500 # You can use an operation resource to manage asynchronous API requests.
5501 # For more information, readHandling
5502 # API responses.
5503 #
5504 # Operations can be global, regional or zonal.
5505 #
5506 # - For global operations, use the `globalOperations`
5507 # resource.
5508 # - For regional operations, use the
5509 # `regionOperations` resource.
5510 # - For zonal operations, use
5511 # the `zoneOperations` resource.
5512 #
5513 #
5514 #
5515 # For more information, read
5516 # Global, Regional, and Zonal Resources.
5517 #
5518 # Note that completed Operation resources have a limited
5519 # retention period.
5520 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5521 # Not present otherwise.
5522 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5523 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5524 # set when the operation is created.
5525 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5526 # text format.
5527 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5528 # this field will be populated.
5529 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5530 # operation.
5531 {
5532 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5533 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5534 # details. There is a set of defined message types to use for providing
5535 # details.The syntax depends on the error code. For example,
5536 # QuotaExceededInfo will have details when the error code is
5537 # QUOTA_EXCEEDED.
5538 {
5539 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5540 #
5541 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5542 # is not enabled:
5543 #
5544 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5545 # &quot;domain&quot;: &quot;googleapis.com&quot;
5546 # &quot;metadata&quot;: {
5547 # &quot;resource&quot;: &quot;projects/123&quot;,
5548 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5549 # }
5550 # }
5551 #
5552 # This response indicates that the pubsub.googleapis.com API is not enabled.
5553 #
5554 # Example of an error that is returned when attempting to create a Spanner
5555 # instance in a region that is out of stock:
5556 #
5557 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5558 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5559 # &quot;metadata&quot;: {
5560 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5561 # }
5562 # }
5563 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5564 # is typically the registered service name of the tool or product that
5565 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5566 # generated by some common infrastructure, the error domain must be a
5567 # globally unique value that identifies the infrastructure. For Google API
5568 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5569 &quot;metadatas&quot;: { # Additional structured details about this error.
5570 #
5571 # Keys must match a regular expression of `a-z+` but should
5572 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5573 # length. When identifying the current value of an exceeded limit, the units
5574 # should be contained in the key, not the value. For example, rather than
5575 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5576 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5577 # instances that can be created in a single (batch) request.
5578 &quot;a_key&quot;: &quot;A String&quot;,
5579 },
5580 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5581 # proximate cause of the error. Error reasons are unique within a particular
5582 # domain of errors. This should be at most 63 characters and match a
5583 # regular expression of `A-Z+[A-Z0-9]`, which represents
5584 # UPPER_SNAKE_CASE.
5585 },
5586 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5587 #
5588 # For example, if a quota check failed with an error indicating the calling
5589 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5590 # directly to the right place in the developer console to flip the bit.
5591 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5592 { # Describes a URL link.
5593 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5594 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5595 },
5596 ],
5597 },
5598 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5599 # which can be attached to an RPC error.
5600 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5601 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5602 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5603 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5604 },
5605 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5606 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5607 &quot;a_key&quot;: &quot;A String&quot;,
5608 },
5609 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5610 # type or metric.
5611 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5612 # or metric.
5613 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5614 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5615 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5616 },
5617 },
5618 ],
5619 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5620 # This property is optional.
5621 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5622 },
5623 ],
5624 },
5625 &quot;getVersionOperationMetadata&quot;: {
5626 &quot;inlineSbomInfo&quot;: {
5627 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5628 # appropriate identifiers.
5629 &quot;a_key&quot;: &quot;A String&quot;,
5630 },
5631 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5632 # identifiers.
5633 &quot;a_key&quot;: &quot;A String&quot;,
5634 },
5635 },
5636 },
5637 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5638 # message that was returned, such as `NOT FOUND`.
5639 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5640 # status code that was returned. For example, a `404` means the
5641 # resource was not found.
5642 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5643 # defined by the server.
5644 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5645 # This value is inRFC3339
5646 # text format.
5647 &quot;instancesBulkInsertOperationMetadata&quot;: {
5648 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5649 # Example key: zones/us-central1-a
5650 &quot;a_key&quot;: {
5651 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5652 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5653 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5654 # error.
5655 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5656 # if the flow is rolling forward or rolling back.
5657 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5658 },
5659 },
5660 },
5661 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5662 # Operation resources.
5663 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5664 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5665 # group of operations results from a `bulkInsert` API request.
5666 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5667 # `update`, or `delete`, and so on.
5668 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5669 # There is no requirement that this be linear or support any granularity of
5670 # operations. This should not be used to guess when the operation will be
5671 # complete. This number should monotonically increase as the operation
5672 # progresses.
5673 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5674 # applicable when performing regional operations.
5675 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5676 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5677 # this field will contain information on all underlying zonal actions and
5678 # their state.
5679 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5680 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5681 # Example key: zones/us-central1-a
5682 &quot;a_key&quot;: {
5683 &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
5684 # populated.
5685 # different programming environments, including REST APIs and RPC APIs. It is
5686 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5687 # three pieces of data: error code, error message, and error details.
5688 #
5689 # You can find out more about this error model and how to work with it in the
5690 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5691 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5692 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5693 # message types for APIs to use.
5694 {
5695 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5696 },
5697 ],
5698 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5699 # user-facing error message should be localized and sent in the
5700 # google.rpc.Status.details field, or localized by the client.
5701 },
5702 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5703 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5704 },
5705 },
5706 },
5707 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5708 # This value is inRFC3339
5709 # text format.
5710 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5711 # following:
5712 # `PENDING`, `RUNNING`, or `DONE`.
5713 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5714 # operation.
5715 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5716 # of the target resource.
5717 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5718 # operations related to creating a snapshot, this points to the disk
5719 # that the snapshot was created from.
5720 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5721 # `[email protected]` or
5722 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5723 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5724 # operation, this field will be populated.
5725 {
5726 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5727 # Engine returns NO_RESULTS_ON_PAGE if there
5728 # are no results in the response.
5729 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5730 # value format. For example:
5731 #
5732 # &quot;data&quot;: [
5733 # {
5734 # &quot;key&quot;: &quot;scope&quot;,
5735 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5736 # }
5737 {
5738 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5739 # returned. For example, for warnings where there are no results in a list
5740 # request for a particular zone, this key might be scope and
5741 # the key value might be the zone name. Other examples might be a key
5742 # indicating a deprecated resource and a suggested replacement, or a
5743 # warning about invalid network settings (for example, if an instance
5744 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5745 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5746 },
5747 ],
5748 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5749 },
5750 ],
5751 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5752 # applicable when performing per-zone operations.
5753 }</pre>
5754 </div>
5755
5756 <div class="method">
5757 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</code>
5758 <pre>Deletes an access config from an instance&#x27;s network interface.
5759
5760 Args:
5761 project: string, Project ID for this request. (required)
5762 zone: string, The name of the zone for this request. (required)
5763 instance: string, The instance name for this request. (required)
5764 accessConfig: string, The name of the access config to delete. (required)
5765 networkInterface: string, The name of the network interface. (required)
5766 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5767 that if you must retry your request, the server will know to ignore the
5768 request if it has already been completed.
5769
5770 For example, consider a situation where you make an initial request and
5771 the request times out. If you make the request again with the same
5772 request ID, the server can check if original operation with the same
5773 request ID was received, and if so, will ignore the second request. This
5774 prevents clients from accidentally creating duplicate commitments.
5775
5776 The request ID must be
5777 a valid UUID with the exception that zero UUID is not supported
5778 (00000000-0000-0000-0000-000000000000).
5779 x__xgafv: string, V1 error format.
5780 Allowed values
5781 1 - v1 error format
5782 2 - v2 error format
5783
5784 Returns:
5785 An object of the form:
5786
5787 { # Represents an Operation resource.
5788 #
5789 # Google Compute Engine has three Operation resources:
5790 #
5791 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
5792 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
5793 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
5794 #
5795 # You can use an operation resource to manage asynchronous API requests.
5796 # For more information, readHandling
5797 # API responses.
5798 #
5799 # Operations can be global, regional or zonal.
5800 #
5801 # - For global operations, use the `globalOperations`
5802 # resource.
5803 # - For regional operations, use the
5804 # `regionOperations` resource.
5805 # - For zonal operations, use
5806 # the `zoneOperations` resource.
5807 #
5808 #
5809 #
5810 # For more information, read
5811 # Global, Regional, and Zonal Resources.
5812 #
5813 # Note that completed Operation resources have a limited
5814 # retention period.
5815 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5816 # Not present otherwise.
5817 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5818 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5819 # set when the operation is created.
5820 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5821 # text format.
5822 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5823 # this field will be populated.
5824 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5825 # operation.
5826 {
5827 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5828 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5829 # details. There is a set of defined message types to use for providing
5830 # details.The syntax depends on the error code. For example,
5831 # QuotaExceededInfo will have details when the error code is
5832 # QUOTA_EXCEEDED.
5833 {
5834 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5835 #
5836 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5837 # is not enabled:
5838 #
5839 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5840 # &quot;domain&quot;: &quot;googleapis.com&quot;
5841 # &quot;metadata&quot;: {
5842 # &quot;resource&quot;: &quot;projects/123&quot;,
5843 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5844 # }
5845 # }
5846 #
5847 # This response indicates that the pubsub.googleapis.com API is not enabled.
5848 #
5849 # Example of an error that is returned when attempting to create a Spanner
5850 # instance in a region that is out of stock:
5851 #
5852 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5853 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5854 # &quot;metadata&quot;: {
5855 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5856 # }
5857 # }
5858 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5859 # is typically the registered service name of the tool or product that
5860 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5861 # generated by some common infrastructure, the error domain must be a
5862 # globally unique value that identifies the infrastructure. For Google API
5863 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5864 &quot;metadatas&quot;: { # Additional structured details about this error.
5865 #
5866 # Keys must match a regular expression of `a-z+` but should
5867 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5868 # length. When identifying the current value of an exceeded limit, the units
5869 # should be contained in the key, not the value. For example, rather than
5870 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5871 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5872 # instances that can be created in a single (batch) request.
5873 &quot;a_key&quot;: &quot;A String&quot;,
5874 },
5875 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5876 # proximate cause of the error. Error reasons are unique within a particular
5877 # domain of errors. This should be at most 63 characters and match a
5878 # regular expression of `A-Z+[A-Z0-9]`, which represents
5879 # UPPER_SNAKE_CASE.
5880 },
5881 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5882 #
5883 # For example, if a quota check failed with an error indicating the calling
5884 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5885 # directly to the right place in the developer console to flip the bit.
5886 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5887 { # Describes a URL link.
5888 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5889 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5890 },
5891 ],
5892 },
5893 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5894 # which can be attached to an RPC error.
5895 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5896 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5897 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5898 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5899 },
5900 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5901 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5902 &quot;a_key&quot;: &quot;A String&quot;,
5903 },
5904 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5905 # type or metric.
5906 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5907 # or metric.
5908 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5909 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5910 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5911 },
5912 },
5913 ],
5914 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5915 # This property is optional.
5916 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5917 },
5918 ],
5919 },
5920 &quot;getVersionOperationMetadata&quot;: {
5921 &quot;inlineSbomInfo&quot;: {
5922 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5923 # appropriate identifiers.
5924 &quot;a_key&quot;: &quot;A String&quot;,
5925 },
5926 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5927 # identifiers.
5928 &quot;a_key&quot;: &quot;A String&quot;,
5929 },
5930 },
5931 },
5932 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5933 # message that was returned, such as `NOT FOUND`.
5934 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5935 # status code that was returned. For example, a `404` means the
5936 # resource was not found.
5937 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5938 # defined by the server.
5939 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5940 # This value is inRFC3339
5941 # text format.
5942 &quot;instancesBulkInsertOperationMetadata&quot;: {
5943 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5944 # Example key: zones/us-central1-a
5945 &quot;a_key&quot;: {
5946 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5947 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5948 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5949 # error.
5950 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5951 # if the flow is rolling forward or rolling back.
5952 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5953 },
5954 },
5955 },
5956 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5957 # Operation resources.
5958 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5959 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5960 # group of operations results from a `bulkInsert` API request.
5961 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5962 # `update`, or `delete`, and so on.
5963 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5964 # There is no requirement that this be linear or support any granularity of
5965 # operations. This should not be used to guess when the operation will be
5966 # complete. This number should monotonically increase as the operation
5967 # progresses.
5968 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5969 # applicable when performing regional operations.
5970 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5971 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5972 # this field will contain information on all underlying zonal actions and
5973 # their state.
5974 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5975 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5976 # Example key: zones/us-central1-a
5977 &quot;a_key&quot;: {
5978 &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
5979 # populated.
5980 # different programming environments, including REST APIs and RPC APIs. It is
5981 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5982 # three pieces of data: error code, error message, and error details.
5983 #
5984 # You can find out more about this error model and how to work with it in the
5985 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5986 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5987 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5988 # message types for APIs to use.
5989 {
5990 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5991 },
5992 ],
5993 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5994 # user-facing error message should be localized and sent in the
5995 # google.rpc.Status.details field, or localized by the client.
5996 },
5997 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5998 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5999 },
6000 },
6001 },
6002 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6003 # This value is inRFC3339
6004 # text format.
6005 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6006 # following:
6007 # `PENDING`, `RUNNING`, or `DONE`.
6008 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6009 # operation.
6010 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6011 # of the target resource.
6012 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6013 # operations related to creating a snapshot, this points to the disk
6014 # that the snapshot was created from.
6015 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6016 # `[email protected]` or
6017 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6018 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6019 # operation, this field will be populated.
6020 {
6021 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6022 # Engine returns NO_RESULTS_ON_PAGE if there
6023 # are no results in the response.
6024 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6025 # value format. For example:
6026 #
6027 # &quot;data&quot;: [
6028 # {
6029 # &quot;key&quot;: &quot;scope&quot;,
6030 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6031 # }
6032 {
6033 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6034 # returned. For example, for warnings where there are no results in a list
6035 # request for a particular zone, this key might be scope and
6036 # the key value might be the zone name. Other examples might be a key
6037 # indicating a deprecated resource and a suggested replacement, or a
6038 # warning about invalid network settings (for example, if an instance
6039 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6040 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6041 },
6042 ],
6043 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6044 },
6045 ],
6046 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6047 # applicable when performing per-zone operations.
6048 }</pre>
6049 </div>
6050
6051 <div class="method">
6052 <code class="details" id="deleteNetworkInterface">deleteNetworkInterface(project, zone, instance, networkInterfaceName, requestId=None, x__xgafv=None)</code>
6053 <pre>Deletes one dynamic network interface from an active instance.
6054 InstancesDeleteNetworkInterfaceRequest indicates:
6055 - instance from which to delete, using project+zone+resource_id fields;
6056 - dynamic network interface to be deleted, using network_interface_name
6057 field;
6058
6059 Args:
6060 project: string, Project ID for this request. (required)
6061 zone: string, The name of the zone for this request. (required)
6062 instance: string, The instance name for this request stored as resource_id.
6063 Name should conform to RFC1035 or be an unsigned long integer. (required)
6064 networkInterfaceName: string, The name of the dynamic network interface to be deleted from the instance. (required)
6065 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6066 that if you must retry your request, the server will know to ignore the
6067 request if it has already been completed.
6068
6069 For example, consider a situation where you make an initial request and
6070 the request times out. If you make the request again with the same
6071 request ID, the server can check if original operation with the same
6072 request ID was received, and if so, will ignore the second request. This
6073 prevents clients from accidentally creating duplicate commitments.
6074
6075 The request ID must be
6076 a valid UUID with the exception that zero UUID is not supported
6077 (00000000-0000-0000-0000-000000000000).
6078 x__xgafv: string, V1 error format.
6079 Allowed values
6080 1 - v1 error format
6081 2 - v2 error format
6082
6083 Returns:
6084 An object of the form:
6085
6086 { # Represents an Operation resource.
6087 #
6088 # Google Compute Engine has three Operation resources:
6089 #
6090 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6091 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6092 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6093 #
6094 # You can use an operation resource to manage asynchronous API requests.
6095 # For more information, readHandling
6096 # API responses.
6097 #
6098 # Operations can be global, regional or zonal.
6099 #
6100 # - For global operations, use the `globalOperations`
6101 # resource.
6102 # - For regional operations, use the
6103 # `regionOperations` resource.
6104 # - For zonal operations, use
6105 # the `zoneOperations` resource.
6106 #
6107 #
6108 #
6109 # For more information, read
6110 # Global, Regional, and Zonal Resources.
6111 #
6112 # Note that completed Operation resources have a limited
6113 # retention period.
6114 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6115 # Not present otherwise.
6116 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6117 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6118 # set when the operation is created.
6119 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6120 # text format.
6121 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6122 # this field will be populated.
6123 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6124 # operation.
6125 {
6126 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6127 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6128 # details. There is a set of defined message types to use for providing
6129 # details.The syntax depends on the error code. For example,
6130 # QuotaExceededInfo will have details when the error code is
6131 # QUOTA_EXCEEDED.
6132 {
6133 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6134 #
6135 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6136 # is not enabled:
6137 #
6138 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6139 # &quot;domain&quot;: &quot;googleapis.com&quot;
6140 # &quot;metadata&quot;: {
6141 # &quot;resource&quot;: &quot;projects/123&quot;,
6142 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6143 # }
6144 # }
6145 #
6146 # This response indicates that the pubsub.googleapis.com API is not enabled.
6147 #
6148 # Example of an error that is returned when attempting to create a Spanner
6149 # instance in a region that is out of stock:
6150 #
6151 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6152 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6153 # &quot;metadata&quot;: {
6154 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6155 # }
6156 # }
6157 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6158 # is typically the registered service name of the tool or product that
6159 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6160 # generated by some common infrastructure, the error domain must be a
6161 # globally unique value that identifies the infrastructure. For Google API
6162 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6163 &quot;metadatas&quot;: { # Additional structured details about this error.
6164 #
6165 # Keys must match a regular expression of `a-z+` but should
6166 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6167 # length. When identifying the current value of an exceeded limit, the units
6168 # should be contained in the key, not the value. For example, rather than
6169 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6170 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6171 # instances that can be created in a single (batch) request.
6172 &quot;a_key&quot;: &quot;A String&quot;,
6173 },
6174 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6175 # proximate cause of the error. Error reasons are unique within a particular
6176 # domain of errors. This should be at most 63 characters and match a
6177 # regular expression of `A-Z+[A-Z0-9]`, which represents
6178 # UPPER_SNAKE_CASE.
6179 },
6180 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6181 #
6182 # For example, if a quota check failed with an error indicating the calling
6183 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6184 # directly to the right place in the developer console to flip the bit.
6185 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6186 { # Describes a URL link.
6187 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6188 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6189 },
6190 ],
6191 },
6192 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6193 # which can be attached to an RPC error.
6194 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6195 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6196 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6197 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6198 },
6199 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6200 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6201 &quot;a_key&quot;: &quot;A String&quot;,
6202 },
6203 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6204 # type or metric.
6205 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6206 # or metric.
6207 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6208 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6209 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6210 },
6211 },
6212 ],
6213 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6214 # This property is optional.
6215 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6216 },
6217 ],
6218 },
6219 &quot;getVersionOperationMetadata&quot;: {
6220 &quot;inlineSbomInfo&quot;: {
6221 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6222 # appropriate identifiers.
6223 &quot;a_key&quot;: &quot;A String&quot;,
6224 },
6225 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6226 # identifiers.
6227 &quot;a_key&quot;: &quot;A String&quot;,
6228 },
6229 },
6230 },
6231 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6232 # message that was returned, such as `NOT FOUND`.
6233 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6234 # status code that was returned. For example, a `404` means the
6235 # resource was not found.
6236 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6237 # defined by the server.
6238 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6239 # This value is inRFC3339
6240 # text format.
6241 &quot;instancesBulkInsertOperationMetadata&quot;: {
6242 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6243 # Example key: zones/us-central1-a
6244 &quot;a_key&quot;: {
6245 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6246 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6247 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6248 # error.
6249 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6250 # if the flow is rolling forward or rolling back.
6251 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6252 },
6253 },
6254 },
6255 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6256 # Operation resources.
6257 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6258 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6259 # group of operations results from a `bulkInsert` API request.
6260 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6261 # `update`, or `delete`, and so on.
6262 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6263 # There is no requirement that this be linear or support any granularity of
6264 # operations. This should not be used to guess when the operation will be
6265 # complete. This number should monotonically increase as the operation
6266 # progresses.
6267 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6268 # applicable when performing regional operations.
6269 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6270 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6271 # this field will contain information on all underlying zonal actions and
6272 # their state.
6273 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6274 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6275 # Example key: zones/us-central1-a
6276 &quot;a_key&quot;: {
6277 &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
6278 # populated.
6279 # different programming environments, including REST APIs and RPC APIs. It is
6280 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6281 # three pieces of data: error code, error message, and error details.
6282 #
6283 # You can find out more about this error model and how to work with it in the
6284 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6285 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6286 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6287 # message types for APIs to use.
6288 {
6289 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6290 },
6291 ],
6292 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6293 # user-facing error message should be localized and sent in the
6294 # google.rpc.Status.details field, or localized by the client.
6295 },
6296 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6297 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6298 },
6299 },
6300 },
6301 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6302 # This value is inRFC3339
6303 # text format.
6304 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6305 # following:
6306 # `PENDING`, `RUNNING`, or `DONE`.
6307 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6308 # operation.
6309 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6310 # of the target resource.
6311 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6312 # operations related to creating a snapshot, this points to the disk
6313 # that the snapshot was created from.
6314 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6315 # `[email protected]` or
6316 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6317 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6318 # operation, this field will be populated.
6319 {
6320 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6321 # Engine returns NO_RESULTS_ON_PAGE if there
6322 # are no results in the response.
6323 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6324 # value format. For example:
6325 #
6326 # &quot;data&quot;: [
6327 # {
6328 # &quot;key&quot;: &quot;scope&quot;,
6329 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6330 # }
6331 {
6332 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6333 # returned. For example, for warnings where there are no results in a list
6334 # request for a particular zone, this key might be scope and
6335 # the key value might be the zone name. Other examples might be a key
6336 # indicating a deprecated resource and a suggested replacement, or a
6337 # warning about invalid network settings (for example, if an instance
6338 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6339 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6340 },
6341 ],
6342 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6343 },
6344 ],
6345 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6346 # applicable when performing per-zone operations.
6347 }</pre>
6348 </div>
6349
6350 <div class="method">
6351 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</code>
6352 <pre>Detaches a disk from an instance.
6353
6354 Args:
6355 project: string, Project ID for this request. (required)
6356 zone: string, The name of the zone for this request. (required)
6357 instance: string, Instance name for this request. (required)
6358 deviceName: string, The device name of the disk to detach. Make a get() request on
6359 the instance to view currently attached disks and device names. (required)
6360 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6361 that if you must retry your request, the server will know to ignore the
6362 request if it has already been completed.
6363
6364 For example, consider a situation where you make an initial request and
6365 the request times out. If you make the request again with the same
6366 request ID, the server can check if original operation with the same
6367 request ID was received, and if so, will ignore the second request. This
6368 prevents clients from accidentally creating duplicate commitments.
6369
6370 The request ID must be
6371 a valid UUID with the exception that zero UUID is not supported
6372 (00000000-0000-0000-0000-000000000000).
6373 x__xgafv: string, V1 error format.
6374 Allowed values
6375 1 - v1 error format
6376 2 - v2 error format
6377
6378 Returns:
6379 An object of the form:
6380
6381 { # Represents an Operation resource.
6382 #
6383 # Google Compute Engine has three Operation resources:
6384 #
6385 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6386 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6387 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6388 #
6389 # You can use an operation resource to manage asynchronous API requests.
6390 # For more information, readHandling
6391 # API responses.
6392 #
6393 # Operations can be global, regional or zonal.
6394 #
6395 # - For global operations, use the `globalOperations`
6396 # resource.
6397 # - For regional operations, use the
6398 # `regionOperations` resource.
6399 # - For zonal operations, use
6400 # the `zoneOperations` resource.
6401 #
6402 #
6403 #
6404 # For more information, read
6405 # Global, Regional, and Zonal Resources.
6406 #
6407 # Note that completed Operation resources have a limited
6408 # retention period.
6409 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6410 # Not present otherwise.
6411 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6412 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6413 # set when the operation is created.
6414 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6415 # text format.
6416 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6417 # this field will be populated.
6418 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6419 # operation.
6420 {
6421 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6422 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6423 # details. There is a set of defined message types to use for providing
6424 # details.The syntax depends on the error code. For example,
6425 # QuotaExceededInfo will have details when the error code is
6426 # QUOTA_EXCEEDED.
6427 {
6428 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6429 #
6430 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6431 # is not enabled:
6432 #
6433 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6434 # &quot;domain&quot;: &quot;googleapis.com&quot;
6435 # &quot;metadata&quot;: {
6436 # &quot;resource&quot;: &quot;projects/123&quot;,
6437 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6438 # }
6439 # }
6440 #
6441 # This response indicates that the pubsub.googleapis.com API is not enabled.
6442 #
6443 # Example of an error that is returned when attempting to create a Spanner
6444 # instance in a region that is out of stock:
6445 #
6446 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6447 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6448 # &quot;metadata&quot;: {
6449 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6450 # }
6451 # }
6452 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6453 # is typically the registered service name of the tool or product that
6454 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6455 # generated by some common infrastructure, the error domain must be a
6456 # globally unique value that identifies the infrastructure. For Google API
6457 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6458 &quot;metadatas&quot;: { # Additional structured details about this error.
6459 #
6460 # Keys must match a regular expression of `a-z+` but should
6461 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6462 # length. When identifying the current value of an exceeded limit, the units
6463 # should be contained in the key, not the value. For example, rather than
6464 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6465 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6466 # instances that can be created in a single (batch) request.
6467 &quot;a_key&quot;: &quot;A String&quot;,
6468 },
6469 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6470 # proximate cause of the error. Error reasons are unique within a particular
6471 # domain of errors. This should be at most 63 characters and match a
6472 # regular expression of `A-Z+[A-Z0-9]`, which represents
6473 # UPPER_SNAKE_CASE.
6474 },
6475 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6476 #
6477 # For example, if a quota check failed with an error indicating the calling
6478 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6479 # directly to the right place in the developer console to flip the bit.
6480 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6481 { # Describes a URL link.
6482 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6483 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6484 },
6485 ],
6486 },
6487 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6488 # which can be attached to an RPC error.
6489 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6490 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6491 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6492 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6493 },
6494 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6495 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6496 &quot;a_key&quot;: &quot;A String&quot;,
6497 },
6498 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6499 # type or metric.
6500 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6501 # or metric.
6502 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6503 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6504 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6505 },
6506 },
6507 ],
6508 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6509 # This property is optional.
6510 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6511 },
6512 ],
6513 },
6514 &quot;getVersionOperationMetadata&quot;: {
6515 &quot;inlineSbomInfo&quot;: {
6516 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6517 # appropriate identifiers.
6518 &quot;a_key&quot;: &quot;A String&quot;,
6519 },
6520 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6521 # identifiers.
6522 &quot;a_key&quot;: &quot;A String&quot;,
6523 },
6524 },
6525 },
6526 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6527 # message that was returned, such as `NOT FOUND`.
6528 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6529 # status code that was returned. For example, a `404` means the
6530 # resource was not found.
6531 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6532 # defined by the server.
6533 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6534 # This value is inRFC3339
6535 # text format.
6536 &quot;instancesBulkInsertOperationMetadata&quot;: {
6537 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6538 # Example key: zones/us-central1-a
6539 &quot;a_key&quot;: {
6540 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6541 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6542 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6543 # error.
6544 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6545 # if the flow is rolling forward or rolling back.
6546 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6547 },
6548 },
6549 },
6550 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6551 # Operation resources.
6552 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6553 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6554 # group of operations results from a `bulkInsert` API request.
6555 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6556 # `update`, or `delete`, and so on.
6557 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6558 # There is no requirement that this be linear or support any granularity of
6559 # operations. This should not be used to guess when the operation will be
6560 # complete. This number should monotonically increase as the operation
6561 # progresses.
6562 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6563 # applicable when performing regional operations.
6564 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6565 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6566 # this field will contain information on all underlying zonal actions and
6567 # their state.
6568 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6569 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6570 # Example key: zones/us-central1-a
6571 &quot;a_key&quot;: {
6572 &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
6573 # populated.
6574 # different programming environments, including REST APIs and RPC APIs. It is
6575 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6576 # three pieces of data: error code, error message, and error details.
6577 #
6578 # You can find out more about this error model and how to work with it in the
6579 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6580 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6581 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6582 # message types for APIs to use.
6583 {
6584 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6585 },
6586 ],
6587 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6588 # user-facing error message should be localized and sent in the
6589 # google.rpc.Status.details field, or localized by the client.
6590 },
6591 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6592 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6593 },
6594 },
6595 },
6596 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6597 # This value is inRFC3339
6598 # text format.
6599 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6600 # following:
6601 # `PENDING`, `RUNNING`, or `DONE`.
6602 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6603 # operation.
6604 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6605 # of the target resource.
6606 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6607 # operations related to creating a snapshot, this points to the disk
6608 # that the snapshot was created from.
6609 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6610 # `[email protected]` or
6611 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6612 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6613 # operation, this field will be populated.
6614 {
6615 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6616 # Engine returns NO_RESULTS_ON_PAGE if there
6617 # are no results in the response.
6618 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6619 # value format. For example:
6620 #
6621 # &quot;data&quot;: [
6622 # {
6623 # &quot;key&quot;: &quot;scope&quot;,
6624 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6625 # }
6626 {
6627 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6628 # returned. For example, for warnings where there are no results in a list
6629 # request for a particular zone, this key might be scope and
6630 # the key value might be the zone name. Other examples might be a key
6631 # indicating a deprecated resource and a suggested replacement, or a
6632 # warning about invalid network settings (for example, if an instance
6633 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6634 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6635 },
6636 ],
6637 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6638 },
6639 ],
6640 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6641 # applicable when performing per-zone operations.
6642 }</pre>
6643 </div>
6644
6645 <div class="method">
6646 <code class="details" id="get">get(project, zone, instance, view=None, x__xgafv=None)</code>
6647 <pre>Returns the specified Instance resource.
6648
6649 Args:
6650 project: string, Project ID for this request. (required)
6651 zone: string, The name of the zone for this request. (required)
6652 instance: string, Name of the instance resource to return. (required)
6653 view: string, View of the instance.
6654 Allowed values
6655 BASIC - Include everything except Partner Metadata.
6656 FULL - Include everything.
6657 INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
6658 x__xgafv: string, V1 error format.
6659 Allowed values
6660 1 - v1 error format
6661 2 - v2 error format
6662
6663 Returns:
6664 An object of the form:
6665
6666 { # Represents an Instance resource.
6667 #
6668 # An instance is a virtual machine that is hosted on Google Cloud Platform.
6669 # For more information, readVirtual Machine Instances.
6670 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
6671 # Options that would traditionally be configured in a BIOS belong
6672 # here. Features that require operating system support may have
6673 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
6674 # disabled).
6675 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
6676 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
6677 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
6678 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
6679 # multithreading (SMT) set this to 1. If unset, the maximum number
6680 # of threads supported per core by the underlying processor is
6681 # assumed.
6682 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
6683 # Supported modes include:
6684 # * ALL_CORE_MAX
6685 #
6686 # Using empty string or not setting this field will use the platform-specific
6687 # default turbo mode.
6688 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
6689 # the number of threads per core to compute the total number of virtual
6690 # CPUs to expose to the instance. If unset, the number of cores is
6691 # inferred from the instance&#x27;s nominal CPU count and the underlying
6692 # platform&#x27;s SMT width.
6693 },
6694 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
6695 # destination or source IPs. This is required if you plan to use this
6696 # instance to forward routes. For more information, seeEnabling IP Forwarding.
6697 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
6698 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
6699 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
6700 },
6701 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
6702 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
6703 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
6704 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6705 # create the resource.
6706 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
6707 # created before you can assign them.
6708 { # An instance-attached disk resource.
6709 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
6710 # or X86_64.
6711 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
6712 # deleted (but not when the disk is detached from the instance).
6713 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
6714 # partition of the disk for its root filesystem.
6715 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
6716 # running within the instance. This name can be used to reference the device
6717 # for mounting, resizing, and so on, from within the instance.
6718 #
6719 # If not specified, the server chooses a default device name to apply to this
6720 # disk, in the form persistent-disk-x, where x is a number
6721 # assigned by Google Compute Engine. This field is only applicable for
6722 # persistent disks.
6723 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
6724 # encryption key.
6725 #
6726 # If you are creating a new disk, this field encrypts the new disk using
6727 # an encryption key that you provide. If you are attaching an existing
6728 # disk that is already encrypted, this field decrypts the disk using
6729 # the customer-supplied encryption key.
6730 #
6731 # If you encrypt a disk using a customer-supplied key, you must provide the
6732 # same key again when you attempt to use this resource at a later time. For
6733 # example, you must provide the key when you create a snapshot or an image
6734 # from the disk or when you attach the disk to a virtual machine instance.
6735 #
6736 # If you do not provide an encryption key, then the disk will be encrypted
6737 # using an automatically generated key and you do not need to provide a key
6738 # to use the disk later.
6739 #
6740 # Note:
6741 #
6742 # Instance templates do not storecustomer-supplied
6743 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
6744 #
6745 # You cannot create VMs that have disks with customer-supplied keys using
6746 # the bulk
6747 # insert method.
6748 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6749 # For example:
6750 #
6751 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6752 # key_region/cryptoKeys/key
6753 #
6754 # The fully-qualifed key name may be returned for resource GET requests. For
6755 # example:
6756 #
6757 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6758 # key_region/cryptoKeys/key
6759 # /cryptoKeyVersions/1
6760 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
6761 # key. If absent, the Compute Engine default service account is used.
6762 # For example:
6763 #
6764 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
6765 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
6766 # encryption key, encoded in RFC
6767 # 4648 base64 to either encrypt or decrypt this resource. You can
6768 # provide either the rawKey or thersaEncryptedKey.
6769 # For example:
6770 #
6771 # &quot;rawKey&quot;:
6772 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
6773 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
6774 # customer-supplied encryption key to either encrypt or decrypt this
6775 # resource. You can provide either the rawKey or thersaEncryptedKey.
6776 # For example:
6777 #
6778 # &quot;rsaEncryptedKey&quot;:
6779 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
6780 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
6781 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
6782 #
6783 # The key must meet the following requirements before you can provide it to
6784 # Compute Engine:
6785 #
6786 # 1. The key is wrapped using a RSA public key certificate provided by
6787 # Google.
6788 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
6789 # encoding.
6790 #
6791 # Gets the RSA public key certificate provided by Google at:
6792 #
6793 #
6794 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
6795 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
6796 # 4648 base64 encoded SHA-256 hash of the customer-supplied
6797 # encryption key that protects this resource.
6798 },
6799 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
6800 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
6801 # currently attached to another instance. If you try to force attach a zonal
6802 # disk to an instance, you will receive an error.
6803 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
6804 # only for bootable images. Read
6805 # Enabling guest operating system features to see a list of available
6806 # options.
6807 { # Guest OS features.
6808 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
6809 # separate values. Set to one or more of the following values:
6810 #
6811 # - VIRTIO_SCSI_MULTIQUEUE
6812 # - WINDOWS
6813 # - MULTI_IP_SUBNET
6814 # - UEFI_COMPATIBLE
6815 # - GVNIC
6816 # - SEV_CAPABLE
6817 # - SUSPEND_RESUME_COMPATIBLE
6818 # - SEV_LIVE_MIGRATABLE_V2
6819 # - SEV_SNP_CAPABLE
6820 # - TDX_CAPABLE
6821 # - IDPF
6822 # - SNP_SVSM_CAPABLE
6823 # - CCA_CAPABLE
6824 #
6825 #
6826 # For more information, see
6827 # Enabling guest operating system features.
6828 },
6829 ],
6830 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
6831 # boot disk. If you have many disks attached to an instance, each
6832 # disk would have a unique index number.
6833 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
6834 # alongside the new instance. Use initialization parameters to create boot
6835 # disks or local SSDs attached to the new instance.
6836 #
6837 # This property is mutually exclusive with the source property;
6838 # you can only define one or the other, but not both.
6839 # alongside the new instance. Use initialization parameters to create boot
6840 # disks or local SSDs attached to the new instance.
6841 #
6842 # This field is persisted and returned for instanceTemplate and not returned
6843 # in the context of instance.
6844 #
6845 # This property is mutually exclusive with the source property;
6846 # you can only define one or the other, but not both.
6847 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
6848 # arm64 or x86_64.
6849 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
6850 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
6851 # of the instance. If a disk with the same name already exists in the given
6852 # region, the existing disk is attached to the new instance and the
6853 # new disk is not created.
6854 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
6855 # 10 GB. If you specify a sourceImage, which is required for
6856 # boot disks, the default size is the size of the sourceImage.
6857 # If you do not specify a sourceImage, the default disk size
6858 # is 500 GB.
6859 &quot;diskType&quot;: &quot;A String&quot;,
6860 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
6861 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
6862 # only for bootable images. Read
6863 # Enabling guest operating system features to see a list of available
6864 # options.
6865 #
6866 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
6867 { # Guest OS features.
6868 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
6869 # separate values. Set to one or more of the following values:
6870 #
6871 # - VIRTIO_SCSI_MULTIQUEUE
6872 # - WINDOWS
6873 # - MULTI_IP_SUBNET
6874 # - UEFI_COMPATIBLE
6875 # - GVNIC
6876 # - SEV_CAPABLE
6877 # - SUSPEND_RESUME_COMPATIBLE
6878 # - SEV_LIVE_MIGRATABLE_V2
6879 # - SEV_SNP_CAPABLE
6880 # - TDX_CAPABLE
6881 # - IDPF
6882 # - SNP_SVSM_CAPABLE
6883 # - CCA_CAPABLE
6884 #
6885 #
6886 # For more information, see
6887 # Enabling guest operating system features.
6888 },
6889 ],
6890 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
6891 # persistent disks.
6892 &quot;a_key&quot;: &quot;A String&quot;,
6893 },
6894 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
6895 &quot;A String&quot;,
6896 ],
6897 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
6898 # more than one instance.
6899 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
6900 # is to use the existing disk.
6901 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
6902 # of I/O operations per second that the disk can handle. Values must be
6903 # between 10,000 and 120,000. For more details, see theExtreme persistent
6904 # disk documentation.
6905 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
6906 # number of throughput mb per second that the disk can handle. Values must
6907 # greater than or equal to 1.
6908 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
6909 # the URLs of the zones where the disk should be replicated to.
6910 # You must provide exactly two replica zones, and one zone must be the same
6911 # as the instance zone.
6912 &quot;A String&quot;,
6913 ],
6914 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
6915 # have the same definition as resource
6916 # manager tags. Keys and values can be either in numeric format,
6917 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
6918 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
6919 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
6920 # empty.
6921 &quot;a_key&quot;: &quot;A String&quot;,
6922 },
6923 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
6924 # Specified using the full or partial URL. For instance template, specify
6925 # only the resource policy name.
6926 &quot;A String&quot;,
6927 ],
6928 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
6929 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
6930 # is required.
6931 #
6932 # To create a disk with one of the public operating system
6933 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
6934 #
6935 # projects/debian-cloud/global/images/family/debian-9
6936 #
6937 #
6938 # Alternatively, use a specific version of a public operating system image:
6939 #
6940 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
6941 #
6942 #
6943 # To create a disk with a custom image that you created, specify the
6944 # image name in the following format:
6945 #
6946 # global/images/my-custom-image
6947 #
6948 #
6949 # You can also specify a custom image by its image family, which returns
6950 # the latest version of the image in that family. Replace the image name
6951 # with family/family-name:
6952 #
6953 # global/images/family/my-image-family
6954 #
6955 #
6956 # If the source image is deleted later, this field will not be set.
6957 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
6958 # encryption key of the source image. Required if the source image is
6959 # protected by a customer-supplied encryption key.
6960 #
6961 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
6962 # encryption keys, so you cannot create disks for instances in a managed instance group if the
6963 # source images are encrypted with your own keys.
6964 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6965 # For example:
6966 #
6967 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6968 # key_region/cryptoKeys/key
6969 #
6970 # The fully-qualifed key name may be returned for resource GET requests. For
6971 # example:
6972 #
6973 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6974 # key_region/cryptoKeys/key
6975 # /cryptoKeyVersions/1
6976 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
6977 # key. If absent, the Compute Engine default service account is used.
6978 # For example:
6979 #
6980 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
6981 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
6982 # encryption key, encoded in RFC
6983 # 4648 base64 to either encrypt or decrypt this resource. You can
6984 # provide either the rawKey or thersaEncryptedKey.
6985 # For example:
6986 #
6987 # &quot;rawKey&quot;:
6988 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
6989 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
6990 # customer-supplied encryption key to either encrypt or decrypt this
6991 # resource. You can provide either the rawKey or thersaEncryptedKey.
6992 # For example:
6993 #
6994 # &quot;rsaEncryptedKey&quot;:
6995 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
6996 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
6997 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
6998 #
6999 # The key must meet the following requirements before you can provide it to
7000 # Compute Engine:
7001 #
7002 # 1. The key is wrapped using a RSA public key certificate provided by
7003 # Google.
7004 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
7005 # encoding.
7006 #
7007 # Gets the RSA public key certificate provided by Google at:
7008 #
7009 #
7010 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
7011 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
7012 # 4648 base64 encoded SHA-256 hash of the customer-supplied
7013 # encryption key that protects this resource.
7014 },
7015 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
7016 # instance boot disk, one of initializeParams.sourceSnapshot
7017 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
7018 # is required.
7019 #
7020 # To create a disk with a snapshot that you created, specify the
7021 # snapshot name in the following format:
7022 #
7023 # us-central1-a/instantSnapshots/my-backup
7024 #
7025 #
7026 # If the source instant-snapshot is deleted later, this field will not be
7027 # set.
7028 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
7029 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
7030 # is required.
7031 #
7032 # To create a disk with a snapshot that you created, specify the
7033 # snapshot name in the following format:
7034 #
7035 # global/snapshots/my-backup
7036 #
7037 #
7038 # If the source snapshot is deleted later, this field will not be set.
7039 #
7040 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
7041 # an image instead when you create VMs using
7042 # the bulk
7043 # insert method.
7044 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
7045 # encryption key of the source snapshot.
7046 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
7047 # For example:
7048 #
7049 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7050 # key_region/cryptoKeys/key
7051 #
7052 # The fully-qualifed key name may be returned for resource GET requests. For
7053 # example:
7054 #
7055 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7056 # key_region/cryptoKeys/key
7057 # /cryptoKeyVersions/1
7058 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
7059 # key. If absent, the Compute Engine default service account is used.
7060 # For example:
7061 #
7062 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
7063 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
7064 # encryption key, encoded in RFC
7065 # 4648 base64 to either encrypt or decrypt this resource. You can
7066 # provide either the rawKey or thersaEncryptedKey.
7067 # For example:
7068 #
7069 # &quot;rawKey&quot;:
7070 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
7071 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
7072 # customer-supplied encryption key to either encrypt or decrypt this
7073 # resource. You can provide either the rawKey or thersaEncryptedKey.
7074 # For example:
7075 #
7076 # &quot;rsaEncryptedKey&quot;:
7077 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
7078 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
7079 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
7080 #
7081 # The key must meet the following requirements before you can provide it to
7082 # Compute Engine:
7083 #
7084 # 1. The key is wrapped using a RSA public key certificate provided by
7085 # Google.
7086 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
7087 # encoding.
7088 #
7089 # Gets the RSA public key certificate provided by Google at:
7090 #
7091 #
7092 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
7093 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
7094 # 4648 base64 encoded SHA-256 hash of the customer-supplied
7095 # encryption key that protects this resource.
7096 },
7097 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
7098 # this as a partial or full URL to the resource. For example, the following
7099 # are valid values:
7100 #
7101 #
7102 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
7103 # - projects/project/zones/zone/storagePools/storagePool
7104 # - zones/zone/storagePools/storagePool
7105 },
7106 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
7107 # either SCSI or NVME. For most machine types, the
7108 # default is SCSI. Local SSDs can use either NVME or SCSI.
7109 # In certain configurations, persistent disks can use NVMe. For more
7110 # information, seeAbout
7111 # persistent disks.
7112 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
7113 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
7114 &quot;A String&quot;,
7115 ],
7116 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
7117 # disk is not allowed to be detached from the instance, or to be used as the
7118 # source of the snapshot creation, and the image creation. The instance with
7119 # at least one locked attached disk is not allow to be used as source of
7120 # machine image creation, instant snapshot creation, and not allowed to be
7121 # deleted with --keep-disk parameter set to true for locked disks.
7122 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
7123 # in READ_WRITE mode.
7124 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
7125 # field is set to PRESERVED if the LocalSSD data has been saved
7126 # to a persistent location by customer request. (see the
7127 # discard_local_ssd option on Stop/Suspend).
7128 # Read-only in the api.
7129 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
7130 # these are public keys which are safe to store in public
7131 &quot;dbs&quot;: [ # The Key Database (db).
7132 {
7133 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
7134 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
7135 },
7136 ],
7137 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
7138 {
7139 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
7140 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
7141 },
7142 ],
7143 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
7144 {
7145 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
7146 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
7147 },
7148 ],
7149 &quot;pk&quot;: { # The Platform Key (PK).
7150 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
7151 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
7152 },
7153 },
7154 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
7155 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
7156 # is required.
7157 #
7158 # If desired, you can also attach existing non-root persistent disks using
7159 # this property. This field is only applicable for persistent disks.
7160 #
7161 # Note that for InstanceTemplate, specify the disk name for zonal disk,
7162 # and the URL for regional disk.
7163 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
7164 },
7165 ],
7166 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
7167 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
7168 },
7169 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
7170 # machine image should erase Windows specific VSS signature.
7171 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
7172 # the instance&#x27;s contents and used for optimistic locking. The
7173 # fingerprint is initially generated by Compute Engine and changes after
7174 # every request to modify or update the instance. You must always provide an
7175 # up-to-date fingerprint hash in order to update the instance.
7176 #
7177 # To see the latest fingerprint, make get() request to the
7178 # instance.
7179 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
7180 { # A specification of the type and number of accelerator cards attached to the
7181 # instance.
7182 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
7183 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
7184 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
7185 # If you are creating an instance template, specify only the
7186 # accelerator name.
7187 # See GPUs on Compute Engine
7188 # for a full list of accelerator types.
7189 },
7190 ],
7191 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
7192 # RFC1035 compliant. If hostname is not specified, the default hostname is
7193 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
7194 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
7195 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
7196 # defined by the server.
7197 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
7198 # encryption key.
7199 #
7200 # If you are creating a new instance, this field will encrypt the local SSD
7201 # and in-memory contents of the instance during the suspend operation.
7202 #
7203 # If you do not provide an encryption key when creating the instance, then
7204 # the local SSD and in-memory contents will be encrypted using
7205 # an automatically generated key during the suspend operation.
7206 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
7207 # For example:
7208 #
7209 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7210 # key_region/cryptoKeys/key
7211 #
7212 # The fully-qualifed key name may be returned for resource GET requests. For
7213 # example:
7214 #
7215 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7216 # key_region/cryptoKeys/key
7217 # /cryptoKeyVersions/1
7218 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
7219 # key. If absent, the Compute Engine default service account is used.
7220 # For example:
7221 #
7222 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
7223 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
7224 # encryption key, encoded in RFC
7225 # 4648 base64 to either encrypt or decrypt this resource. You can
7226 # provide either the rawKey or thersaEncryptedKey.
7227 # For example:
7228 #
7229 # &quot;rawKey&quot;:
7230 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
7231 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
7232 # customer-supplied encryption key to either encrypt or decrypt this
7233 # resource. You can provide either the rawKey or thersaEncryptedKey.
7234 # For example:
7235 #
7236 # &quot;rsaEncryptedKey&quot;:
7237 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
7238 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
7239 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
7240 #
7241 # The key must meet the following requirements before you can provide it to
7242 # Compute Engine:
7243 #
7244 # 1. The key is wrapped using a RSA public key certificate provided by
7245 # Google.
7246 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
7247 # encoding.
7248 #
7249 # Gets the RSA public key certificate provided by Google at:
7250 #
7251 #
7252 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
7253 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
7254 # 4648 base64 encoded SHA-256 hash of the customer-supplied
7255 # encryption key that protects this resource.
7256 },
7257 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
7258 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
7259 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
7260 # for instances.
7261 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
7262 # the label&#x27;s contents and used for optimistic locking. The
7263 # fingerprint is initially generated by Compute Engine and changes after
7264 # every request to modify or update labels. You must always provide an
7265 # up-to-date fingerprint hash in order to update or change labels.
7266 #
7267 # To see the latest fingerprint, make get() request to the
7268 # instance.
7269 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
7270 # the setLabels method.
7271 &quot;a_key&quot;: &quot;A String&quot;,
7272 },
7273 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
7274 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
7275 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
7276 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
7277 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
7278 # when the instance is created. For example, the following is a valid partial
7279 # url to a predefined
7280 # machine type:
7281 #
7282 # zones/us-central1-f/machineTypes/n1-standard-1
7283 #
7284 #
7285 # To create acustom
7286 # machine type, provide a URL to a machine type in the following format,
7287 # where CPUS is 1 or an even number up to 32 (2,
7288 # 4, 6, ... 24, etc), and MEMORY is the total
7289 # memory for this instance. Memory must be a multiple of 256 MB and must
7290 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
7291 #
7292 # zones/zone/machineTypes/custom-CPUS-MEMORY
7293 #
7294 #
7295 # For example: zones/us-central1-f/machineTypes/custom-4-5120
7296 # For a full list of restrictions, read theSpecifications
7297 # for custom machine types.
7298 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
7299 # to this instance. This includes metadata keys that were explicitly defined
7300 # for the instance.
7301 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
7302 # the metadata&#x27;s contents and used for optimistic locking. The
7303 # fingerprint is initially generated by Compute Engine and changes after
7304 # every request to modify or update metadata. You must always provide an
7305 # up-to-date fingerprint hash in order to update or change metadata,
7306 # otherwise the request will fail with error412 conditionNotMet.
7307 #
7308 # To see the latest fingerprint, make a get() request to
7309 # retrieve the resource.
7310 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
7311 # less than 512 KB.
7312 { # Metadata
7313 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
7314 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
7315 # This is reflected as part of a URL in the metadata server. Additionally, to
7316 # avoid ambiguity, keys must not conflict with any other metadata keys
7317 # for the project.
7318 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
7319 # have meaning as interpreted by the image running in the instance. The
7320 # only restriction placed on values is that their size must be less than
7321 # or equal to 262144 bytes (256 KiB).
7322 },
7323 ],
7324 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
7325 # for metadata.
7326 },
7327 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
7328 # platform for the VM instance. Applicable values are the friendly names
7329 # of CPU platforms, such as minCpuPlatform: &quot;Intel
7330 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
7331 # Bridge&quot;.
7332 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
7333 # the resource. The resource name must be 1-63 characters long, and comply
7334 # withRFC1035.
7335 # Specifically, the name must be 1-63 characters long and match the regular
7336 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7337 # character must be a lowercase letter, and all following characters must be
7338 # a dash, lowercase letter, or digit, except the last character, which cannot
7339 # be a dash.
7340 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
7341 # interfaces are configured to interact with other network services, such as
7342 # connecting to the internet. Multiple interfaces are supported
7343 # per instance.
7344 { # A network interface resource attached to an instance.
7345 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
7346 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
7347 # no external internet access.
7348 { # An access configuration attached to an instance&#x27;s network interface.
7349 # Only one access config per instance is supported.
7350 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
7351 # The first IPv6 address of the external IPv6 range associated
7352 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
7353 # use a static external IP address, it must be unused and in the same region
7354 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
7355 # assign an external IPv6 address from the instance&#x27;s subnetwork.
7356 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
7357 # external IPv6 range.
7358 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
7359 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
7360 # (IPv4), the default and recommended name is External NAT, but
7361 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
7362 # recommend name is External IPv6.
7363 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
7364 # address associated with this instance. Specify an unused static
7365 # external IP address available to the project or leave this field undefined
7366 # to use an IP from a shared ephemeral IP address pool. If you specify a
7367 # static external IP address, it must live in the same region as the zone of
7368 # the instance.
7369 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
7370 # configuration and can only take the following values: PREMIUM,STANDARD.
7371 #
7372 # If an AccessConfig is specified without a valid external IP address, an
7373 # ephemeral IP will be created with this networkTier.
7374 #
7375 # If an AccessConfig with a valid external IP address is specified, it must
7376 # match that of the networkTier associated with the Address resource owning
7377 # that IP.
7378 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
7379 #
7380 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
7381 # first IP in associated external IPv6 range.
7382 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
7383 # config.
7384 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
7385 # external IP address of the instance to a DNS domain name.
7386 #
7387 # This field is not used in ipv6AccessConfig. A default PTR
7388 # record will be created if the VM has external IPv6 range associated.
7389 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
7390 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
7391 },
7392 ],
7393 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
7394 # You can only specify this field for network interfaces in VPC networks.
7395 { # An alias IP range attached to an instance&#x27;s network interface.
7396 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
7397 # must belong to the specified subnetwork and cannot contain IP addresses
7398 # reserved by system or used by other network interfaces. This range may be
7399 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
7400 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
7401 # alias range. If not specified, the primary range of the subnetwork is used.
7402 },
7403 ],
7404 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
7405 # You can only specify this field for network interfaces in VPC networks.
7406 { # An alias IP range attached to an instance&#x27;s network interface.
7407 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
7408 # must belong to the specified subnetwork and cannot contain IP addresses
7409 # reserved by system or used by other network interfaces. This range may be
7410 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
7411 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
7412 # alias range. If not specified, the primary range of the subnetwork is used.
7413 },
7414 ],
7415 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
7416 # with network_attachment.
7417 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
7418 # This field will be ignored when inserting an Instance or
7419 # adding a NetworkInterface. An up-to-date
7420 # fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
7421 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
7422 # or not. If enabled, also indicates the version of IGMP supported.
7423 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
7424 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
7425 # one IPv6 access config, DIRECT_IPV6, is supported. If there
7426 # is no ipv6AccessConfig specified, then this instance will
7427 # have no external IPv6 Internet access.
7428 { # An access configuration attached to an instance&#x27;s network interface.
7429 # Only one access config per instance is supported.
7430 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
7431 # The first IPv6 address of the external IPv6 range associated
7432 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
7433 # use a static external IP address, it must be unused and in the same region
7434 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
7435 # assign an external IPv6 address from the instance&#x27;s subnetwork.
7436 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
7437 # external IPv6 range.
7438 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
7439 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
7440 # (IPv4), the default and recommended name is External NAT, but
7441 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
7442 # recommend name is External IPv6.
7443 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
7444 # address associated with this instance. Specify an unused static
7445 # external IP address available to the project or leave this field undefined
7446 # to use an IP from a shared ephemeral IP address pool. If you specify a
7447 # static external IP address, it must live in the same region as the zone of
7448 # the instance.
7449 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
7450 # configuration and can only take the following values: PREMIUM,STANDARD.
7451 #
7452 # If an AccessConfig is specified without a valid external IP address, an
7453 # ephemeral IP will be created with this networkTier.
7454 #
7455 # If an AccessConfig with a valid external IP address is specified, it must
7456 # match that of the networkTier associated with the Address resource owning
7457 # that IP.
7458 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
7459 #
7460 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
7461 # first IP in associated external IPv6 range.
7462 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
7463 # config.
7464 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
7465 # external IP address of the instance to a DNS domain name.
7466 #
7467 # This field is not used in ipv6AccessConfig. A default PTR
7468 # record will be created if the VM has external IPv6 range associated.
7469 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
7470 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
7471 },
7472 ],
7473 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
7474 # accessed from the Internet. This field is always inherited from its
7475 # subnetwork.
7476 #
7477 # Valid only if stackType is IPV4_IPV6.
7478 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
7479 # use a static internal IP address, it must be unused and in the same region
7480 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
7481 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
7482 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
7483 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
7484 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
7485 # server. For a VM, the network interface uses the nicN naming
7486 # format. Where N is a value between 0 and7. The default interface value is nic0.
7487 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
7488 # instance, if neither the network nor the subnetwork is specified, the
7489 # default network global/networks/default is used. If the
7490 # selected project doesn&#x27;t have the default network, you must specify a
7491 # network or subnet. If the network is not specified but the subnetwork is
7492 # specified, the network is inferred.
7493 #
7494 # If you specify this property, you can specify the network as
7495 # a full or partial URL. For example, the following are all valid URLs:
7496 #
7497 #
7498 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
7499 # - projects/project/global/networks/network
7500 # - global/networks/default
7501 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
7502 # to in the following format:
7503 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
7504 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
7505 # interface. If not specified by the user, an unused internal IP is
7506 # assigned by the system.
7507 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
7508 # VirtioNet.
7509 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
7510 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
7511 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
7512 # if not specified by the users.
7513 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
7514 # interface. Can only be used with network_attachment. It is not possible to
7515 # use on its own however, network_attachment can be used without
7516 # service_class_id.
7517 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
7518 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
7519 #
7520 # This field can be both set at instance creation and update network
7521 # interface operations.
7522 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
7523 # resource is inlegacy
7524 # mode, do not specify this field. If the network is in auto subnet
7525 # mode, specifying the subnetwork is optional. If the network is in custom
7526 # subnet mode, specifying the subnetwork is required. If you specify this
7527 # field, you can specify the subnetwork as a full or partial URL. For
7528 # example, the following are all valid URLs:
7529 #
7530 #
7531 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
7532 # - regions/region/subnetworks/subnetwork
7533 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
7534 # from 2 to 255 inclusively.
7535 },
7536 ],
7537 &quot;networkPerformanceConfig&quot;: {
7538 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
7539 },
7540 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
7541 # as part of resource payload.
7542 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
7543 # Instances.Insert API.
7544 # as a count of seconds and fractions of seconds at nanosecond
7545 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7546 # or &quot;month&quot;. Range is approximately 10,000 years.
7547 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7548 # Durations less than one second are represented with a 0
7549 # `seconds` field and a positive `nanos` field. Must be from 0
7550 # to 999,999,999 inclusive.
7551 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7552 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7553 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7554 },
7555 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
7556 # have the same definition as resource
7557 # manager tags. Keys and values can be either in numeric format,
7558 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
7559 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
7560 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
7561 # PATCH) when empty.
7562 &quot;a_key&quot;: &quot;A String&quot;,
7563 },
7564 },
7565 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
7566 # (namespace) to entries map.
7567 &quot;a_key&quot;: {
7568 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
7569 # It accepts any value including google.protobuf.Struct.
7570 &quot;a_key&quot;: &quot;&quot;,
7571 },
7572 },
7573 },
7574 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
7575 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
7576 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
7577 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
7578 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
7579 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
7580 # Consuming reserved instances for examples.
7581 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
7582 # the name of your reservation as its value.
7583 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
7584 # either a name to a reservation in the same project or
7585 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
7586 # shared reservation in the same zone but in a different project.
7587 &quot;A String&quot;,
7588 ],
7589 },
7590 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
7591 &quot;A String&quot;,
7592 ],
7593 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
7594 # compared to the values requested by user in the corresponding input only
7595 # field.
7596 # Use this sub-message for actual values set on Instance attributes as compared
7597 # to the value requested by the user (intent) in their instance CRUD calls.
7598 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
7599 # zonal instance settings, and instance-level predefined metadata keys to
7600 # provide the overridden value for those metadata keys at the instance level.
7601 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
7602 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
7603 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
7604 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
7605 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
7606 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
7607 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
7608 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
7609 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
7610 },
7611 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
7612 # center, including the block, sub-block, and host. The field is formatted as
7613 # follows: blockId/subBlockId/hostId.
7614 &quot;physicalHostTopology&quot;: { # Represents the physical host topology of the host on which the VM is # Output only. [Output Only] A series of fields containing the global name of the Compute
7615 # Engine cluster, as well as the ID of the block, sub-block, and host on
7616 # which the running instance is located.
7617 # running.
7618 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
7619 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
7620 # example
7621 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
7622 # the location ID of the topologies.
7623 &quot;a_key&quot;: &quot;A String&quot;,
7624 },
7625 },
7626 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
7627 # located. Instances within the same block experience low network latency.
7628 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
7629 # running instance is located.
7630 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
7631 # Instances on the same host experience the lowest possible network
7632 # latency.
7633 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
7634 # located. Instances in the same sub-block experience lower network latency
7635 # than instances in the same block.
7636 },
7637 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
7638 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
7639 # instance is consuming from.
7640 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
7641 # instance is consuming from.
7642 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
7643 # this instance is consuming from.
7644 },
7645 &quot;scheduling&quot;: {
7646 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
7647 # must be a number between 1 and the number of availability domains
7648 # specified in the spread placement policy attached to the instance.
7649 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
7650 },
7651 &quot;shutdownDetails&quot;: { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state.
7652 # programmed stop scheduled.
7653 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
7654 # `stop_state=PENDING_STOP`.
7655 # as a count of seconds and fractions of seconds at nanosecond
7656 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7657 # or &quot;month&quot;. Range is approximately 10,000 years.
7658 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7659 # Durations less than one second are represented with a 0
7660 # `seconds` field and a positive `nanos` field. Must be from 0
7661 # to 999,999,999 inclusive.
7662 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7663 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7664 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7665 },
7666 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
7667 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
7668 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
7669 },
7670 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
7671 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
7672 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
7673 # This timestamp value is in RFC3339 text format.
7674 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
7675 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
7676 &quot;A String&quot;,
7677 ],
7678 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
7679 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
7680 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
7681 # This timestamp value is in RFC3339 text format.
7682 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
7683 # This timestamp value is in RFC3339 text format.
7684 },
7685 },
7686 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
7687 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
7688 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
7689 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
7690 # terminated by Compute Engine (not terminated by a user). You can only set
7691 # the automatic restart option for standard instances.Preemptible instances
7692 # cannot be automatically restarted.
7693 #
7694 # By default, this is set to true so an instance is
7695 # automatically restarted if it is terminated by Compute Engine.
7696 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
7697 # must be a number between 1 and the number of availability domains
7698 # specified in the spread placement policy attached to the instance.
7699 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
7700 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
7701 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the
7702 # graceful shutdown isn&#x27;t complete after this time, then the instance
7703 # transitions to the STOPPING state.
7704 # as a count of seconds and fractions of seconds at nanosecond
7705 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7706 # or &quot;month&quot;. Range is approximately 10,000 years.
7707 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7708 # Durations less than one second are represented with a 0
7709 # `seconds` field and a positive `nanos` field. Must be from 0
7710 # to 999,999,999 inclusive.
7711 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7712 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7713 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7714 },
7715 },
7716 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
7717 # within the range of [90, 330] with the increment of 30, if unset, the
7718 # default behavior of host error recovery will be used.
7719 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
7720 &quot;localSsdRecoveryTimeout&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
7721 # recovery of the Local Ssd state is attempted. Its value should be in
7722 # between 0 and 168 hours with hour granularity and the default value being 1
7723 # hour.
7724 # as a count of seconds and fractions of seconds at nanosecond
7725 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7726 # or &quot;month&quot;. Range is approximately 10,000 years.
7727 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7728 # Durations less than one second are represented with a 0
7729 # `seconds` field and a positive `nanos` field. Must be from 0
7730 # to 999,999,999 inclusive.
7731 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7732 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7733 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7734 },
7735 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
7736 # resources.
7737 # This field is for use by internal tools that use the public API.
7738 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
7739 # be scheduled for maintenance.
7740 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
7741 # are: `PERIODIC`.
7742 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
7743 # the instance termination action will be performed at the end of the run
7744 # duration.
7745 # as a count of seconds and fractions of seconds at nanosecond
7746 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7747 # or &quot;month&quot;. Range is approximately 10,000 years.
7748 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7749 # Durations less than one second are represented with a 0
7750 # `seconds` field and a positive `nanos` field. Must be from 0
7751 # to 999,999,999 inclusive.
7752 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7753 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7754 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7755 },
7756 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
7757 # on a sole-tenant node.
7758 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
7759 # affinity for more information.
7760 # Overrides reservationAffinity.
7761 { # Node Affinity: the configuration of desired nodes onto which this Instance
7762 # could be scheduled.
7763 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
7764 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
7765 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
7766 &quot;A String&quot;,
7767 ],
7768 },
7769 ],
7770 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
7771 # the default behavior is MIGRATE. Forpreemptible instances,
7772 # the default and only possible behavior is TERMINATE. For more
7773 # information, see
7774 # Set
7775 # VM host maintenance policy.
7776 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
7777 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
7778 # else, the Local SSD data will be preserved when the instance is stopped
7779 # at the end of the run duration/termination time.
7780 },
7781 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
7782 # instance creation or while the instance isstopped and
7783 # therefore, in a `TERMINATED` state. SeeInstance Life
7784 # Cycle for more information on the possible instance states.
7785 &quot;preemptionNoticeDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
7786 # Off signal is triggered for Spot
7787 # VMs only. If not specified, there will be no wait before the G2 Soft
7788 # Off signal is triggered.
7789 # as a count of seconds and fractions of seconds at nanosecond
7790 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7791 # or &quot;month&quot;. Range is approximately 10,000 years.
7792 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7793 # Durations less than one second are represented with a 0
7794 # `seconds` field and a positive `nanos` field. Must be from 0
7795 # to 999,999,999 inclusive.
7796 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7797 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7798 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7799 },
7800 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
7801 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
7802 # Off and ACPI G3 Mechanical
7803 # Off for Standard VMs and 30 seconds for Spot VMs.
7804 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
7805 # termination action will be performed at the termination time.
7806 },
7807 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
7808 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
7809 # this instance. Only one service account per VM instance is supported.
7810 #
7811 # Service accounts generate access tokens that can be accessed
7812 # through the metadata server and used to authenticate applications on the
7813 # instance. SeeService Accounts
7814 # for more information.
7815 { # A service account.
7816 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
7817 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
7818 &quot;A String&quot;,
7819 ],
7820 },
7821 ],
7822 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
7823 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
7824 # default.
7825 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
7826 # default.
7827 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
7828 # default.
7829 },
7830 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
7831 # Instance boot integrity is measured.
7832 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
7833 # measurements from the VM instance&#x27;s most recent boot.
7834 },
7835 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
7836 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
7837 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
7838 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
7839 },
7840 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
7841 # VM instance boot integrity is measured.
7842 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
7843 # measurements from the VM instance&#x27;s most recent boot.
7844 },
7845 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
7846 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
7847 # machine image.
7848 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
7849 # For example:
7850 #
7851 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7852 # key_region/cryptoKeys/key
7853 #
7854 # The fully-qualifed key name may be returned for resource GET requests. For
7855 # example:
7856 #
7857 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7858 # key_region/cryptoKeys/key
7859 # /cryptoKeyVersions/1
7860 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
7861 # key. If absent, the Compute Engine default service account is used.
7862 # For example:
7863 #
7864 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
7865 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
7866 # encryption key, encoded in RFC
7867 # 4648 base64 to either encrypt or decrypt this resource. You can
7868 # provide either the rawKey or thersaEncryptedKey.
7869 # For example:
7870 #
7871 # &quot;rawKey&quot;:
7872 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
7873 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
7874 # customer-supplied encryption key to either encrypt or decrypt this
7875 # resource. You can provide either the rawKey or thersaEncryptedKey.
7876 # For example:
7877 #
7878 # &quot;rsaEncryptedKey&quot;:
7879 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
7880 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
7881 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
7882 #
7883 # The key must meet the following requirements before you can provide it to
7884 # Compute Engine:
7885 #
7886 # 1. The key is wrapped using a RSA public key certificate provided by
7887 # Google.
7888 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
7889 # encoding.
7890 #
7891 # Gets the RSA public key certificate provided by Google at:
7892 #
7893 #
7894 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
7895 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
7896 # 4648 base64 encoded SHA-256 hash of the customer-supplied
7897 # encryption key that protects this resource.
7898 },
7899 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
7900 # Engine has detected suspicious activity.
7901 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
7902 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
7903 # instance, see
7904 # Instance life cycle.
7905 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
7906 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
7907 # sources or targets for network firewalls and are specified by the client
7908 # during instance creation. The tags can be later modified by the setTags
7909 # method. Each tag within the list must comply withRFC1035.
7910 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
7911 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
7912 # the tags&#x27; contents and used for optimistic locking. The
7913 # fingerprint is initially generated by Compute Engine and changes after
7914 # every request to modify or update tags. You must always provide an
7915 # up-to-date fingerprint hash in order to update or change tags.
7916 #
7917 # To see the latest fingerprint, make get() request to the
7918 # instance.
7919 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
7920 # with RFC1035.
7921 &quot;A String&quot;,
7922 ],
7923 },
7924 &quot;workloadIdentityConfig&quot;: {
7925 &quot;identity&quot;: &quot;A String&quot;,
7926 &quot;identityCertificateEnabled&quot;: True or False,
7927 },
7928 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
7929 # You must specify this field as part of the HTTP request URL. It is
7930 # not settable as a field in the request body.
7931 }</pre>
7932 </div>
7933
7934 <div class="method">
7935 <code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</code>
7936 <pre>Returns effective firewalls applied to an interface of the instance.
7937
7938 Args:
7939 project: string, Project ID for this request. (required)
7940 zone: string, The name of the zone for this request. (required)
7941 instance: string, Name of the instance scoping this request. (required)
7942 networkInterface: string, The name of the network interface to get the effective firewalls. (required)
7943 x__xgafv: string, V1 error format.
7944 Allowed values
7945 1 - v1 error format
7946 2 - v2 error format
7947
7948 Returns:
7949 An object of the form:
7950
7951 {
7952 &quot;firewallPolicys&quot;: [ # [Output Only] Effective firewalls from firewall policies.
7953 {
7954 &quot;displayName&quot;: &quot;A String&quot;, # Output only. [Output Only] Deprecated, please use short name instead. The display name
7955 # of the firewall policy.
7956 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the firewall policy.
7957 &quot;packetMirroringRules&quot;: [ # Output only. [Output Only] The packet mirroring rules that apply to the instance.
7958 { # Represents a rule that describes one or more match conditions along with
7959 # the action to be taken when traffic matches this condition (allow or deny).
7960 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
7961 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
7962 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
7963 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
7964 # and &quot;goto_next&quot;.
7965 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
7966 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
7967 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
7968 # the firewall policy rule is not enforced and traffic behaves as if it did
7969 # not exist. If this is unspecified, the firewall policy rule will be
7970 # enabled.
7971 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
7972 # enabled, logs will be exported to the configured export destination in
7973 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
7974 # cannot enable logging on &quot;goto_next&quot; rules.
7975 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
7976 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
7977 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
7978 # Exactly one field must be specified.
7979 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
7980 # Maximum number of destination address groups is 10.
7981 &quot;A String&quot;,
7982 ],
7983 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
7984 # traffic destination.
7985 # Maximum number of destination fqdn allowed is 100.
7986 &quot;A String&quot;,
7987 ],
7988 &quot;destIpRanges&quot;: [ # CIDR IP address range.
7989 # Maximum number of destination CIDR IP ranges allowed is 5000.
7990 &quot;A String&quot;,
7991 ],
7992 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
7993 #
7994 #
7995 # - UNSPECIFIED
7996 # - INTERNET
7997 # - NON_INTERNET
7998 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
7999 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
8000 #
8001 #
8002 # - UNSPECIFIED
8003 # - INTERNET
8004 # - NON_INTERNET
8005 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
8006 # of traffic. Should be specified as 2 letter country code defined as per
8007 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
8008 # Maximum number of dest region codes allowed is 5000.
8009 &quot;A String&quot;,
8010 ],
8011 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
8012 # The IPs in these lists will be matched against traffic destination.
8013 &quot;A String&quot;,
8014 ],
8015 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
8016 {
8017 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
8018 # required when creating a firewall rule. This value can either be
8019 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
8020 # protocol number.
8021 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
8022 # only applicable for UDP or TCP protocol. Each entry must be either
8023 # an integer or a range. If not specified, this rule applies to
8024 # connections through any port.
8025 #
8026 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
8027 &quot;A String&quot;,
8028 ],
8029 },
8030 ],
8031 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
8032 # Maximum number of source address groups is 10.
8033 &quot;A String&quot;,
8034 ],
8035 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
8036 # traffic source.
8037 # Maximum number of source fqdn allowed is 100.
8038 &quot;A String&quot;,
8039 ],
8040 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
8041 # Maximum number of source CIDR IP ranges allowed is 5000.
8042 &quot;A String&quot;,
8043 ],
8044 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
8045 #
8046 #
8047 # - UNSPECIFIED
8048 # - INTERNET
8049 # - INTRA_VPC
8050 # - NON_INTERNET
8051 # - VPC_NETWORKS
8052 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
8053 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
8054 #
8055 #
8056 # - UNSPECIFIED
8057 # - INTERNET
8058 # - INTRA_VPC
8059 # - NON_INTERNET
8060 # - VPC_NETWORKS
8061 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
8062 &quot;A String&quot;,
8063 ],
8064 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
8065 # of traffic. Should be specified as 2 letter country code defined as per
8066 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
8067 # Maximum number of source region codes allowed is 5000.
8068 &quot;A String&quot;,
8069 ],
8070 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
8071 # of the traffic.
8072 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
8073 # and there is no srcIpRange, this rule will be ignored.
8074 # Maximum number of source tag values allowed is 256.
8075 {
8076 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
8077 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
8078 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
8079 # or its network is deleted.
8080 },
8081 ],
8082 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
8083 # The IPs in these lists will be matched against traffic source.
8084 &quot;A String&quot;,
8085 ],
8086 },
8087 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
8088 # must be a positive value between 0 and 2147483647.
8089 # Rules are evaluated from highest to lowest priority where 0 is the
8090 # highest priority and 2147483647 is the lowest priority.
8091 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
8092 # and can be updated.
8093 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
8094 # rule.
8095 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
8096 # Example:
8097 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
8098 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
8099 # &#x27;mirror&#x27;. Cannot be specified for other actions.
8100 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
8101 # This field allows you to control which load balancers get this rule.
8102 # For example, the following are valid values:
8103 #
8104 #
8105 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
8106 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
8107 # - projects/project/global/
8108 # forwardingRules/forwardingRule
8109 # - projects/project/regions/region/forwardingRules/
8110 # forwardingRule
8111 &quot;A String&quot;,
8112 ],
8113 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
8114 # allows you to control which network&#x27;s VMs get this rule. If this field
8115 # is left blank, all VMs within the organization will receive the rule.
8116 &quot;A String&quot;,
8117 ],
8118 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
8119 # applies to. If targetSecureTag are specified, then the
8120 # firewall rule applies only to instances in the VPC network that have one
8121 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
8122 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
8123 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
8124 # to all instances on the specified network.
8125 # Maximum number of target label tags allowed is 256.
8126 {
8127 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
8128 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
8129 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
8130 # or its network is deleted.
8131 },
8132 ],
8133 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
8134 # applied with this rule.
8135 &quot;A String&quot;,
8136 ],
8137 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
8138 # Default value is INSTANCES.
8139 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
8140 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
8141 # be set for other actions.
8142 },
8143 ],
8144 &quot;priority&quot;: 42, # Output only. [Output only] Priority of firewall policy association. Not applicable for
8145 # type=HIERARCHY.
8146 &quot;rules&quot;: [ # [Output Only] The rules that apply to the instance. Only rules that
8147 # target the specific VM instance are returned if target service accounts
8148 # or target secure tags are specified in the rules.
8149 { # Represents a rule that describes one or more match conditions along with
8150 # the action to be taken when traffic matches this condition (allow or deny).
8151 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
8152 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
8153 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
8154 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
8155 # and &quot;goto_next&quot;.
8156 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
8157 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
8158 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
8159 # the firewall policy rule is not enforced and traffic behaves as if it did
8160 # not exist. If this is unspecified, the firewall policy rule will be
8161 # enabled.
8162 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
8163 # enabled, logs will be exported to the configured export destination in
8164 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
8165 # cannot enable logging on &quot;goto_next&quot; rules.
8166 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.
8167 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
8168 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
8169 # Exactly one field must be specified.
8170 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
8171 # Maximum number of destination address groups is 10.
8172 &quot;A String&quot;,
8173 ],
8174 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
8175 # traffic destination.
8176 # Maximum number of destination fqdn allowed is 100.
8177 &quot;A String&quot;,
8178 ],
8179 &quot;destIpRanges&quot;: [ # CIDR IP address range.
8180 # Maximum number of destination CIDR IP ranges allowed is 5000.
8181 &quot;A String&quot;,
8182 ],
8183 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
8184 #
8185 #
8186 # - UNSPECIFIED
8187 # - INTERNET
8188 # - NON_INTERNET
8189 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
8190 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
8191 #
8192 #
8193 # - UNSPECIFIED
8194 # - INTERNET
8195 # - NON_INTERNET
8196 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
8197 # of traffic. Should be specified as 2 letter country code defined as per
8198 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
8199 # Maximum number of dest region codes allowed is 5000.
8200 &quot;A String&quot;,
8201 ],
8202 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
8203 # The IPs in these lists will be matched against traffic destination.
8204 &quot;A String&quot;,
8205 ],
8206 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
8207 {
8208 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
8209 # required when creating a firewall rule. This value can either be
8210 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
8211 # protocol number.
8212 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
8213 # only applicable for UDP or TCP protocol. Each entry must be either
8214 # an integer or a range. If not specified, this rule applies to
8215 # connections through any port.
8216 #
8217 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
8218 &quot;A String&quot;,
8219 ],
8220 },
8221 ],
8222 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
8223 # Maximum number of source address groups is 10.
8224 &quot;A String&quot;,
8225 ],
8226 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
8227 # traffic source.
8228 # Maximum number of source fqdn allowed is 100.
8229 &quot;A String&quot;,
8230 ],
8231 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
8232 # Maximum number of source CIDR IP ranges allowed is 5000.
8233 &quot;A String&quot;,
8234 ],
8235 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
8236 #
8237 #
8238 # - UNSPECIFIED
8239 # - INTERNET
8240 # - INTRA_VPC
8241 # - NON_INTERNET
8242 # - VPC_NETWORKS
8243 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
8244 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
8245 #
8246 #
8247 # - UNSPECIFIED
8248 # - INTERNET
8249 # - INTRA_VPC
8250 # - NON_INTERNET
8251 # - VPC_NETWORKS
8252 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
8253 &quot;A String&quot;,
8254 ],
8255 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
8256 # of traffic. Should be specified as 2 letter country code defined as per
8257 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
8258 # Maximum number of source region codes allowed is 5000.
8259 &quot;A String&quot;,
8260 ],
8261 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
8262 # of the traffic.
8263 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
8264 # and there is no srcIpRange, this rule will be ignored.
8265 # Maximum number of source tag values allowed is 256.
8266 {
8267 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
8268 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
8269 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
8270 # or its network is deleted.
8271 },
8272 ],
8273 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
8274 # The IPs in these lists will be matched against traffic source.
8275 &quot;A String&quot;,
8276 ],
8277 },
8278 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
8279 # must be a positive value between 0 and 2147483647.
8280 # Rules are evaluated from highest to lowest priority where 0 is the
8281 # highest priority and 2147483647 is the lowest priority.
8282 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
8283 # and can be updated.
8284 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
8285 # rule.
8286 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
8287 # Example:
8288 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
8289 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
8290 # &#x27;mirror&#x27;. Cannot be specified for other actions.
8291 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
8292 # This field allows you to control which load balancers get this rule.
8293 # For example, the following are valid values:
8294 #
8295 #
8296 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
8297 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
8298 # - projects/project/global/
8299 # forwardingRules/forwardingRule
8300 # - projects/project/regions/region/forwardingRules/
8301 # forwardingRule
8302 &quot;A String&quot;,
8303 ],
8304 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
8305 # allows you to control which network&#x27;s VMs get this rule. If this field
8306 # is left blank, all VMs within the organization will receive the rule.
8307 &quot;A String&quot;,
8308 ],
8309 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
8310 # applies to. If targetSecureTag are specified, then the
8311 # firewall rule applies only to instances in the VPC network that have one
8312 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
8313 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
8314 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
8315 # to all instances on the specified network.
8316 # Maximum number of target label tags allowed is 256.
8317 {
8318 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
8319 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
8320 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
8321 # or its network is deleted.
8322 },
8323 ],
8324 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
8325 # applied with this rule.
8326 &quot;A String&quot;,
8327 ],
8328 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
8329 # Default value is INSTANCES.
8330 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
8331 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
8332 # be set for other actions.
8333 },
8334 ],
8335 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy.
8336 &quot;type&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of the firewall policy. Can be one of HIERARCHY,
8337 # NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.
8338 },
8339 ],
8340 &quot;firewalls&quot;: [ # Effective firewalls on the instance.
8341 { # Represents a Firewall Rule resource.
8342 #
8343 # Firewall rules allow or deny ingress traffic to, and egress traffic from your
8344 # instances. For more information, readFirewall rules.
8345 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a
8346 # protocol and port-range tuple that describes a permitted connection.
8347 {
8348 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
8349 # required when creating a firewall rule. This value can either be one of the
8350 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
8351 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
8352 # This field is only applicable for the UDP or TCP protocol.
8353 # Each entry must be either an integer or a range.
8354 # If not specified, this rule applies to connections through any port.
8355 #
8356 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
8357 # and [&quot;12345-12349&quot;].
8358 &quot;A String&quot;,
8359 ],
8360 },
8361 ],
8362 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
8363 # text format.
8364 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a
8365 # protocol and port-range tuple that describes a denied connection.
8366 {
8367 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
8368 # required when creating a firewall rule. This value can either be one of the
8369 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
8370 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
8371 # This field is only applicable for the UDP or TCP protocol.
8372 # Each entry must be either an integer or a range.
8373 # If not specified, this rule applies to connections through any port.
8374 #
8375 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
8376 # and [&quot;12345-12349&quot;].
8377 &quot;A String&quot;,
8378 ],
8379 },
8380 ],
8381 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
8382 # create the resource.
8383 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to
8384 # traffic that has destination IP address in these ranges. These ranges must
8385 # be expressed inCIDR format. Both IPv4 and IPv6 are supported.
8386 &quot;A String&quot;,
8387 ],
8388 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or
8389 # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot
8390 # specify the sourceTags fields.
8391 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the
8392 # firewall rule is not enforced and the network behaves as if it did not
8393 # exist. If this is unspecified, the firewall rule will be enabled.
8394 &quot;enableLogging&quot;: True or False, # Deprecated in favor of enable in LogConfig.
8395 # This field denotes whether to enable logging for a particular
8396 # firewall rule. If logging is enabled, logs will be exported t
8397 # Cloud Logging.
8398 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
8399 # defined by the server.
8400 &quot;kind&quot;: &quot;compute#firewall&quot;, # Output only. [Output Only] Type of the resource. Always compute#firewall
8401 # for firewall rules.
8402 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If
8403 # logging is enabled, logs will be exported to Cloud Logging.
8404 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall
8405 # rule.
8406 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if
8407 # logging is enabled for that rule. This field denotes whether to include
8408 # or exclude metadata for firewall logs.
8409 },
8410 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
8411 # The name must be 1-63 characters long, and comply withRFC1035.
8412 # Specifically, the name must be 1-63 characters long and match the regular
8413 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character
8414 # must be a lowercase letter, and all following characters (except for the
8415 # last character) must be a dash, lowercase letter, or digit. The last
8416 # character must be a lowercase letter or digit.
8417 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not
8418 # specified when creating a firewall rule, the default network
8419 # is used:
8420 #
8421 # global/networks/default
8422 #
8423 # If you choose to specify this field, you can specify the network as a full
8424 # or partial URL. For example, the following are all valid URLs:
8425 #
8426 # -
8427 # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
8428 # - projects/myproject/global/networks/my-network
8429 # - global/networks/default
8430 &quot;params&quot;: { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
8431 # as part of resource payload.
8432 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
8433 # Tag keys and values have the same definition as resource
8434 # manager tags. The field is allowed for INSERT
8435 # only. The keys/values to set on the resource should be specified in
8436 # either ID { : } or Namespaced format
8437 # { : }.
8438 # For example the following are valid inputs:
8439 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
8440 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
8441 # Note:
8442 # * Invalid combinations of ID &amp; namespaced format is not supported. For
8443 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
8444 &quot;a_key&quot;: &quot;A String&quot;,
8445 },
8446 },
8447 &quot;priority&quot;: 42, # Priority for this rule.
8448 # This is an integer between `0` and `65535`, both inclusive.
8449 # The default value is `1000`.
8450 # Relative priorities determine which rule takes effect if multiple rules
8451 # apply. Lower values indicate higher priority. For example, a rule with
8452 # priority `0` has higher precedence than a rule with priority `1`.
8453 # DENY rules take precedence over ALLOW rules if they have equal priority.
8454 # Note that VPC networks have implied
8455 # rules with a priority of `65535`. To avoid conflicts with the implied
8456 # rules, use a priority number less than `65535`.
8457 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8458 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic
8459 # that has a source IP address in these ranges. These ranges must be
8460 # expressed inCIDR format. One or both of sourceRanges
8461 # and sourceTags may be set.
8462 # If both fields are set, the rule applies to traffic that has a
8463 # source IP address within sourceRanges OR a source IP
8464 # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match
8465 # both fields for the rule to
8466 # apply. Both IPv4 and IPv6 are supported.
8467 &quot;A String&quot;,
8468 ],
8469 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to
8470 # traffic originating from an instance with a service account in this list.
8471 # Source service accounts cannot be used to control traffic to an instance&#x27;s
8472 # external IP address because service accounts are associated with an
8473 # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.
8474 # If both are set, the firewall applies to traffic that
8475 # has a source IP address within the sourceRanges OR a source
8476 # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match
8477 # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.
8478 &quot;A String&quot;,
8479 ],
8480 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic
8481 # with source IPs that match the primary network interfaces of VM instances
8482 # that have the tag and are in the same VPC network.
8483 # Source tags cannot be used to control traffic to an instance&#x27;s external IP
8484 # address, it only applies to traffic between instances in the same virtual
8485 # network. Because tags are associated with instances, not IP addresses.
8486 # One or both of sourceRanges and sourceTags may be
8487 # set. If both fields are set, the firewall applies to traffic that has a
8488 # source IP address within sourceRanges OR a source IP from a
8489 # resource with a matching tag listed in the sourceTags
8490 # field. The connection does not need to match both fields for the
8491 # firewall to apply.
8492 &quot;A String&quot;,
8493 ],
8494 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the
8495 # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.
8496 # If neither targetServiceAccounts nor targetTags
8497 # are specified, the firewall rule applies to all instances on the specified
8498 # network.
8499 &quot;A String&quot;,
8500 ],
8501 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule
8502 # applies to. If targetTags are specified, then the firewall
8503 # rule applies only to instances in the VPC network that have one of those
8504 # tags. If no targetTags are specified, the firewall rule
8505 # applies to all instances on the specified network.
8506 &quot;A String&quot;,
8507 ],
8508 },
8509 ],
8510 &quot;organizationFirewalls&quot;: [ # Effective firewalls from organization policies.
8511 { # A pruned SecurityPolicy containing ID and any applicable firewall rules.
8512 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier for the security policy. This
8513 # identifier is defined by the server.
8514 &quot;rules&quot;: [ # The rules that apply to the network.
8515 { # Represents a rule that describes one or more match conditions along with
8516 # the action to be taken when traffic matches this condition (allow or deny).
8517 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the rule is matched.
8518 # The following are the valid actions:
8519 #
8520 # - allow: allow access to target.
8521 # - deny(STATUS): deny access to target, returns the
8522 # HTTP response code specified. Valid values for `STATUS`
8523 # are 403, 404, and 502.
8524 # - rate_based_ban: limit client traffic to the configured
8525 # threshold and ban the client if the traffic exceeds the threshold.
8526 # Configure parameters for this action in RateLimitOptions. Requires
8527 # rate_limit_options to be set.
8528 # - redirect: redirect to a different target. This can
8529 # either be an internal reCAPTCHA redirect, or an external URL-based
8530 # redirect via a 302 response. Parameters for this action can be configured
8531 # via redirectOptions. This action is only supported in Global Security
8532 # Policies of type CLOUD_ARMOR.
8533 # - throttle: limit
8534 # client traffic to the configured threshold. Configure parameters for this
8535 # action in rateLimitOptions. Requires rate_limit_options to be set for
8536 # this.
8537 # - fairshare (preview only): when traffic reaches the
8538 # threshold limit, requests from the clients matching this rule begin to be
8539 # rate-limited using the Fair Share algorithm. This action is only allowed
8540 # in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
8541 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8542 # create the resource.
8543 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies. This field may only be
8544 # specified when versioned_expr is set to FIREWALL.
8545 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
8546 # enabled, logs will be exported to the configured export destination in
8547 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
8548 # cannot enable logging on &quot;goto_next&quot; rules.
8549 #
8550 # This field may only be specified when the versioned_expr is set to
8551 # FIREWALL.
8552 &quot;headerAction&quot;: { # Optional, additional actions that are performed on headers.
8553 # This field is only supported in Global Security Policies of type
8554 # CLOUD_ARMOR.
8555 &quot;requestHeadersToAdds&quot;: [ # The list of request headers to add or overwrite if they&#x27;re already
8556 # present.
8557 {
8558 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to set.
8559 &quot;headerValue&quot;: &quot;A String&quot;, # The value to set the named header to.
8560 },
8561 ],
8562 },
8563 &quot;kind&quot;: &quot;compute#securityPolicyRule&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules
8564 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
8565 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
8566 # Exactly one field must be specified.
8567 &quot;config&quot;: { # The configuration options available when specifying versioned_expr.
8568 # This field must be specified if versioned_expr is specified and cannot
8569 # be specified if versioned_expr is not specified.
8570 &quot;destIpRanges&quot;: [ # CIDR IP address range.
8571 #
8572 # This field may only be specified when versioned_expr is set to
8573 # FIREWALL.
8574 &quot;A String&quot;,
8575 ],
8576 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
8577 #
8578 # This field may only be specified when versioned_expr is set to
8579 # FIREWALL.
8580 {
8581 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
8582 # required when creating a firewall rule. This value can either be
8583 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
8584 # protocol number.
8585 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
8586 # only applicable for UDP or TCP protocol. Each entry must be either
8587 # an integer or a range. If not specified, this rule applies to
8588 # connections through any port.
8589 #
8590 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
8591 #
8592 # This field may only be specified when versioned_expr is set to
8593 # FIREWALL.
8594 &quot;A String&quot;,
8595 ],
8596 },
8597 ],
8598 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
8599 # Maximum number of src_ip_ranges allowed is 10.
8600 &quot;A String&quot;,
8601 ],
8602 },
8603 &quot;expr&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # User defined CEVAL expression.
8604 # A CEVAL expression is used to specify match criteria such as origin.ip,
8605 # source.region_code and contents in the request header.
8606 # Expressions containing `evaluateThreatIntelligence` require a Cloud
8607 # Armor Enterprise subscription and are not supported in Edge Policies
8608 # nor in Regional Policies. Expressions containing
8609 # `evaluatePreconfiguredExpr(&#x27;sourceiplist-*&#x27;)` require a Cloud Armor
8610 # Enterprise subscription and are only supported in Global Security
8611 # Policies.
8612 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8613 # are documented at https://github.com/google/cel-spec.
8614 #
8615 # Example (Comparison):
8616 #
8617 # title: &quot;Summary size limit&quot;
8618 # description: &quot;Determines if a summary is less than 100 chars&quot;
8619 # expression: &quot;document.summary.size() &lt; 100&quot;
8620 #
8621 # Example (Equality):
8622 #
8623 # title: &quot;Requestor is owner&quot;
8624 # description: &quot;Determines if requestor is the document owner&quot;
8625 # expression: &quot;document.owner == request.auth.claims.email&quot;
8626 #
8627 # Example (Logic):
8628 #
8629 # title: &quot;Public documents&quot;
8630 # description: &quot;Determine whether the document should be publicly visible&quot;
8631 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8632 #
8633 # Example (Data Manipulation):
8634 #
8635 # title: &quot;Notification string&quot;
8636 # description: &quot;Create a notification string with a timestamp.&quot;
8637 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8638 #
8639 # The exact variables and functions that may be referenced within an expression
8640 # are determined by the service that evaluates it. See the service
8641 # documentation for additional information.
8642 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8643 # describes the expression, e.g. when hovered over it in a UI.
8644 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8645 # syntax.
8646 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8647 # reporting, e.g. a file name and a position in the file.
8648 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8649 # its purpose. This can be used e.g. in UIs which allow to enter the
8650 # expression.
8651 },
8652 &quot;exprOptions&quot;: { # The configuration options available when specifying a user defined
8653 # CEVAL expression (i.e., &#x27;expr&#x27;).
8654 &quot;recaptchaOptions&quot;: { # reCAPTCHA configuration options to be applied for the rule. If the
8655 # rule does not evaluate reCAPTCHA tokens, this field has no effect.
8656 &quot;actionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
8657 # action-tokens. The provided site keys need to be created from
8658 # reCAPTCHA API under the same project where the security policy is
8659 # created.
8660 &quot;A String&quot;,
8661 ],
8662 &quot;sessionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
8663 # session-tokens. The provided site keys need to be created from
8664 # reCAPTCHA API under the same project where the security policy is
8665 # created.
8666 &quot;A String&quot;,
8667 ],
8668 },
8669 },
8670 &quot;versionedExpr&quot;: &quot;A String&quot;, # Preconfigured versioned expression.
8671 # If this field is specified, config must also be specified.
8672 # Available preconfigured expressions along with their requirements are:
8673 # SRC_IPS_V1 - must specify the corresponding src_ip_range field in
8674 # config.
8675 },
8676 &quot;networkMatch&quot;: { # Represents a match condition that incoming network traffic is evaluated # A match condition that incoming packets are evaluated against for
8677 # CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding
8678 # &#x27;action&#x27; is enforced.
8679 #
8680 # The match criteria for a rule consists of built-in match fields (like
8681 # &#x27;srcIpRanges&#x27;) and potentially multiple user-defined match fields
8682 # (&#x27;userDefinedFields&#x27;).
8683 #
8684 # Field values may be extracted directly from the packet or derived from it
8685 # (e.g. &#x27;srcRegionCodes&#x27;). Some fields may not be present in every packet
8686 # (e.g. &#x27;srcPorts&#x27;). A user-defined field is only present if the base
8687 # header is found in the packet and the entire field is in bounds.
8688 #
8689 # Each match field may specify which values can match it, listing one or
8690 # more ranges, prefixes, or exact values that are considered a match for
8691 # the field. A field value must be present in order to match a specified
8692 # match field. If no match values are specified for a match field, then any
8693 # field value is considered to match it, and it&#x27;s not required to be
8694 # present. For strings specifying &#x27;*&#x27; is also equivalent to match all.
8695 #
8696 # For a packet to match a rule, all specified match fields must match the
8697 # corresponding field values derived from the packet.
8698 #
8699 # Example:
8700 #
8701 # networkMatch:
8702 # srcIpRanges:
8703 # - &quot;192.0.2.0/24&quot;
8704 # - &quot;198.51.100.0/24&quot;
8705 # userDefinedFields:
8706 # - name: &quot;ipv4_fragment_offset&quot;
8707 # values:
8708 # - &quot;1-0x1fff&quot;
8709 #
8710 # The above match condition matches packets with a source IP in
8711 # 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named
8712 # &quot;ipv4_fragment_offset&quot; with a value between 1 and 0x1fff inclusive.
8713 # against.
8714 &quot;destIpRanges&quot;: [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text
8715 # format.
8716 &quot;A String&quot;,
8717 ],
8718 &quot;destPorts&quot;: [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
8719 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
8720 &quot;A String&quot;,
8721 ],
8722 &quot;ipProtocols&quot;: [ # IPv4 protocol / IPv6 next header (after extension headers). Each
8723 # element can be an 8-bit unsigned decimal number (e.g. &quot;6&quot;), range (e.g.
8724 # &quot;253-254&quot;), or one of the following protocol names: &quot;tcp&quot;, &quot;udp&quot;,
8725 # &quot;icmp&quot;, &quot;esp&quot;, &quot;ah&quot;, &quot;ipip&quot;, or &quot;sctp&quot;.
8726 &quot;A String&quot;,
8727 ],
8728 &quot;srcAsns&quot;: [ # BGP Autonomous System Number associated with the source IP address.
8729 42,
8730 ],
8731 &quot;srcIpRanges&quot;: [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
8732 &quot;A String&quot;,
8733 ],
8734 &quot;srcPorts&quot;: [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
8735 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
8736 &quot;A String&quot;,
8737 ],
8738 &quot;srcRegionCodes&quot;: [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source
8739 # IP address.
8740 &quot;A String&quot;,
8741 ],
8742 &quot;userDefinedFields&quot;: [ # User-defined fields. Each element names a defined field and lists the
8743 # matching values for that field.
8744 {
8745 &quot;name&quot;: &quot;A String&quot;, # Name of the user-defined field, as given in the definition.
8746 &quot;values&quot;: [ # Matching values of the field. Each element can be a 32-bit unsigned
8747 # decimal or hexadecimal (starting with &quot;0x&quot;) number (e.g. &quot;64&quot;) or
8748 # range (e.g. &quot;0x400-0x7ff&quot;).
8749 &quot;A String&quot;,
8750 ],
8751 },
8752 ],
8753 },
8754 &quot;preconfiguredWafConfig&quot;: { # Preconfigured WAF configuration to be applied for the rule. If the rule
8755 # does not evaluate preconfigured WAF rules, i.e., if
8756 # evaluatePreconfiguredWaf() is not used, this field will have no effect.
8757 &quot;exclusions&quot;: [ # A list of exclusions to apply during preconfigured WAF evaluation.
8758 {
8759 &quot;requestBodiesToExclude&quot;: [ # A list of request body fields to be excluded from inspection during
8760 # preconfigured WAF evaluation.
8761 {
8762 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
8763 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
8764 },
8765 ],
8766 &quot;requestCookiesToExclude&quot;: [ # A list of request cookie names whose value will be excluded from
8767 # inspection during preconfigured WAF evaluation.
8768 {
8769 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
8770 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
8771 },
8772 ],
8773 &quot;requestHeadersToExclude&quot;: [ # A list of request header names whose value will be excluded from
8774 # inspection during preconfigured WAF evaluation.
8775 {
8776 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
8777 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
8778 },
8779 ],
8780 &quot;requestQueryParamsToExclude&quot;: [ # A list of request query parameter names whose value will be excluded
8781 # from inspection during preconfigured WAF evaluation. Note that the
8782 # parameter can be in the query string or in the POST body.
8783 {
8784 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
8785 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
8786 },
8787 ],
8788 &quot;requestUrisToExclude&quot;: [ # A list of request URIs from the request line to be excluded from
8789 # inspection during preconfigured WAF evaluation. When specifying this
8790 # field, the query or fragment part should be excluded.
8791 {
8792 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
8793 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
8794 },
8795 ],
8796 &quot;targetRuleIds&quot;: [ # A list of target rule IDs under the WAF rule set to apply the
8797 # preconfigured WAF exclusion. If omitted, it refers to all the rule
8798 # IDs under the WAF rule set.
8799 &quot;A String&quot;,
8800 ],
8801 &quot;targetRuleSet&quot;: &quot;A String&quot;, # Target WAF rule set to apply the preconfigured WAF exclusion.
8802 },
8803 ],
8804 },
8805 &quot;preview&quot;: True or False, # If set to true, the specified action is not enforced.
8806 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
8807 # must be a positive value between 0 and 2147483647.
8808 # Rules are evaluated from highest to lowest priority where 0 is the
8809 # highest priority and 2147483647 is the lowest priority.
8810 &quot;rateLimitOptions&quot;: { # Must be specified if the action is &quot;rate_based_ban&quot; or &quot;throttle&quot; or
8811 # &quot;fairshare&quot;. Cannot be specified for any other actions.
8812 &quot;banDurationSec&quot;: 42, # Can only be specified if the action for the rule is
8813 # &quot;rate_based_ban&quot;. If specified, determines the time (in seconds)
8814 # the traffic will continue to be banned by the rate limit after the
8815 # rate falls below the threshold.
8816 &quot;banThreshold&quot;: { # Can only be specified if the action for the rule is
8817 # &quot;rate_based_ban&quot;. If specified, the key will be banned for the
8818 # configured &#x27;ban_duration_sec&#x27; when the number of requests that exceed
8819 # the &#x27;rate_limit_threshold&#x27; also exceed this &#x27;ban_threshold&#x27;.
8820 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
8821 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
8822 },
8823 &quot;conformAction&quot;: &quot;A String&quot;, # Action to take for requests that are under the configured rate limit
8824 # threshold. Valid option is &quot;allow&quot; only.
8825 &quot;enforceOnKey&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
8826 # values are:
8827 #
8828 # - ALL: A single rate limit threshold is applied to all
8829 # the requests matching this rule. This is the default value if
8830 # &quot;enforceOnKey&quot; is not configured.
8831 # - IP: The source IP address of
8832 # the request is the key. Each IP has this limit enforced
8833 # separately.
8834 # - HTTP_HEADER: The value of the HTTP
8835 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
8836 # value is truncated to the first 128 bytes of the header value. If no
8837 # such header is present in the request, the key type defaults toALL.
8838 # - XFF_IP: The first IP address (i.e. the
8839 # originating client IP address) specified in the list of IPs under
8840 # X-Forwarded-For HTTP header. If no such header is present or the value
8841 # is not a valid IP, the key defaults to the source IP address of
8842 # the request i.e. key type IP.
8843 # - HTTP_COOKIE: The value of the HTTP
8844 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
8845 # value is truncated to the first 128 bytes of the cookie value. If no
8846 # such cookie is present in the request, the key type defaults toALL.
8847 # - HTTP_PATH: The URL path of the HTTP request. The key
8848 # value is truncated to the first 128 bytes.
8849 # - SNI: Server name indication in the TLS session of the
8850 # HTTPS request. The key value is truncated to the first 128 bytes. The
8851 # key type defaults to ALL on a HTTP session.
8852 # - REGION_CODE: The country/region from which the request
8853 # originates.
8854 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
8855 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
8856 # key type defaults to ALL.
8857 # - USER_IP: The IP address of the originating client,
8858 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
8859 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration or
8860 # an IP address cannot be resolved from it, the key type defaults toIP.
8861 #
8862 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
8863 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
8864 # key type defaults to ALL.
8865 # For &quot;fairshare&quot; action, this value is limited to ALL i.e. a single rate
8866 # limit threshold is enforced for all the requests matching the rule.
8867 &quot;enforceOnKeyConfigs&quot;: [ # If specified, any combination of values of
8868 # enforce_on_key_type/enforce_on_key_name is treated as the key on which
8869 # ratelimit threshold/action is enforced. You can specify up to 3
8870 # enforce_on_key_configs. If enforce_on_key_configs is specified,
8871 # enforce_on_key must not be specified.
8872 {
8873 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
8874 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the
8875 # key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is
8876 # taken as the key value.
8877 &quot;enforceOnKeyType&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
8878 # values are:
8879 #
8880 # - ALL: A single rate limit threshold is applied to all
8881 # the requests matching this rule. This is the default value if
8882 # &quot;enforceOnKeyConfigs&quot; is not configured.
8883 # - IP: The source IP address of
8884 # the request is the key. Each IP has this limit enforced
8885 # separately.
8886 # - HTTP_HEADER: The value of the HTTP
8887 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
8888 # value is truncated to the first 128 bytes of the header value. If no
8889 # such header is present in the request, the key type defaults toALL.
8890 # - XFF_IP: The first IP address (i.e. the
8891 # originating client IP address) specified in the list of IPs under
8892 # X-Forwarded-For HTTP header. If no such header is present or the
8893 # value is not a valid IP, the key defaults to the source IP address of
8894 # the request i.e. key type IP.
8895 # - HTTP_COOKIE: The value of the HTTP
8896 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
8897 # value is truncated to the first 128 bytes of the cookie value. If no
8898 # such cookie is present in the request, the key type defaults toALL.
8899 # - HTTP_PATH: The URL path of the HTTP request. The key
8900 # value is truncated to the first 128 bytes.
8901 # - SNI: Server name indication in the TLS session of
8902 # the HTTPS request. The key value is truncated to the first 128 bytes.
8903 # The key type defaults to ALL on a HTTP session.
8904 # - REGION_CODE: The country/region from which the
8905 # request originates.
8906 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
8907 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
8908 # key type defaults to ALL.
8909 # - USER_IP: The IP address of the originating client,
8910 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
8911 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration
8912 # or an IP address cannot be resolved from it, the key type defaults toIP.
8913 #
8914 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
8915 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
8916 # key type defaults to ALL.
8917 },
8918 ],
8919 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
8920 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the key
8921 # value.
8922 # HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key
8923 # value.
8924 &quot;exceedAction&quot;: &quot;A String&quot;, # Action to take for requests that are above the configured rate limit
8925 # threshold, to either deny with a specified HTTP response code, or
8926 # redirect to a different endpoint.
8927 # Valid options are `deny(STATUS)`, where valid values for
8928 # `STATUS` are 403, 404, 429, and 502, and
8929 # `redirect`, where the redirect parameters come from
8930 # `exceedRedirectOptions` below.
8931 # The `redirect` action is only supported in Global Security Policies of
8932 # type CLOUD_ARMOR.
8933 &quot;exceedRedirectOptions&quot;: { # Parameters defining the redirect action that is used as the exceed
8934 # action. Cannot be specified if the exceed action is not redirect.
8935 # This field is only supported in Global Security Policies of type
8936 # CLOUD_ARMOR.
8937 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
8938 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
8939 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
8940 #
8941 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
8942 # challenge assessment.
8943 # - EXTERNAL_302: redirect to a different URL via a 302
8944 # response.
8945 },
8946 &quot;rateLimitThreshold&quot;: { # Threshold at which to begin ratelimiting.
8947 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
8948 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
8949 },
8950 },
8951 &quot;redirectOptions&quot;: { # Parameters defining the redirect action. Cannot be specified for any
8952 # other actions.
8953 # This field is only supported in Global Security Policies of type
8954 # CLOUD_ARMOR.
8955 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
8956 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
8957 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
8958 #
8959 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
8960 # challenge assessment.
8961 # - EXTERNAL_302: redirect to a different URL via a 302
8962 # response.
8963 },
8964 &quot;ruleNumber&quot;: &quot;A String&quot;, # Identifier for the rule. This is only unique within the given security
8965 # policy. This can only be set during rule creation, if rule number is not
8966 # specified it will be generated by the server.
8967 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall security
8968 # policy rule.
8969 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
8970 # allows you to control which network&#x27;s VMs get this rule. If this field
8971 # is left blank, all VMs within the organization will receive the rule.
8972 #
8973 # This field may only be specified when versioned_expr is set to FIREWALL.
8974 &quot;A String&quot;,
8975 ],
8976 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
8977 # applied with this rule.
8978 &quot;A String&quot;,
8979 ],
8980 },
8981 ],
8982 },
8983 ],
8984 }</pre>
8985 </div>
8986
8987 <div class="method">
8988 <code class="details" id="getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None, x__xgafv=None)</code>
8989 <pre>Returns the specified guest attributes entry.
8990
8991 Args:
8992 project: string, Project ID for this request. (required)
8993 zone: string, The name of the zone for this request. (required)
8994 instance: string, Name of the instance scoping this request. (required)
8995 queryPath: string, Specifies the guest attributes path to be queried.
8996 variableKey: string, Specifies the key for the guest attributes entry.
8997 x__xgafv: string, V1 error format.
8998 Allowed values
8999 1 - v1 error format
9000 2 - v2 error format
9001
9002 Returns:
9003 An object of the form:
9004
9005 { # A guest attributes entry.
9006 &quot;kind&quot;: &quot;compute#guestAttributes&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#guestAttributes for guest attributes entry.
9007 &quot;queryPath&quot;: &quot;A String&quot;, # The path to be queried. This can be the default namespace (&#x27;&#x27;) or a
9008 # nested namespace (&#x27;\/&#x27;) or a specified key
9009 # (&#x27;\/\&#x27;).
9010 &quot;queryValue&quot;: { # Array of guest attribute namespace/key/value tuples. # Output only. [Output Only] The value of the requested queried path.
9011 &quot;items&quot;: [
9012 { # A guest attributes namespace/key/value entry.
9013 &quot;key&quot;: &quot;A String&quot;, # Key for the guest attribute entry.
9014 &quot;namespace&quot;: &quot;A String&quot;, # Namespace for the guest attribute entry.
9015 &quot;value&quot;: &quot;A String&quot;, # Value for the guest attribute entry.
9016 },
9017 ],
9018 },
9019 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
9020 &quot;variableKey&quot;: &quot;A String&quot;, # The key to search for.
9021 &quot;variableValue&quot;: &quot;A String&quot;, # Output only. [Output Only] The value found for the requested key.
9022 }</pre>
9023 </div>
9024
9025 <div class="method">
9026 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
9027 <pre>Gets the access control policy for a resource. May be empty if no such
9028 policy or resource exists.
9029
9030 Args:
9031 project: string, Project ID for this request. (required)
9032 zone: string, The name of the zone for this request. (required)
9033 resource: string, Name or id of the resource for this request. (required)
9034 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
9035 x__xgafv: string, V1 error format.
9036 Allowed values
9037 1 - v1 error format
9038 2 - v2 error format
9039
9040 Returns:
9041 An object of the form:
9042
9043 { # An Identity and Access Management (IAM) policy, which specifies access
9044 # controls for Google Cloud resources.
9045 #
9046 #
9047 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
9048 # `members`, or principals, to a single `role`. Principals can be user
9049 # accounts, service accounts, Google groups, and domains (such as G Suite). A
9050 # `role` is a named list of permissions; each `role` can be an IAM predefined
9051 # role or a user-created custom role.
9052 #
9053 # For some types of Google Cloud resources, a `binding` can also specify a
9054 # `condition`, which is a logical expression that allows access to a resource
9055 # only if the expression evaluates to `true`. A condition can add constraints
9056 # based on attributes of the request, the resource, or both. To learn which
9057 # resources support conditions in their IAM policies, see the
9058 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9059 #
9060 # **JSON example:**
9061 #
9062 # ```
9063 # {
9064 # &quot;bindings&quot;: [
9065 # {
9066 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
9067 # &quot;members&quot;: [
9068 # &quot;user:[email protected]&quot;,
9069 # &quot;group:[email protected]&quot;,
9070 # &quot;domain:google.com&quot;,
9071 # &quot;serviceAccount:[email protected]&quot;
9072 # ]
9073 # },
9074 # {
9075 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
9076 # &quot;members&quot;: [
9077 # &quot;user:[email protected]&quot;
9078 # ],
9079 # &quot;condition&quot;: {
9080 # &quot;title&quot;: &quot;expirable access&quot;,
9081 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
9082 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
9083 # }
9084 # }
9085 # ],
9086 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
9087 # &quot;version&quot;: 3
9088 # }
9089 # ```
9090 #
9091 # **YAML example:**
9092 #
9093 # ```
9094 # bindings:
9095 # - members:
9096 # - user:[email protected]
9097 # - group:[email protected]
9098 # - domain:google.com
9099 # - serviceAccount:[email protected]
9100 # role: roles/resourcemanager.organizationAdmin
9101 # - members:
9102 # - user:[email protected]
9103 # role: roles/resourcemanager.organizationViewer
9104 # condition:
9105 # title: expirable access
9106 # description: Does not grant access after Sep 2020
9107 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
9108 # etag: BwWWja0YfJA=
9109 # version: 3
9110 # ```
9111 #
9112 # For a description of IAM and its features, see the
9113 # [IAM documentation](https://cloud.google.com/iam/docs/).
9114 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
9115 { # Specifies the audit configuration for a service.
9116 # The configuration determines which permission types are logged, and what
9117 # identities, if any, are exempted from logging.
9118 # An AuditConfig must have one or more AuditLogConfigs.
9119 #
9120 # If there are AuditConfigs for both `allServices` and a specific service,
9121 # the union of the two AuditConfigs is used for that service: the log_types
9122 # specified in each AuditConfig are enabled, and the exempted_members in each
9123 # AuditLogConfig are exempted.
9124 #
9125 # Example Policy with multiple AuditConfigs:
9126 #
9127 # {
9128 # &quot;audit_configs&quot;: [
9129 # {
9130 # &quot;service&quot;: &quot;allServices&quot;,
9131 # &quot;audit_log_configs&quot;: [
9132 # {
9133 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
9134 # &quot;exempted_members&quot;: [
9135 # &quot;user:[email protected]&quot;
9136 # ]
9137 # },
9138 # {
9139 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
9140 # },
9141 # {
9142 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
9143 # }
9144 # ]
9145 # },
9146 # {
9147 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
9148 # &quot;audit_log_configs&quot;: [
9149 # {
9150 # &quot;log_type&quot;: &quot;DATA_READ&quot;
9151 # },
9152 # {
9153 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
9154 # &quot;exempted_members&quot;: [
9155 # &quot;user:[email protected]&quot;
9156 # ]
9157 # }
9158 # ]
9159 # }
9160 # ]
9161 # }
9162 #
9163 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
9164 # logging. It also exempts `[email protected]` from DATA_READ logging, and
9165 # `[email protected]` from DATA_WRITE logging.
9166 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
9167 { # Provides the configuration for logging a type of permissions.
9168 # Example:
9169 #
9170 # {
9171 # &quot;audit_log_configs&quot;: [
9172 # {
9173 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
9174 # &quot;exempted_members&quot;: [
9175 # &quot;user:[email protected]&quot;
9176 # ]
9177 # },
9178 # {
9179 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
9180 # }
9181 # ]
9182 # }
9183 #
9184 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
9185 # [email protected] from DATA_READ logging.
9186 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
9187 # permission.
9188 # Follows the same format of Binding.members.
9189 &quot;A String&quot;,
9190 ],
9191 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
9192 },
9193 ],
9194 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
9195 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
9196 # `allServices` is a special value that covers all services.
9197 },
9198 ],
9199 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
9200 # may specify a `condition` that determines how and when the `bindings` are
9201 # applied. Each of the `bindings` must contain at least one principal.
9202 #
9203 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
9204 # of these principals can be Google groups. Each occurrence of a principal
9205 # counts towards these limits. For example, if the `bindings` grant 50
9206 # different roles to `user:[email protected]`, and not to any other
9207 # principal, then you can add another 1,450 principals to the `bindings` in
9208 # the `Policy`.
9209 { # Associates `members`, or principals, with a `role`.
9210 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
9211 #
9212 # If the condition evaluates to `true`, then this binding applies to the
9213 # current request.
9214 #
9215 # If the condition evaluates to `false`, then this binding does not apply to
9216 # the current request. However, a different role binding might grant the same
9217 # role to one or more of the principals in this binding.
9218 #
9219 # To learn which resources support conditions in their IAM policies, see the
9220 # [IAM
9221 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9222 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9223 # are documented at https://github.com/google/cel-spec.
9224 #
9225 # Example (Comparison):
9226 #
9227 # title: &quot;Summary size limit&quot;
9228 # description: &quot;Determines if a summary is less than 100 chars&quot;
9229 # expression: &quot;document.summary.size() &lt; 100&quot;
9230 #
9231 # Example (Equality):
9232 #
9233 # title: &quot;Requestor is owner&quot;
9234 # description: &quot;Determines if requestor is the document owner&quot;
9235 # expression: &quot;document.owner == request.auth.claims.email&quot;
9236 #
9237 # Example (Logic):
9238 #
9239 # title: &quot;Public documents&quot;
9240 # description: &quot;Determine whether the document should be publicly visible&quot;
9241 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9242 #
9243 # Example (Data Manipulation):
9244 #
9245 # title: &quot;Notification string&quot;
9246 # description: &quot;Create a notification string with a timestamp.&quot;
9247 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9248 #
9249 # The exact variables and functions that may be referenced within an expression
9250 # are determined by the service that evaluates it. See the service
9251 # documentation for additional information.
9252 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9253 # describes the expression, e.g. when hovered over it in a UI.
9254 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9255 # syntax.
9256 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9257 # reporting, e.g. a file name and a position in the file.
9258 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9259 # its purpose. This can be used e.g. in UIs which allow to enter the
9260 # expression.
9261 },
9262 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
9263 # `members` can have the following values:
9264 #
9265 # * `allUsers`: A special identifier that represents anyone who is
9266 # on the internet; with or without a Google account.
9267 #
9268 # * `allAuthenticatedUsers`: A special identifier that represents anyone
9269 # who is authenticated with a Google account or a service account.
9270 # Does not include identities that come from external identity providers
9271 # (IdPs) through identity federation.
9272 #
9273 # * `user:{emailid}`: An email address that represents a specific Google
9274 # account. For example, `[email protected]` .
9275 #
9276 #
9277 # * `serviceAccount:{emailid}`: An email address that represents a Google
9278 # service account. For example,
9279 # `[email protected]`.
9280 #
9281 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
9282 # identifier for a
9283 # [Kubernetes service
9284 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
9285 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
9286 #
9287 # * `group:{emailid}`: An email address that represents a Google group.
9288 # For example, `[email protected]`.
9289 #
9290 #
9291 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
9292 # users of that domain. For example, `google.com` or `example.com`.
9293 #
9294 #
9295 #
9296 #
9297 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
9298 # A single identity in a workforce identity pool.
9299 #
9300 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
9301 # All workforce identities in a group.
9302 #
9303 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
9304 # All workforce identities with a specific attribute value.
9305 #
9306 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
9307 # All identities in a workforce identity pool.
9308 #
9309 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
9310 # A single identity in a workload identity pool.
9311 #
9312 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
9313 # A workload identity pool group.
9314 #
9315 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
9316 # All identities in a workload identity pool with a certain attribute.
9317 #
9318 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
9319 # All identities in a workload identity pool.
9320 #
9321 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
9322 # identifier) representing a user that has been recently deleted. For
9323 # example, `[email protected]?uid=123456789012345678901`. If the user is
9324 # recovered, this value reverts to `user:{emailid}` and the recovered user
9325 # retains the role in the binding.
9326 #
9327 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
9328 # unique identifier) representing a service account that has been recently
9329 # deleted. For example,
9330 # `[email protected]?uid=123456789012345678901`.
9331 # If the service account is undeleted, this value reverts to
9332 # `serviceAccount:{emailid}` and the undeleted service account retains the
9333 # role in the binding.
9334 #
9335 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
9336 # identifier) representing a Google group that has been recently
9337 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
9338 # the group is recovered, this value reverts to `group:{emailid}` and the
9339 # recovered group retains the role in the binding.
9340 #
9341 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
9342 # Deleted single identity in a workforce identity pool. For example,
9343 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
9344 &quot;A String&quot;,
9345 ],
9346 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
9347 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
9348 #
9349 # For an overview of the IAM roles and permissions, see the
9350 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
9351 # a list of the available pre-defined roles, see
9352 # [here](https://cloud.google.com/iam/docs/understanding-roles).
9353 },
9354 ],
9355 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
9356 # prevent simultaneous updates of a policy from overwriting each other.
9357 # It is strongly suggested that systems make use of the `etag` in the
9358 # read-modify-write cycle to perform policy updates in order to avoid race
9359 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
9360 # systems are expected to put that etag in the request to `setIamPolicy` to
9361 # ensure that their change will be applied to the same version of the policy.
9362 #
9363 # **Important:** If you use IAM Conditions, you must include the `etag` field
9364 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9365 # you to overwrite a version `3` policy with a version `1` policy, and all of
9366 # the conditions in the version `3` policy are lost.
9367 &quot;version&quot;: 42, # Specifies the format of the policy.
9368 #
9369 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
9370 # are rejected.
9371 #
9372 # Any operation that affects conditional role bindings must specify version
9373 # `3`. This requirement applies to the following operations:
9374 #
9375 # * Getting a policy that includes a conditional role binding
9376 # * Adding a conditional role binding to a policy
9377 # * Changing a conditional role binding in a policy
9378 # * Removing any role binding, with or without a condition, from a policy
9379 # that includes conditions
9380 #
9381 # **Important:** If you use IAM Conditions, you must include the `etag` field
9382 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9383 # you to overwrite a version `3` policy with a version `1` policy, and all of
9384 # the conditions in the version `3` policy are lost.
9385 #
9386 # If a policy does not include any conditions, operations on that policy may
9387 # specify any valid version or leave the field unset.
9388 #
9389 # To learn which resources support conditions in their IAM policies, see the
9390 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9391 }</pre>
9392 </div>
9393
9394 <div class="method">
9395 <code class="details" id="getPartnerMetadata">getPartnerMetadata(project, zone, instance, namespaces=None, x__xgafv=None)</code>
9396 <pre>Gets partner metadata of the specified instance and namespaces.
9397
9398 Args:
9399 project: string, Project ID for this request. (required)
9400 zone: string, The name of the zone for this request. (required)
9401 instance: string, Name of the instance scoping this request. (required)
9402 namespaces: string, Comma separated partner metadata namespaces.
9403 x__xgafv: string, V1 error format.
9404 Allowed values
9405 1 - v1 error format
9406 2 - v2 error format
9407
9408 Returns:
9409 An object of the form:
9410
9411 { # Model definition of partner_metadata field.
9412 # To be used in dedicated Partner Metadata methods and to be inlined in
9413 # the Instance and InstanceTemplate resources.
9414 &quot;fingerprint&quot;: &quot;A String&quot;, # Instance-level hash to be used for optimistic
9415 # locking.
9416 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain to
9417 # entries map. Subdomain name must be compliant withRFC1035
9418 # definition. The total size of all keys and values must be less than 2MB.
9419 # Subdomain &#x27;metadata.compute.googleapis.com&#x27; is reserverd for instance&#x27;s
9420 # metadata.
9421 &quot;a_key&quot;: {
9422 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
9423 # It accepts any value including google.protobuf.Struct.
9424 &quot;a_key&quot;: &quot;&quot;,
9425 },
9426 },
9427 },
9428 }</pre>
9429 </div>
9430
9431 <div class="method">
9432 <code class="details" id="getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</code>
9433 <pre>Returns the screenshot from the specified instance.
9434
9435 Args:
9436 project: string, Project ID for this request. (required)
9437 zone: string, The name of the zone for this request. (required)
9438 instance: string, Name of the instance scoping this request. (required)
9439 x__xgafv: string, V1 error format.
9440 Allowed values
9441 1 - v1 error format
9442 2 - v2 error format
9443
9444 Returns:
9445 An object of the form:
9446
9447 { # An instance&#x27;s screenshot.
9448 &quot;contents&quot;: &quot;A String&quot;, # [Output Only] The Base64-encoded screenshot data.
9449 &quot;kind&quot;: &quot;compute#screenshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#screenshot
9450 # for the screenshots.
9451 }</pre>
9452 </div>
9453
9454 <div class="method">
9455 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None, x__xgafv=None)</code>
9456 <pre>Returns the last 1 MB of serial port output from the specified instance.
9457
9458 Args:
9459 project: string, Project ID for this request. (required)
9460 zone: string, The name of the zone for this request. (required)
9461 instance: string, Name of the instance for this request. (required)
9462 port: integer, Specifies which COM or serial port to retrieve data from.
9463 start: string, Specifies the starting byte position of the output to return. To start with
9464 the first byte of output to the specified port, omit this field or set it
9465 to `0`.
9466
9467 If the output for that byte position is available, this field matches the
9468 `start` parameter sent with the request. If the amount of serial console
9469 output exceeds the size of the buffer (1 MB), the oldest output is
9470 discarded and is no longer available. If the requested start position
9471 refers to discarded output, the start position is adjusted to the oldest
9472 output still available, and the adjusted start position is returned as the
9473 `start` property value.
9474
9475 You can also provide a negative start position, which translates to the
9476 most recent number of bytes written to the serial port. For example, -3 is
9477 interpreted as the most recent 3 bytes written to the serial console. Note
9478 that the negative start is bounded by the retained buffer size, and the
9479 returned serial console output will not exceed the max buffer size.
9480 x__xgafv: string, V1 error format.
9481 Allowed values
9482 1 - v1 error format
9483 2 - v2 error format
9484
9485 Returns:
9486 An object of the form:
9487
9488 { # An instance serial console output.
9489 &quot;contents&quot;: &quot;A String&quot;, # [Output Only] The contents of the console output.
9490 &quot;kind&quot;: &quot;compute#serialPortOutput&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#serialPortOutput for serial port output.
9491 &quot;next&quot;: &quot;A String&quot;, # [Output Only] The position of the next byte of content, regardless of
9492 # whether the content exists, following the output returned in the `contents`
9493 # property. Use this value in the next request as the start
9494 # parameter.
9495 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
9496 &quot;start&quot;: &quot;A String&quot;, # The starting byte position of the output that was returned.
9497 # This should match the start parameter sent with the request.
9498 # If the serial console output exceeds the size of the buffer (1 MB), older
9499 # output is overwritten by newer content. The output start value will
9500 # indicate the byte position of the output that was returned, which might be
9501 # different than the `start` value that was specified in the request.
9502 }</pre>
9503 </div>
9504
9505 <div class="method">
9506 <code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance, x__xgafv=None)</code>
9507 <pre>Returns the Shielded Instance Identity of an instance
9508
9509 Args:
9510 project: string, Project ID for this request. (required)
9511 zone: string, The name of the zone for this request. (required)
9512 instance: string, Name or id of the instance scoping this request. (required)
9513 x__xgafv: string, V1 error format.
9514 Allowed values
9515 1 - v1 error format
9516 2 - v2 error format
9517
9518 Returns:
9519 An object of the form:
9520
9521 { # A Shielded Instance Identity.
9522 &quot;eccP256EncryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the ECC P256 algorithm
9523 # issued to the Shielded Instance&#x27;s vTPM.
9524 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
9525 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
9526 },
9527 &quot;eccP256SigningKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the ECC P256 algorithm
9528 # issued to the Shielded Instance&#x27;s vTPM.
9529 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
9530 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
9531 },
9532 &quot;encryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm
9533 # issued to the Shielded Instance&#x27;s vTPM.
9534 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
9535 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
9536 },
9537 &quot;kind&quot;: &quot;compute#shieldedInstanceIdentity&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#shieldedInstanceIdentity for shielded Instance
9538 # identity entry.
9539 &quot;signingKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm
9540 # issued to the Shielded Instance&#x27;s vTPM.
9541 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
9542 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
9543 },
9544 }</pre>
9545 </div>
9546
9547 <div class="method">
9548 <code class="details" id="getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance, x__xgafv=None)</code>
9549 <pre>Returns the Shielded VM Identity of an instance
9550
9551 Args:
9552 project: string, Project ID for this request. (required)
9553 zone: string, The name of the zone for this request. (required)
9554 instance: string, Name of the instance scoping this request. (required)
9555 x__xgafv: string, V1 error format.
9556 Allowed values
9557 1 - v1 error format
9558 2 - v2 error format
9559
9560 Returns:
9561 An object of the form:
9562
9563 { # A Shielded VM Identity.
9564 &quot;encryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM&#x27;s vTPM.
9565 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
9566 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
9567 },
9568 &quot;kind&quot;: &quot;compute#shieldedVmIdentity&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#shieldedVmIdentity for shielded VM identity entry.
9569 &quot;signingKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM&#x27;s vTPM.
9570 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
9571 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
9572 },
9573 }</pre>
9574 </div>
9575
9576 <div class="method">
9577 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</code>
9578 <pre>Creates an instance resource in the specified project using the data
9579 included in the request.
9580
9581 Args:
9582 project: string, Project ID for this request. (required)
9583 zone: string, The name of the zone for this request. (required)
9584 body: object, The request body.
9585 The object takes the form of:
9586
9587 { # Represents an Instance resource.
9588 #
9589 # An instance is a virtual machine that is hosted on Google Cloud Platform.
9590 # For more information, readVirtual Machine Instances.
9591 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
9592 # Options that would traditionally be configured in a BIOS belong
9593 # here. Features that require operating system support may have
9594 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
9595 # disabled).
9596 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
9597 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
9598 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
9599 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
9600 # multithreading (SMT) set this to 1. If unset, the maximum number
9601 # of threads supported per core by the underlying processor is
9602 # assumed.
9603 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
9604 # Supported modes include:
9605 # * ALL_CORE_MAX
9606 #
9607 # Using empty string or not setting this field will use the platform-specific
9608 # default turbo mode.
9609 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
9610 # the number of threads per core to compute the total number of virtual
9611 # CPUs to expose to the instance. If unset, the number of cores is
9612 # inferred from the instance&#x27;s nominal CPU count and the underlying
9613 # platform&#x27;s SMT width.
9614 },
9615 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
9616 # destination or source IPs. This is required if you plan to use this
9617 # instance to forward routes. For more information, seeEnabling IP Forwarding.
9618 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
9619 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
9620 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
9621 },
9622 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
9623 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
9624 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
9625 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
9626 # create the resource.
9627 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
9628 # created before you can assign them.
9629 { # An instance-attached disk resource.
9630 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
9631 # or X86_64.
9632 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
9633 # deleted (but not when the disk is detached from the instance).
9634 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
9635 # partition of the disk for its root filesystem.
9636 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
9637 # running within the instance. This name can be used to reference the device
9638 # for mounting, resizing, and so on, from within the instance.
9639 #
9640 # If not specified, the server chooses a default device name to apply to this
9641 # disk, in the form persistent-disk-x, where x is a number
9642 # assigned by Google Compute Engine. This field is only applicable for
9643 # persistent disks.
9644 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
9645 # encryption key.
9646 #
9647 # If you are creating a new disk, this field encrypts the new disk using
9648 # an encryption key that you provide. If you are attaching an existing
9649 # disk that is already encrypted, this field decrypts the disk using
9650 # the customer-supplied encryption key.
9651 #
9652 # If you encrypt a disk using a customer-supplied key, you must provide the
9653 # same key again when you attempt to use this resource at a later time. For
9654 # example, you must provide the key when you create a snapshot or an image
9655 # from the disk or when you attach the disk to a virtual machine instance.
9656 #
9657 # If you do not provide an encryption key, then the disk will be encrypted
9658 # using an automatically generated key and you do not need to provide a key
9659 # to use the disk later.
9660 #
9661 # Note:
9662 #
9663 # Instance templates do not storecustomer-supplied
9664 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
9665 #
9666 # You cannot create VMs that have disks with customer-supplied keys using
9667 # the bulk
9668 # insert method.
9669 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
9670 # For example:
9671 #
9672 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9673 # key_region/cryptoKeys/key
9674 #
9675 # The fully-qualifed key name may be returned for resource GET requests. For
9676 # example:
9677 #
9678 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9679 # key_region/cryptoKeys/key
9680 # /cryptoKeyVersions/1
9681 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
9682 # key. If absent, the Compute Engine default service account is used.
9683 # For example:
9684 #
9685 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
9686 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
9687 # encryption key, encoded in RFC
9688 # 4648 base64 to either encrypt or decrypt this resource. You can
9689 # provide either the rawKey or thersaEncryptedKey.
9690 # For example:
9691 #
9692 # &quot;rawKey&quot;:
9693 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
9694 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
9695 # customer-supplied encryption key to either encrypt or decrypt this
9696 # resource. You can provide either the rawKey or thersaEncryptedKey.
9697 # For example:
9698 #
9699 # &quot;rsaEncryptedKey&quot;:
9700 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
9701 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
9702 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
9703 #
9704 # The key must meet the following requirements before you can provide it to
9705 # Compute Engine:
9706 #
9707 # 1. The key is wrapped using a RSA public key certificate provided by
9708 # Google.
9709 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
9710 # encoding.
9711 #
9712 # Gets the RSA public key certificate provided by Google at:
9713 #
9714 #
9715 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
9716 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
9717 # 4648 base64 encoded SHA-256 hash of the customer-supplied
9718 # encryption key that protects this resource.
9719 },
9720 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
9721 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
9722 # currently attached to another instance. If you try to force attach a zonal
9723 # disk to an instance, you will receive an error.
9724 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
9725 # only for bootable images. Read
9726 # Enabling guest operating system features to see a list of available
9727 # options.
9728 { # Guest OS features.
9729 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
9730 # separate values. Set to one or more of the following values:
9731 #
9732 # - VIRTIO_SCSI_MULTIQUEUE
9733 # - WINDOWS
9734 # - MULTI_IP_SUBNET
9735 # - UEFI_COMPATIBLE
9736 # - GVNIC
9737 # - SEV_CAPABLE
9738 # - SUSPEND_RESUME_COMPATIBLE
9739 # - SEV_LIVE_MIGRATABLE_V2
9740 # - SEV_SNP_CAPABLE
9741 # - TDX_CAPABLE
9742 # - IDPF
9743 # - SNP_SVSM_CAPABLE
9744 # - CCA_CAPABLE
9745 #
9746 #
9747 # For more information, see
9748 # Enabling guest operating system features.
9749 },
9750 ],
9751 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
9752 # boot disk. If you have many disks attached to an instance, each
9753 # disk would have a unique index number.
9754 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
9755 # alongside the new instance. Use initialization parameters to create boot
9756 # disks or local SSDs attached to the new instance.
9757 #
9758 # This property is mutually exclusive with the source property;
9759 # you can only define one or the other, but not both.
9760 # alongside the new instance. Use initialization parameters to create boot
9761 # disks or local SSDs attached to the new instance.
9762 #
9763 # This field is persisted and returned for instanceTemplate and not returned
9764 # in the context of instance.
9765 #
9766 # This property is mutually exclusive with the source property;
9767 # you can only define one or the other, but not both.
9768 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
9769 # arm64 or x86_64.
9770 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
9771 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
9772 # of the instance. If a disk with the same name already exists in the given
9773 # region, the existing disk is attached to the new instance and the
9774 # new disk is not created.
9775 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
9776 # 10 GB. If you specify a sourceImage, which is required for
9777 # boot disks, the default size is the size of the sourceImage.
9778 # If you do not specify a sourceImage, the default disk size
9779 # is 500 GB.
9780 &quot;diskType&quot;: &quot;A String&quot;,
9781 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
9782 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
9783 # only for bootable images. Read
9784 # Enabling guest operating system features to see a list of available
9785 # options.
9786 #
9787 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
9788 { # Guest OS features.
9789 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
9790 # separate values. Set to one or more of the following values:
9791 #
9792 # - VIRTIO_SCSI_MULTIQUEUE
9793 # - WINDOWS
9794 # - MULTI_IP_SUBNET
9795 # - UEFI_COMPATIBLE
9796 # - GVNIC
9797 # - SEV_CAPABLE
9798 # - SUSPEND_RESUME_COMPATIBLE
9799 # - SEV_LIVE_MIGRATABLE_V2
9800 # - SEV_SNP_CAPABLE
9801 # - TDX_CAPABLE
9802 # - IDPF
9803 # - SNP_SVSM_CAPABLE
9804 # - CCA_CAPABLE
9805 #
9806 #
9807 # For more information, see
9808 # Enabling guest operating system features.
9809 },
9810 ],
9811 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
9812 # persistent disks.
9813 &quot;a_key&quot;: &quot;A String&quot;,
9814 },
9815 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
9816 &quot;A String&quot;,
9817 ],
9818 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
9819 # more than one instance.
9820 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
9821 # is to use the existing disk.
9822 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
9823 # of I/O operations per second that the disk can handle. Values must be
9824 # between 10,000 and 120,000. For more details, see theExtreme persistent
9825 # disk documentation.
9826 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
9827 # number of throughput mb per second that the disk can handle. Values must
9828 # greater than or equal to 1.
9829 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
9830 # the URLs of the zones where the disk should be replicated to.
9831 # You must provide exactly two replica zones, and one zone must be the same
9832 # as the instance zone.
9833 &quot;A String&quot;,
9834 ],
9835 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
9836 # have the same definition as resource
9837 # manager tags. Keys and values can be either in numeric format,
9838 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
9839 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
9840 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
9841 # empty.
9842 &quot;a_key&quot;: &quot;A String&quot;,
9843 },
9844 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
9845 # Specified using the full or partial URL. For instance template, specify
9846 # only the resource policy name.
9847 &quot;A String&quot;,
9848 ],
9849 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
9850 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
9851 # is required.
9852 #
9853 # To create a disk with one of the public operating system
9854 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
9855 #
9856 # projects/debian-cloud/global/images/family/debian-9
9857 #
9858 #
9859 # Alternatively, use a specific version of a public operating system image:
9860 #
9861 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
9862 #
9863 #
9864 # To create a disk with a custom image that you created, specify the
9865 # image name in the following format:
9866 #
9867 # global/images/my-custom-image
9868 #
9869 #
9870 # You can also specify a custom image by its image family, which returns
9871 # the latest version of the image in that family. Replace the image name
9872 # with family/family-name:
9873 #
9874 # global/images/family/my-image-family
9875 #
9876 #
9877 # If the source image is deleted later, this field will not be set.
9878 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
9879 # encryption key of the source image. Required if the source image is
9880 # protected by a customer-supplied encryption key.
9881 #
9882 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
9883 # encryption keys, so you cannot create disks for instances in a managed instance group if the
9884 # source images are encrypted with your own keys.
9885 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
9886 # For example:
9887 #
9888 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9889 # key_region/cryptoKeys/key
9890 #
9891 # The fully-qualifed key name may be returned for resource GET requests. For
9892 # example:
9893 #
9894 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9895 # key_region/cryptoKeys/key
9896 # /cryptoKeyVersions/1
9897 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
9898 # key. If absent, the Compute Engine default service account is used.
9899 # For example:
9900 #
9901 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
9902 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
9903 # encryption key, encoded in RFC
9904 # 4648 base64 to either encrypt or decrypt this resource. You can
9905 # provide either the rawKey or thersaEncryptedKey.
9906 # For example:
9907 #
9908 # &quot;rawKey&quot;:
9909 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
9910 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
9911 # customer-supplied encryption key to either encrypt or decrypt this
9912 # resource. You can provide either the rawKey or thersaEncryptedKey.
9913 # For example:
9914 #
9915 # &quot;rsaEncryptedKey&quot;:
9916 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
9917 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
9918 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
9919 #
9920 # The key must meet the following requirements before you can provide it to
9921 # Compute Engine:
9922 #
9923 # 1. The key is wrapped using a RSA public key certificate provided by
9924 # Google.
9925 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
9926 # encoding.
9927 #
9928 # Gets the RSA public key certificate provided by Google at:
9929 #
9930 #
9931 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
9932 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
9933 # 4648 base64 encoded SHA-256 hash of the customer-supplied
9934 # encryption key that protects this resource.
9935 },
9936 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
9937 # instance boot disk, one of initializeParams.sourceSnapshot
9938 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
9939 # is required.
9940 #
9941 # To create a disk with a snapshot that you created, specify the
9942 # snapshot name in the following format:
9943 #
9944 # us-central1-a/instantSnapshots/my-backup
9945 #
9946 #
9947 # If the source instant-snapshot is deleted later, this field will not be
9948 # set.
9949 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
9950 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
9951 # is required.
9952 #
9953 # To create a disk with a snapshot that you created, specify the
9954 # snapshot name in the following format:
9955 #
9956 # global/snapshots/my-backup
9957 #
9958 #
9959 # If the source snapshot is deleted later, this field will not be set.
9960 #
9961 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
9962 # an image instead when you create VMs using
9963 # the bulk
9964 # insert method.
9965 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
9966 # encryption key of the source snapshot.
9967 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
9968 # For example:
9969 #
9970 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9971 # key_region/cryptoKeys/key
9972 #
9973 # The fully-qualifed key name may be returned for resource GET requests. For
9974 # example:
9975 #
9976 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9977 # key_region/cryptoKeys/key
9978 # /cryptoKeyVersions/1
9979 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
9980 # key. If absent, the Compute Engine default service account is used.
9981 # For example:
9982 #
9983 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
9984 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
9985 # encryption key, encoded in RFC
9986 # 4648 base64 to either encrypt or decrypt this resource. You can
9987 # provide either the rawKey or thersaEncryptedKey.
9988 # For example:
9989 #
9990 # &quot;rawKey&quot;:
9991 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
9992 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
9993 # customer-supplied encryption key to either encrypt or decrypt this
9994 # resource. You can provide either the rawKey or thersaEncryptedKey.
9995 # For example:
9996 #
9997 # &quot;rsaEncryptedKey&quot;:
9998 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
9999 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10000 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10001 #
10002 # The key must meet the following requirements before you can provide it to
10003 # Compute Engine:
10004 #
10005 # 1. The key is wrapped using a RSA public key certificate provided by
10006 # Google.
10007 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10008 # encoding.
10009 #
10010 # Gets the RSA public key certificate provided by Google at:
10011 #
10012 #
10013 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10014 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10015 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10016 # encryption key that protects this resource.
10017 },
10018 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
10019 # this as a partial or full URL to the resource. For example, the following
10020 # are valid values:
10021 #
10022 #
10023 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
10024 # - projects/project/zones/zone/storagePools/storagePool
10025 # - zones/zone/storagePools/storagePool
10026 },
10027 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
10028 # either SCSI or NVME. For most machine types, the
10029 # default is SCSI. Local SSDs can use either NVME or SCSI.
10030 # In certain configurations, persistent disks can use NVMe. For more
10031 # information, seeAbout
10032 # persistent disks.
10033 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
10034 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
10035 &quot;A String&quot;,
10036 ],
10037 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
10038 # disk is not allowed to be detached from the instance, or to be used as the
10039 # source of the snapshot creation, and the image creation. The instance with
10040 # at least one locked attached disk is not allow to be used as source of
10041 # machine image creation, instant snapshot creation, and not allowed to be
10042 # deleted with --keep-disk parameter set to true for locked disks.
10043 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
10044 # in READ_WRITE mode.
10045 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
10046 # field is set to PRESERVED if the LocalSSD data has been saved
10047 # to a persistent location by customer request. (see the
10048 # discard_local_ssd option on Stop/Suspend).
10049 # Read-only in the api.
10050 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
10051 # these are public keys which are safe to store in public
10052 &quot;dbs&quot;: [ # The Key Database (db).
10053 {
10054 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10055 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10056 },
10057 ],
10058 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
10059 {
10060 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10061 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10062 },
10063 ],
10064 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
10065 {
10066 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10067 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10068 },
10069 ],
10070 &quot;pk&quot;: { # The Platform Key (PK).
10071 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10072 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10073 },
10074 },
10075 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
10076 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
10077 # is required.
10078 #
10079 # If desired, you can also attach existing non-root persistent disks using
10080 # this property. This field is only applicable for persistent disks.
10081 #
10082 # Note that for InstanceTemplate, specify the disk name for zonal disk,
10083 # and the URL for regional disk.
10084 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
10085 },
10086 ],
10087 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
10088 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
10089 },
10090 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
10091 # machine image should erase Windows specific VSS signature.
10092 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
10093 # the instance&#x27;s contents and used for optimistic locking. The
10094 # fingerprint is initially generated by Compute Engine and changes after
10095 # every request to modify or update the instance. You must always provide an
10096 # up-to-date fingerprint hash in order to update the instance.
10097 #
10098 # To see the latest fingerprint, make get() request to the
10099 # instance.
10100 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
10101 { # A specification of the type and number of accelerator cards attached to the
10102 # instance.
10103 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
10104 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
10105 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
10106 # If you are creating an instance template, specify only the
10107 # accelerator name.
10108 # See GPUs on Compute Engine
10109 # for a full list of accelerator types.
10110 },
10111 ],
10112 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
10113 # RFC1035 compliant. If hostname is not specified, the default hostname is
10114 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
10115 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
10116 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
10117 # defined by the server.
10118 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
10119 # encryption key.
10120 #
10121 # If you are creating a new instance, this field will encrypt the local SSD
10122 # and in-memory contents of the instance during the suspend operation.
10123 #
10124 # If you do not provide an encryption key when creating the instance, then
10125 # the local SSD and in-memory contents will be encrypted using
10126 # an automatically generated key during the suspend operation.
10127 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10128 # For example:
10129 #
10130 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10131 # key_region/cryptoKeys/key
10132 #
10133 # The fully-qualifed key name may be returned for resource GET requests. For
10134 # example:
10135 #
10136 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10137 # key_region/cryptoKeys/key
10138 # /cryptoKeyVersions/1
10139 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10140 # key. If absent, the Compute Engine default service account is used.
10141 # For example:
10142 #
10143 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10144 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10145 # encryption key, encoded in RFC
10146 # 4648 base64 to either encrypt or decrypt this resource. You can
10147 # provide either the rawKey or thersaEncryptedKey.
10148 # For example:
10149 #
10150 # &quot;rawKey&quot;:
10151 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10152 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10153 # customer-supplied encryption key to either encrypt or decrypt this
10154 # resource. You can provide either the rawKey or thersaEncryptedKey.
10155 # For example:
10156 #
10157 # &quot;rsaEncryptedKey&quot;:
10158 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10159 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10160 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10161 #
10162 # The key must meet the following requirements before you can provide it to
10163 # Compute Engine:
10164 #
10165 # 1. The key is wrapped using a RSA public key certificate provided by
10166 # Google.
10167 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10168 # encoding.
10169 #
10170 # Gets the RSA public key certificate provided by Google at:
10171 #
10172 #
10173 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10174 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10175 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10176 # encryption key that protects this resource.
10177 },
10178 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
10179 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
10180 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
10181 # for instances.
10182 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
10183 # the label&#x27;s contents and used for optimistic locking. The
10184 # fingerprint is initially generated by Compute Engine and changes after
10185 # every request to modify or update labels. You must always provide an
10186 # up-to-date fingerprint hash in order to update or change labels.
10187 #
10188 # To see the latest fingerprint, make get() request to the
10189 # instance.
10190 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
10191 # the setLabels method.
10192 &quot;a_key&quot;: &quot;A String&quot;,
10193 },
10194 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
10195 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
10196 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
10197 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
10198 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
10199 # when the instance is created. For example, the following is a valid partial
10200 # url to a predefined
10201 # machine type:
10202 #
10203 # zones/us-central1-f/machineTypes/n1-standard-1
10204 #
10205 #
10206 # To create acustom
10207 # machine type, provide a URL to a machine type in the following format,
10208 # where CPUS is 1 or an even number up to 32 (2,
10209 # 4, 6, ... 24, etc), and MEMORY is the total
10210 # memory for this instance. Memory must be a multiple of 256 MB and must
10211 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
10212 #
10213 # zones/zone/machineTypes/custom-CPUS-MEMORY
10214 #
10215 #
10216 # For example: zones/us-central1-f/machineTypes/custom-4-5120
10217 # For a full list of restrictions, read theSpecifications
10218 # for custom machine types.
10219 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
10220 # to this instance. This includes metadata keys that were explicitly defined
10221 # for the instance.
10222 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
10223 # the metadata&#x27;s contents and used for optimistic locking. The
10224 # fingerprint is initially generated by Compute Engine and changes after
10225 # every request to modify or update metadata. You must always provide an
10226 # up-to-date fingerprint hash in order to update or change metadata,
10227 # otherwise the request will fail with error412 conditionNotMet.
10228 #
10229 # To see the latest fingerprint, make a get() request to
10230 # retrieve the resource.
10231 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
10232 # less than 512 KB.
10233 { # Metadata
10234 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
10235 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
10236 # This is reflected as part of a URL in the metadata server. Additionally, to
10237 # avoid ambiguity, keys must not conflict with any other metadata keys
10238 # for the project.
10239 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
10240 # have meaning as interpreted by the image running in the instance. The
10241 # only restriction placed on values is that their size must be less than
10242 # or equal to 262144 bytes (256 KiB).
10243 },
10244 ],
10245 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
10246 # for metadata.
10247 },
10248 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
10249 # platform for the VM instance. Applicable values are the friendly names
10250 # of CPU platforms, such as minCpuPlatform: &quot;Intel
10251 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
10252 # Bridge&quot;.
10253 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
10254 # the resource. The resource name must be 1-63 characters long, and comply
10255 # withRFC1035.
10256 # Specifically, the name must be 1-63 characters long and match the regular
10257 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
10258 # character must be a lowercase letter, and all following characters must be
10259 # a dash, lowercase letter, or digit, except the last character, which cannot
10260 # be a dash.
10261 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
10262 # interfaces are configured to interact with other network services, such as
10263 # connecting to the internet. Multiple interfaces are supported
10264 # per instance.
10265 { # A network interface resource attached to an instance.
10266 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
10267 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
10268 # no external internet access.
10269 { # An access configuration attached to an instance&#x27;s network interface.
10270 # Only one access config per instance is supported.
10271 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
10272 # The first IPv6 address of the external IPv6 range associated
10273 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
10274 # use a static external IP address, it must be unused and in the same region
10275 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
10276 # assign an external IPv6 address from the instance&#x27;s subnetwork.
10277 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
10278 # external IPv6 range.
10279 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
10280 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
10281 # (IPv4), the default and recommended name is External NAT, but
10282 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
10283 # recommend name is External IPv6.
10284 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
10285 # address associated with this instance. Specify an unused static
10286 # external IP address available to the project or leave this field undefined
10287 # to use an IP from a shared ephemeral IP address pool. If you specify a
10288 # static external IP address, it must live in the same region as the zone of
10289 # the instance.
10290 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
10291 # configuration and can only take the following values: PREMIUM,STANDARD.
10292 #
10293 # If an AccessConfig is specified without a valid external IP address, an
10294 # ephemeral IP will be created with this networkTier.
10295 #
10296 # If an AccessConfig with a valid external IP address is specified, it must
10297 # match that of the networkTier associated with the Address resource owning
10298 # that IP.
10299 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
10300 #
10301 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
10302 # first IP in associated external IPv6 range.
10303 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
10304 # config.
10305 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
10306 # external IP address of the instance to a DNS domain name.
10307 #
10308 # This field is not used in ipv6AccessConfig. A default PTR
10309 # record will be created if the VM has external IPv6 range associated.
10310 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
10311 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
10312 },
10313 ],
10314 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
10315 # You can only specify this field for network interfaces in VPC networks.
10316 { # An alias IP range attached to an instance&#x27;s network interface.
10317 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
10318 # must belong to the specified subnetwork and cannot contain IP addresses
10319 # reserved by system or used by other network interfaces. This range may be
10320 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
10321 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
10322 # alias range. If not specified, the primary range of the subnetwork is used.
10323 },
10324 ],
10325 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
10326 # You can only specify this field for network interfaces in VPC networks.
10327 { # An alias IP range attached to an instance&#x27;s network interface.
10328 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
10329 # must belong to the specified subnetwork and cannot contain IP addresses
10330 # reserved by system or used by other network interfaces. This range may be
10331 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
10332 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
10333 # alias range. If not specified, the primary range of the subnetwork is used.
10334 },
10335 ],
10336 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
10337 # with network_attachment.
10338 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
10339 # This field will be ignored when inserting an Instance or
10340 # adding a NetworkInterface. An up-to-date
10341 # fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
10342 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
10343 # or not. If enabled, also indicates the version of IGMP supported.
10344 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
10345 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
10346 # one IPv6 access config, DIRECT_IPV6, is supported. If there
10347 # is no ipv6AccessConfig specified, then this instance will
10348 # have no external IPv6 Internet access.
10349 { # An access configuration attached to an instance&#x27;s network interface.
10350 # Only one access config per instance is supported.
10351 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
10352 # The first IPv6 address of the external IPv6 range associated
10353 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
10354 # use a static external IP address, it must be unused and in the same region
10355 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
10356 # assign an external IPv6 address from the instance&#x27;s subnetwork.
10357 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
10358 # external IPv6 range.
10359 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
10360 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
10361 # (IPv4), the default and recommended name is External NAT, but
10362 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
10363 # recommend name is External IPv6.
10364 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
10365 # address associated with this instance. Specify an unused static
10366 # external IP address available to the project or leave this field undefined
10367 # to use an IP from a shared ephemeral IP address pool. If you specify a
10368 # static external IP address, it must live in the same region as the zone of
10369 # the instance.
10370 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
10371 # configuration and can only take the following values: PREMIUM,STANDARD.
10372 #
10373 # If an AccessConfig is specified without a valid external IP address, an
10374 # ephemeral IP will be created with this networkTier.
10375 #
10376 # If an AccessConfig with a valid external IP address is specified, it must
10377 # match that of the networkTier associated with the Address resource owning
10378 # that IP.
10379 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
10380 #
10381 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
10382 # first IP in associated external IPv6 range.
10383 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
10384 # config.
10385 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
10386 # external IP address of the instance to a DNS domain name.
10387 #
10388 # This field is not used in ipv6AccessConfig. A default PTR
10389 # record will be created if the VM has external IPv6 range associated.
10390 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
10391 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
10392 },
10393 ],
10394 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
10395 # accessed from the Internet. This field is always inherited from its
10396 # subnetwork.
10397 #
10398 # Valid only if stackType is IPV4_IPV6.
10399 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
10400 # use a static internal IP address, it must be unused and in the same region
10401 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
10402 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
10403 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
10404 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
10405 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
10406 # server. For a VM, the network interface uses the nicN naming
10407 # format. Where N is a value between 0 and7. The default interface value is nic0.
10408 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
10409 # instance, if neither the network nor the subnetwork is specified, the
10410 # default network global/networks/default is used. If the
10411 # selected project doesn&#x27;t have the default network, you must specify a
10412 # network or subnet. If the network is not specified but the subnetwork is
10413 # specified, the network is inferred.
10414 #
10415 # If you specify this property, you can specify the network as
10416 # a full or partial URL. For example, the following are all valid URLs:
10417 #
10418 #
10419 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
10420 # - projects/project/global/networks/network
10421 # - global/networks/default
10422 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
10423 # to in the following format:
10424 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
10425 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
10426 # interface. If not specified by the user, an unused internal IP is
10427 # assigned by the system.
10428 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
10429 # VirtioNet.
10430 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
10431 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
10432 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
10433 # if not specified by the users.
10434 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
10435 # interface. Can only be used with network_attachment. It is not possible to
10436 # use on its own however, network_attachment can be used without
10437 # service_class_id.
10438 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
10439 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
10440 #
10441 # This field can be both set at instance creation and update network
10442 # interface operations.
10443 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
10444 # resource is inlegacy
10445 # mode, do not specify this field. If the network is in auto subnet
10446 # mode, specifying the subnetwork is optional. If the network is in custom
10447 # subnet mode, specifying the subnetwork is required. If you specify this
10448 # field, you can specify the subnetwork as a full or partial URL. For
10449 # example, the following are all valid URLs:
10450 #
10451 #
10452 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
10453 # - regions/region/subnetworks/subnetwork
10454 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
10455 # from 2 to 255 inclusively.
10456 },
10457 ],
10458 &quot;networkPerformanceConfig&quot;: {
10459 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
10460 },
10461 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
10462 # as part of resource payload.
10463 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
10464 # Instances.Insert API.
10465 # as a count of seconds and fractions of seconds at nanosecond
10466 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10467 # or &quot;month&quot;. Range is approximately 10,000 years.
10468 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10469 # Durations less than one second are represented with a 0
10470 # `seconds` field and a positive `nanos` field. Must be from 0
10471 # to 999,999,999 inclusive.
10472 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10473 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10474 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10475 },
10476 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
10477 # have the same definition as resource
10478 # manager tags. Keys and values can be either in numeric format,
10479 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
10480 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
10481 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
10482 # PATCH) when empty.
10483 &quot;a_key&quot;: &quot;A String&quot;,
10484 },
10485 },
10486 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
10487 # (namespace) to entries map.
10488 &quot;a_key&quot;: {
10489 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
10490 # It accepts any value including google.protobuf.Struct.
10491 &quot;a_key&quot;: &quot;&quot;,
10492 },
10493 },
10494 },
10495 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
10496 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
10497 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
10498 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
10499 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
10500 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
10501 # Consuming reserved instances for examples.
10502 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
10503 # the name of your reservation as its value.
10504 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
10505 # either a name to a reservation in the same project or
10506 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
10507 # shared reservation in the same zone but in a different project.
10508 &quot;A String&quot;,
10509 ],
10510 },
10511 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
10512 &quot;A String&quot;,
10513 ],
10514 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
10515 # compared to the values requested by user in the corresponding input only
10516 # field.
10517 # Use this sub-message for actual values set on Instance attributes as compared
10518 # to the value requested by the user (intent) in their instance CRUD calls.
10519 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
10520 # zonal instance settings, and instance-level predefined metadata keys to
10521 # provide the overridden value for those metadata keys at the instance level.
10522 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
10523 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
10524 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
10525 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
10526 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
10527 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
10528 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
10529 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
10530 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
10531 },
10532 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
10533 # center, including the block, sub-block, and host. The field is formatted as
10534 # follows: blockId/subBlockId/hostId.
10535 &quot;physicalHostTopology&quot;: { # Represents the physical host topology of the host on which the VM is # Output only. [Output Only] A series of fields containing the global name of the Compute
10536 # Engine cluster, as well as the ID of the block, sub-block, and host on
10537 # which the running instance is located.
10538 # running.
10539 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
10540 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
10541 # example
10542 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
10543 # the location ID of the topologies.
10544 &quot;a_key&quot;: &quot;A String&quot;,
10545 },
10546 },
10547 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
10548 # located. Instances within the same block experience low network latency.
10549 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
10550 # running instance is located.
10551 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
10552 # Instances on the same host experience the lowest possible network
10553 # latency.
10554 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
10555 # located. Instances in the same sub-block experience lower network latency
10556 # than instances in the same block.
10557 },
10558 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
10559 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
10560 # instance is consuming from.
10561 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
10562 # instance is consuming from.
10563 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
10564 # this instance is consuming from.
10565 },
10566 &quot;scheduling&quot;: {
10567 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
10568 # must be a number between 1 and the number of availability domains
10569 # specified in the spread placement policy attached to the instance.
10570 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
10571 },
10572 &quot;shutdownDetails&quot;: { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state.
10573 # programmed stop scheduled.
10574 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
10575 # `stop_state=PENDING_STOP`.
10576 # as a count of seconds and fractions of seconds at nanosecond
10577 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10578 # or &quot;month&quot;. Range is approximately 10,000 years.
10579 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10580 # Durations less than one second are represented with a 0
10581 # `seconds` field and a positive `nanos` field. Must be from 0
10582 # to 999,999,999 inclusive.
10583 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10584 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10585 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10586 },
10587 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
10588 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
10589 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
10590 },
10591 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
10592 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
10593 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
10594 # This timestamp value is in RFC3339 text format.
10595 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
10596 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
10597 &quot;A String&quot;,
10598 ],
10599 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
10600 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
10601 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
10602 # This timestamp value is in RFC3339 text format.
10603 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
10604 # This timestamp value is in RFC3339 text format.
10605 },
10606 },
10607 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
10608 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
10609 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
10610 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
10611 # terminated by Compute Engine (not terminated by a user). You can only set
10612 # the automatic restart option for standard instances.Preemptible instances
10613 # cannot be automatically restarted.
10614 #
10615 # By default, this is set to true so an instance is
10616 # automatically restarted if it is terminated by Compute Engine.
10617 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
10618 # must be a number between 1 and the number of availability domains
10619 # specified in the spread placement policy attached to the instance.
10620 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
10621 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
10622 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the
10623 # graceful shutdown isn&#x27;t complete after this time, then the instance
10624 # transitions to the STOPPING state.
10625 # as a count of seconds and fractions of seconds at nanosecond
10626 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10627 # or &quot;month&quot;. Range is approximately 10,000 years.
10628 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10629 # Durations less than one second are represented with a 0
10630 # `seconds` field and a positive `nanos` field. Must be from 0
10631 # to 999,999,999 inclusive.
10632 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10633 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10634 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10635 },
10636 },
10637 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
10638 # within the range of [90, 330] with the increment of 30, if unset, the
10639 # default behavior of host error recovery will be used.
10640 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
10641 &quot;localSsdRecoveryTimeout&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
10642 # recovery of the Local Ssd state is attempted. Its value should be in
10643 # between 0 and 168 hours with hour granularity and the default value being 1
10644 # hour.
10645 # as a count of seconds and fractions of seconds at nanosecond
10646 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10647 # or &quot;month&quot;. Range is approximately 10,000 years.
10648 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10649 # Durations less than one second are represented with a 0
10650 # `seconds` field and a positive `nanos` field. Must be from 0
10651 # to 999,999,999 inclusive.
10652 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10653 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10654 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10655 },
10656 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
10657 # resources.
10658 # This field is for use by internal tools that use the public API.
10659 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
10660 # be scheduled for maintenance.
10661 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
10662 # are: `PERIODIC`.
10663 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
10664 # the instance termination action will be performed at the end of the run
10665 # duration.
10666 # as a count of seconds and fractions of seconds at nanosecond
10667 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10668 # or &quot;month&quot;. Range is approximately 10,000 years.
10669 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10670 # Durations less than one second are represented with a 0
10671 # `seconds` field and a positive `nanos` field. Must be from 0
10672 # to 999,999,999 inclusive.
10673 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10674 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10675 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10676 },
10677 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
10678 # on a sole-tenant node.
10679 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
10680 # affinity for more information.
10681 # Overrides reservationAffinity.
10682 { # Node Affinity: the configuration of desired nodes onto which this Instance
10683 # could be scheduled.
10684 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
10685 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
10686 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
10687 &quot;A String&quot;,
10688 ],
10689 },
10690 ],
10691 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
10692 # the default behavior is MIGRATE. Forpreemptible instances,
10693 # the default and only possible behavior is TERMINATE. For more
10694 # information, see
10695 # Set
10696 # VM host maintenance policy.
10697 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
10698 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
10699 # else, the Local SSD data will be preserved when the instance is stopped
10700 # at the end of the run duration/termination time.
10701 },
10702 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
10703 # instance creation or while the instance isstopped and
10704 # therefore, in a `TERMINATED` state. SeeInstance Life
10705 # Cycle for more information on the possible instance states.
10706 &quot;preemptionNoticeDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
10707 # Off signal is triggered for Spot
10708 # VMs only. If not specified, there will be no wait before the G2 Soft
10709 # Off signal is triggered.
10710 # as a count of seconds and fractions of seconds at nanosecond
10711 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10712 # or &quot;month&quot;. Range is approximately 10,000 years.
10713 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10714 # Durations less than one second are represented with a 0
10715 # `seconds` field and a positive `nanos` field. Must be from 0
10716 # to 999,999,999 inclusive.
10717 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10718 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10719 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10720 },
10721 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
10722 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
10723 # Off and ACPI G3 Mechanical
10724 # Off for Standard VMs and 30 seconds for Spot VMs.
10725 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
10726 # termination action will be performed at the termination time.
10727 },
10728 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
10729 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
10730 # this instance. Only one service account per VM instance is supported.
10731 #
10732 # Service accounts generate access tokens that can be accessed
10733 # through the metadata server and used to authenticate applications on the
10734 # instance. SeeService Accounts
10735 # for more information.
10736 { # A service account.
10737 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
10738 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
10739 &quot;A String&quot;,
10740 ],
10741 },
10742 ],
10743 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
10744 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
10745 # default.
10746 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
10747 # default.
10748 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
10749 # default.
10750 },
10751 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
10752 # Instance boot integrity is measured.
10753 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
10754 # measurements from the VM instance&#x27;s most recent boot.
10755 },
10756 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
10757 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
10758 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
10759 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
10760 },
10761 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
10762 # VM instance boot integrity is measured.
10763 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
10764 # measurements from the VM instance&#x27;s most recent boot.
10765 },
10766 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
10767 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
10768 # machine image.
10769 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10770 # For example:
10771 #
10772 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10773 # key_region/cryptoKeys/key
10774 #
10775 # The fully-qualifed key name may be returned for resource GET requests. For
10776 # example:
10777 #
10778 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10779 # key_region/cryptoKeys/key
10780 # /cryptoKeyVersions/1
10781 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10782 # key. If absent, the Compute Engine default service account is used.
10783 # For example:
10784 #
10785 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10786 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10787 # encryption key, encoded in RFC
10788 # 4648 base64 to either encrypt or decrypt this resource. You can
10789 # provide either the rawKey or thersaEncryptedKey.
10790 # For example:
10791 #
10792 # &quot;rawKey&quot;:
10793 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10794 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10795 # customer-supplied encryption key to either encrypt or decrypt this
10796 # resource. You can provide either the rawKey or thersaEncryptedKey.
10797 # For example:
10798 #
10799 # &quot;rsaEncryptedKey&quot;:
10800 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10801 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10802 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10803 #
10804 # The key must meet the following requirements before you can provide it to
10805 # Compute Engine:
10806 #
10807 # 1. The key is wrapped using a RSA public key certificate provided by
10808 # Google.
10809 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10810 # encoding.
10811 #
10812 # Gets the RSA public key certificate provided by Google at:
10813 #
10814 #
10815 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10816 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10817 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10818 # encryption key that protects this resource.
10819 },
10820 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
10821 # Engine has detected suspicious activity.
10822 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
10823 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
10824 # instance, see
10825 # Instance life cycle.
10826 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
10827 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
10828 # sources or targets for network firewalls and are specified by the client
10829 # during instance creation. The tags can be later modified by the setTags
10830 # method. Each tag within the list must comply withRFC1035.
10831 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
10832 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
10833 # the tags&#x27; contents and used for optimistic locking. The
10834 # fingerprint is initially generated by Compute Engine and changes after
10835 # every request to modify or update tags. You must always provide an
10836 # up-to-date fingerprint hash in order to update or change tags.
10837 #
10838 # To see the latest fingerprint, make get() request to the
10839 # instance.
10840 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
10841 # with RFC1035.
10842 &quot;A String&quot;,
10843 ],
10844 },
10845 &quot;workloadIdentityConfig&quot;: {
10846 &quot;identity&quot;: &quot;A String&quot;,
10847 &quot;identityCertificateEnabled&quot;: True or False,
10848 },
10849 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
10850 # You must specify this field as part of the HTTP request URL. It is
10851 # not settable as a field in the request body.
10852 }
10853
10854 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
10855 that if you must retry your request, the server will know to ignore the
10856 request if it has already been completed.
10857
10858 For example, consider a situation where you make an initial request and
10859 the request times out. If you make the request again with the same
10860 request ID, the server can check if original operation with the same
10861 request ID was received, and if so, will ignore the second request. This
10862 prevents clients from accidentally creating duplicate commitments.
10863
10864 The request ID must be
10865 a valid UUID with the exception that zero UUID is not supported
10866 (00000000-0000-0000-0000-000000000000).
10867 sourceInstanceTemplate: string, Specifies instance template to create the instance.
10868
10869 This field is optional. It can be a full or partial URL. For example, the
10870 following are all valid URLs to an instance template:
10871
10872
10873 - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
10874 - projects/project/global/instanceTemplates/instanceTemplate
10875 - global/instanceTemplates/instanceTemplate
10876 sourceMachineImage: string, Specifies the machine image to use to create the instance.
10877
10878 This field is optional. It can be a full or partial URL. For example, the
10879 following are all valid URLs to a machine image:
10880
10881
10882 - https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage
10883 - projects/project/global/global/machineImages/machineImage
10884 - global/machineImages/machineImage
10885 x__xgafv: string, V1 error format.
10886 Allowed values
10887 1 - v1 error format
10888 2 - v2 error format
10889
10890 Returns:
10891 An object of the form:
10892
10893 { # Represents an Operation resource.
10894 #
10895 # Google Compute Engine has three Operation resources:
10896 #
10897 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
10898 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
10899 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
10900 #
10901 # You can use an operation resource to manage asynchronous API requests.
10902 # For more information, readHandling
10903 # API responses.
10904 #
10905 # Operations can be global, regional or zonal.
10906 #
10907 # - For global operations, use the `globalOperations`
10908 # resource.
10909 # - For regional operations, use the
10910 # `regionOperations` resource.
10911 # - For zonal operations, use
10912 # the `zoneOperations` resource.
10913 #
10914 #
10915 #
10916 # For more information, read
10917 # Global, Regional, and Zonal Resources.
10918 #
10919 # Note that completed Operation resources have a limited
10920 # retention period.
10921 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
10922 # Not present otherwise.
10923 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
10924 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
10925 # set when the operation is created.
10926 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
10927 # text format.
10928 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
10929 # this field will be populated.
10930 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
10931 # operation.
10932 {
10933 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
10934 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
10935 # details. There is a set of defined message types to use for providing
10936 # details.The syntax depends on the error code. For example,
10937 # QuotaExceededInfo will have details when the error code is
10938 # QUOTA_EXCEEDED.
10939 {
10940 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
10941 #
10942 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
10943 # is not enabled:
10944 #
10945 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
10946 # &quot;domain&quot;: &quot;googleapis.com&quot;
10947 # &quot;metadata&quot;: {
10948 # &quot;resource&quot;: &quot;projects/123&quot;,
10949 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
10950 # }
10951 # }
10952 #
10953 # This response indicates that the pubsub.googleapis.com API is not enabled.
10954 #
10955 # Example of an error that is returned when attempting to create a Spanner
10956 # instance in a region that is out of stock:
10957 #
10958 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
10959 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
10960 # &quot;metadata&quot;: {
10961 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
10962 # }
10963 # }
10964 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
10965 # is typically the registered service name of the tool or product that
10966 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
10967 # generated by some common infrastructure, the error domain must be a
10968 # globally unique value that identifies the infrastructure. For Google API
10969 # infrastructure, the error domain is &quot;googleapis.com&quot;.
10970 &quot;metadatas&quot;: { # Additional structured details about this error.
10971 #
10972 # Keys must match a regular expression of `a-z+` but should
10973 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
10974 # length. When identifying the current value of an exceeded limit, the units
10975 # should be contained in the key, not the value. For example, rather than
10976 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
10977 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
10978 # instances that can be created in a single (batch) request.
10979 &quot;a_key&quot;: &quot;A String&quot;,
10980 },
10981 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
10982 # proximate cause of the error. Error reasons are unique within a particular
10983 # domain of errors. This should be at most 63 characters and match a
10984 # regular expression of `A-Z+[A-Z0-9]`, which represents
10985 # UPPER_SNAKE_CASE.
10986 },
10987 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
10988 #
10989 # For example, if a quota check failed with an error indicating the calling
10990 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
10991 # directly to the right place in the developer console to flip the bit.
10992 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
10993 { # Describes a URL link.
10994 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
10995 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
10996 },
10997 ],
10998 },
10999 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
11000 # which can be attached to an RPC error.
11001 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
11002 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
11003 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
11004 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
11005 },
11006 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
11007 &quot;dimensions&quot;: { # The map holding related quota dimensions.
11008 &quot;a_key&quot;: &quot;A String&quot;,
11009 },
11010 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
11011 # type or metric.
11012 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
11013 # or metric.
11014 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
11015 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
11016 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
11017 },
11018 },
11019 ],
11020 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
11021 # This property is optional.
11022 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
11023 },
11024 ],
11025 },
11026 &quot;getVersionOperationMetadata&quot;: {
11027 &quot;inlineSbomInfo&quot;: {
11028 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
11029 # appropriate identifiers.
11030 &quot;a_key&quot;: &quot;A String&quot;,
11031 },
11032 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
11033 # identifiers.
11034 &quot;a_key&quot;: &quot;A String&quot;,
11035 },
11036 },
11037 },
11038 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
11039 # message that was returned, such as `NOT FOUND`.
11040 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
11041 # status code that was returned. For example, a `404` means the
11042 # resource was not found.
11043 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
11044 # defined by the server.
11045 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
11046 # This value is inRFC3339
11047 # text format.
11048 &quot;instancesBulkInsertOperationMetadata&quot;: {
11049 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
11050 # Example key: zones/us-central1-a
11051 &quot;a_key&quot;: {
11052 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
11053 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
11054 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
11055 # error.
11056 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
11057 # if the flow is rolling forward or rolling back.
11058 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
11059 },
11060 },
11061 },
11062 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
11063 # Operation resources.
11064 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
11065 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
11066 # group of operations results from a `bulkInsert` API request.
11067 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
11068 # `update`, or `delete`, and so on.
11069 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
11070 # There is no requirement that this be linear or support any granularity of
11071 # operations. This should not be used to guess when the operation will be
11072 # complete. This number should monotonically increase as the operation
11073 # progresses.
11074 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
11075 # applicable when performing regional operations.
11076 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11077 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
11078 # this field will contain information on all underlying zonal actions and
11079 # their state.
11080 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
11081 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
11082 # Example key: zones/us-central1-a
11083 &quot;a_key&quot;: {
11084 &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
11085 # populated.
11086 # different programming environments, including REST APIs and RPC APIs. It is
11087 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
11088 # three pieces of data: error code, error message, and error details.
11089 #
11090 # You can find out more about this error model and how to work with it in the
11091 # [API Design Guide](https://cloud.google.com/apis/design/errors).
11092 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
11093 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
11094 # message types for APIs to use.
11095 {
11096 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
11097 },
11098 ],
11099 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
11100 # user-facing error message should be localized and sent in the
11101 # google.rpc.Status.details field, or localized by the client.
11102 },
11103 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
11104 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
11105 },
11106 },
11107 },
11108 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
11109 # This value is inRFC3339
11110 # text format.
11111 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
11112 # following:
11113 # `PENDING`, `RUNNING`, or `DONE`.
11114 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
11115 # operation.
11116 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
11117 # of the target resource.
11118 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
11119 # operations related to creating a snapshot, this points to the disk
11120 # that the snapshot was created from.
11121 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
11122 # `[email protected]` or
11123 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
11124 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
11125 # operation, this field will be populated.
11126 {
11127 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11128 # Engine returns NO_RESULTS_ON_PAGE if there
11129 # are no results in the response.
11130 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11131 # value format. For example:
11132 #
11133 # &quot;data&quot;: [
11134 # {
11135 # &quot;key&quot;: &quot;scope&quot;,
11136 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11137 # }
11138 {
11139 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11140 # returned. For example, for warnings where there are no results in a list
11141 # request for a particular zone, this key might be scope and
11142 # the key value might be the zone name. Other examples might be a key
11143 # indicating a deprecated resource and a suggested replacement, or a
11144 # warning about invalid network settings (for example, if an instance
11145 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11146 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11147 },
11148 ],
11149 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11150 },
11151 ],
11152 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
11153 # applicable when performing per-zone operations.
11154 }</pre>
11155 </div>
11156
11157 <div class="method">
11158 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)</code>
11159 <pre>Retrieves the list of instances contained within
11160 the specified zone.
11161
11162 Args:
11163 project: string, Project ID for this request. (required)
11164 zone: string, The name of the zone for this request. (required)
11165 filter: string, A filter expression that filters resources listed in the response. Most
11166 Compute resources support two types of filter expressions:
11167 expressions that support regular expressions and expressions that follow
11168 API improvement proposal AIP-160.
11169 These two types of filter expressions cannot be mixed in one request.
11170
11171 If you want to use AIP-160, your expression must specify the field name, an
11172 operator, and the value that you want to use for filtering. The value
11173 must be a string, a number, or a boolean. The operator
11174 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
11175
11176 For example, if you are filtering Compute Engine instances, you can
11177 exclude instances named `example-instance` by specifying
11178 `name != example-instance`.
11179
11180 The `:*` comparison can be used to test whether a key has been defined.
11181 For example, to find all objects with `owner` label use:
11182 ```
11183 labels.owner:*
11184 ```
11185
11186 You can also filter nested fields. For example, you could specify
11187 `scheduling.automaticRestart = false` to include instances only
11188 if they are not scheduled for automatic restarts. You can use filtering
11189 on nested fields to filter based onresource labels.
11190
11191 To filter on multiple expressions, provide each separate expression within
11192 parentheses. For example:
11193 ```
11194 (scheduling.automaticRestart = true)
11195 (cpuPlatform = &quot;Intel Skylake&quot;)
11196 ```
11197 By default, each expression is an `AND` expression. However, you
11198 can include `AND` and `OR` expressions explicitly.
11199 For example:
11200 ```
11201 (cpuPlatform = &quot;Intel Skylake&quot;) OR
11202 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
11203 (scheduling.automaticRestart = true)
11204 ```
11205
11206 If you want to use a regular expression, use the `eq` (equal) or `ne`
11207 (not equal) operator against a single un-parenthesized expression with or
11208 without quotes or against multiple parenthesized expressions. Examples:
11209
11210 `fieldname eq unquoted literal`
11211 `fieldname eq &#x27;single quoted literal&#x27;`
11212 `fieldname eq &quot;double quoted literal&quot;`
11213 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
11214
11215 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
11216 The literal value must match the entire field.
11217
11218 For example, to filter for instances that do not end with name &quot;instance&quot;,
11219 you would use `name ne .*instance`.
11220
11221 You cannot combine constraints on multiple fields using regular
11222 expressions.
11223 maxResults: integer, The maximum number of results per page that should be returned.
11224 If the number of available results is larger than `maxResults`,
11225 Compute Engine returns a `nextPageToken` that can be used to get
11226 the next page of results in subsequent list requests. Acceptable values are
11227 `0` to `500`, inclusive. (Default: `500`)
11228 orderBy: string, Sorts list results by a certain order. By default, results
11229 are returned in alphanumerical order based on the resource name.
11230
11231 You can also sort results in descending order based on the creation
11232 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
11233 results based on the `creationTimestamp` field in
11234 reverse chronological order (newest result first). Use this to sort
11235 resources like operations so that the newest operation is returned first.
11236
11237 Currently, only sorting by `name` or
11238 `creationTimestamp desc` is supported.
11239 pageToken: string, Specifies a page token to use. Set `pageToken` to the
11240 `nextPageToken` returned by a previous list request to get
11241 the next page of results.
11242 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
11243 of failure. The default value is false.
11244
11245 For example, when partial success behavior is enabled, aggregatedList for a
11246 single zone scope either returns all resources in the zone or no resources,
11247 with an error code.
11248 view: string, View of the instance.
11249 Allowed values
11250 BASIC - Include everything except Partner Metadata.
11251 FULL - Include everything.
11252 INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
11253 x__xgafv: string, V1 error format.
11254 Allowed values
11255 1 - v1 error format
11256 2 - v2 error format
11257
11258 Returns:
11259 An object of the form:
11260
11261 { # Contains a list of instances.
11262 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
11263 &quot;items&quot;: [ # A list of Instance resources.
11264 { # Represents an Instance resource.
11265 #
11266 # An instance is a virtual machine that is hosted on Google Cloud Platform.
11267 # For more information, readVirtual Machine Instances.
11268 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
11269 # Options that would traditionally be configured in a BIOS belong
11270 # here. Features that require operating system support may have
11271 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
11272 # disabled).
11273 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
11274 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
11275 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
11276 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
11277 # multithreading (SMT) set this to 1. If unset, the maximum number
11278 # of threads supported per core by the underlying processor is
11279 # assumed.
11280 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
11281 # Supported modes include:
11282 # * ALL_CORE_MAX
11283 #
11284 # Using empty string or not setting this field will use the platform-specific
11285 # default turbo mode.
11286 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
11287 # the number of threads per core to compute the total number of virtual
11288 # CPUs to expose to the instance. If unset, the number of cores is
11289 # inferred from the instance&#x27;s nominal CPU count and the underlying
11290 # platform&#x27;s SMT width.
11291 },
11292 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
11293 # destination or source IPs. This is required if you plan to use this
11294 # instance to forward routes. For more information, seeEnabling IP Forwarding.
11295 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
11296 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
11297 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
11298 },
11299 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
11300 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
11301 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
11302 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
11303 # create the resource.
11304 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
11305 # created before you can assign them.
11306 { # An instance-attached disk resource.
11307 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
11308 # or X86_64.
11309 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
11310 # deleted (but not when the disk is detached from the instance).
11311 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
11312 # partition of the disk for its root filesystem.
11313 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
11314 # running within the instance. This name can be used to reference the device
11315 # for mounting, resizing, and so on, from within the instance.
11316 #
11317 # If not specified, the server chooses a default device name to apply to this
11318 # disk, in the form persistent-disk-x, where x is a number
11319 # assigned by Google Compute Engine. This field is only applicable for
11320 # persistent disks.
11321 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
11322 # encryption key.
11323 #
11324 # If you are creating a new disk, this field encrypts the new disk using
11325 # an encryption key that you provide. If you are attaching an existing
11326 # disk that is already encrypted, this field decrypts the disk using
11327 # the customer-supplied encryption key.
11328 #
11329 # If you encrypt a disk using a customer-supplied key, you must provide the
11330 # same key again when you attempt to use this resource at a later time. For
11331 # example, you must provide the key when you create a snapshot or an image
11332 # from the disk or when you attach the disk to a virtual machine instance.
11333 #
11334 # If you do not provide an encryption key, then the disk will be encrypted
11335 # using an automatically generated key and you do not need to provide a key
11336 # to use the disk later.
11337 #
11338 # Note:
11339 #
11340 # Instance templates do not storecustomer-supplied
11341 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
11342 #
11343 # You cannot create VMs that have disks with customer-supplied keys using
11344 # the bulk
11345 # insert method.
11346 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
11347 # For example:
11348 #
11349 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11350 # key_region/cryptoKeys/key
11351 #
11352 # The fully-qualifed key name may be returned for resource GET requests. For
11353 # example:
11354 #
11355 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11356 # key_region/cryptoKeys/key
11357 # /cryptoKeyVersions/1
11358 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
11359 # key. If absent, the Compute Engine default service account is used.
11360 # For example:
11361 #
11362 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
11363 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
11364 # encryption key, encoded in RFC
11365 # 4648 base64 to either encrypt or decrypt this resource. You can
11366 # provide either the rawKey or thersaEncryptedKey.
11367 # For example:
11368 #
11369 # &quot;rawKey&quot;:
11370 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
11371 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
11372 # customer-supplied encryption key to either encrypt or decrypt this
11373 # resource. You can provide either the rawKey or thersaEncryptedKey.
11374 # For example:
11375 #
11376 # &quot;rsaEncryptedKey&quot;:
11377 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
11378 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
11379 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
11380 #
11381 # The key must meet the following requirements before you can provide it to
11382 # Compute Engine:
11383 #
11384 # 1. The key is wrapped using a RSA public key certificate provided by
11385 # Google.
11386 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
11387 # encoding.
11388 #
11389 # Gets the RSA public key certificate provided by Google at:
11390 #
11391 #
11392 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
11393 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
11394 # 4648 base64 encoded SHA-256 hash of the customer-supplied
11395 # encryption key that protects this resource.
11396 },
11397 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
11398 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
11399 # currently attached to another instance. If you try to force attach a zonal
11400 # disk to an instance, you will receive an error.
11401 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
11402 # only for bootable images. Read
11403 # Enabling guest operating system features to see a list of available
11404 # options.
11405 { # Guest OS features.
11406 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
11407 # separate values. Set to one or more of the following values:
11408 #
11409 # - VIRTIO_SCSI_MULTIQUEUE
11410 # - WINDOWS
11411 # - MULTI_IP_SUBNET
11412 # - UEFI_COMPATIBLE
11413 # - GVNIC
11414 # - SEV_CAPABLE
11415 # - SUSPEND_RESUME_COMPATIBLE
11416 # - SEV_LIVE_MIGRATABLE_V2
11417 # - SEV_SNP_CAPABLE
11418 # - TDX_CAPABLE
11419 # - IDPF
11420 # - SNP_SVSM_CAPABLE
11421 # - CCA_CAPABLE
11422 #
11423 #
11424 # For more information, see
11425 # Enabling guest operating system features.
11426 },
11427 ],
11428 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
11429 # boot disk. If you have many disks attached to an instance, each
11430 # disk would have a unique index number.
11431 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
11432 # alongside the new instance. Use initialization parameters to create boot
11433 # disks or local SSDs attached to the new instance.
11434 #
11435 # This property is mutually exclusive with the source property;
11436 # you can only define one or the other, but not both.
11437 # alongside the new instance. Use initialization parameters to create boot
11438 # disks or local SSDs attached to the new instance.
11439 #
11440 # This field is persisted and returned for instanceTemplate and not returned
11441 # in the context of instance.
11442 #
11443 # This property is mutually exclusive with the source property;
11444 # you can only define one or the other, but not both.
11445 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
11446 # arm64 or x86_64.
11447 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
11448 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
11449 # of the instance. If a disk with the same name already exists in the given
11450 # region, the existing disk is attached to the new instance and the
11451 # new disk is not created.
11452 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
11453 # 10 GB. If you specify a sourceImage, which is required for
11454 # boot disks, the default size is the size of the sourceImage.
11455 # If you do not specify a sourceImage, the default disk size
11456 # is 500 GB.
11457 &quot;diskType&quot;: &quot;A String&quot;,
11458 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
11459 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
11460 # only for bootable images. Read
11461 # Enabling guest operating system features to see a list of available
11462 # options.
11463 #
11464 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
11465 { # Guest OS features.
11466 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
11467 # separate values. Set to one or more of the following values:
11468 #
11469 # - VIRTIO_SCSI_MULTIQUEUE
11470 # - WINDOWS
11471 # - MULTI_IP_SUBNET
11472 # - UEFI_COMPATIBLE
11473 # - GVNIC
11474 # - SEV_CAPABLE
11475 # - SUSPEND_RESUME_COMPATIBLE
11476 # - SEV_LIVE_MIGRATABLE_V2
11477 # - SEV_SNP_CAPABLE
11478 # - TDX_CAPABLE
11479 # - IDPF
11480 # - SNP_SVSM_CAPABLE
11481 # - CCA_CAPABLE
11482 #
11483 #
11484 # For more information, see
11485 # Enabling guest operating system features.
11486 },
11487 ],
11488 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
11489 # persistent disks.
11490 &quot;a_key&quot;: &quot;A String&quot;,
11491 },
11492 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
11493 &quot;A String&quot;,
11494 ],
11495 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
11496 # more than one instance.
11497 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
11498 # is to use the existing disk.
11499 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
11500 # of I/O operations per second that the disk can handle. Values must be
11501 # between 10,000 and 120,000. For more details, see theExtreme persistent
11502 # disk documentation.
11503 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
11504 # number of throughput mb per second that the disk can handle. Values must
11505 # greater than or equal to 1.
11506 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
11507 # the URLs of the zones where the disk should be replicated to.
11508 # You must provide exactly two replica zones, and one zone must be the same
11509 # as the instance zone.
11510 &quot;A String&quot;,
11511 ],
11512 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
11513 # have the same definition as resource
11514 # manager tags. Keys and values can be either in numeric format,
11515 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
11516 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
11517 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
11518 # empty.
11519 &quot;a_key&quot;: &quot;A String&quot;,
11520 },
11521 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
11522 # Specified using the full or partial URL. For instance template, specify
11523 # only the resource policy name.
11524 &quot;A String&quot;,
11525 ],
11526 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
11527 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
11528 # is required.
11529 #
11530 # To create a disk with one of the public operating system
11531 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
11532 #
11533 # projects/debian-cloud/global/images/family/debian-9
11534 #
11535 #
11536 # Alternatively, use a specific version of a public operating system image:
11537 #
11538 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
11539 #
11540 #
11541 # To create a disk with a custom image that you created, specify the
11542 # image name in the following format:
11543 #
11544 # global/images/my-custom-image
11545 #
11546 #
11547 # You can also specify a custom image by its image family, which returns
11548 # the latest version of the image in that family. Replace the image name
11549 # with family/family-name:
11550 #
11551 # global/images/family/my-image-family
11552 #
11553 #
11554 # If the source image is deleted later, this field will not be set.
11555 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
11556 # encryption key of the source image. Required if the source image is
11557 # protected by a customer-supplied encryption key.
11558 #
11559 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
11560 # encryption keys, so you cannot create disks for instances in a managed instance group if the
11561 # source images are encrypted with your own keys.
11562 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
11563 # For example:
11564 #
11565 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11566 # key_region/cryptoKeys/key
11567 #
11568 # The fully-qualifed key name may be returned for resource GET requests. For
11569 # example:
11570 #
11571 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11572 # key_region/cryptoKeys/key
11573 # /cryptoKeyVersions/1
11574 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
11575 # key. If absent, the Compute Engine default service account is used.
11576 # For example:
11577 #
11578 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
11579 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
11580 # encryption key, encoded in RFC
11581 # 4648 base64 to either encrypt or decrypt this resource. You can
11582 # provide either the rawKey or thersaEncryptedKey.
11583 # For example:
11584 #
11585 # &quot;rawKey&quot;:
11586 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
11587 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
11588 # customer-supplied encryption key to either encrypt or decrypt this
11589 # resource. You can provide either the rawKey or thersaEncryptedKey.
11590 # For example:
11591 #
11592 # &quot;rsaEncryptedKey&quot;:
11593 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
11594 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
11595 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
11596 #
11597 # The key must meet the following requirements before you can provide it to
11598 # Compute Engine:
11599 #
11600 # 1. The key is wrapped using a RSA public key certificate provided by
11601 # Google.
11602 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
11603 # encoding.
11604 #
11605 # Gets the RSA public key certificate provided by Google at:
11606 #
11607 #
11608 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
11609 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
11610 # 4648 base64 encoded SHA-256 hash of the customer-supplied
11611 # encryption key that protects this resource.
11612 },
11613 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
11614 # instance boot disk, one of initializeParams.sourceSnapshot
11615 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
11616 # is required.
11617 #
11618 # To create a disk with a snapshot that you created, specify the
11619 # snapshot name in the following format:
11620 #
11621 # us-central1-a/instantSnapshots/my-backup
11622 #
11623 #
11624 # If the source instant-snapshot is deleted later, this field will not be
11625 # set.
11626 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
11627 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
11628 # is required.
11629 #
11630 # To create a disk with a snapshot that you created, specify the
11631 # snapshot name in the following format:
11632 #
11633 # global/snapshots/my-backup
11634 #
11635 #
11636 # If the source snapshot is deleted later, this field will not be set.
11637 #
11638 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
11639 # an image instead when you create VMs using
11640 # the bulk
11641 # insert method.
11642 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
11643 # encryption key of the source snapshot.
11644 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
11645 # For example:
11646 #
11647 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11648 # key_region/cryptoKeys/key
11649 #
11650 # The fully-qualifed key name may be returned for resource GET requests. For
11651 # example:
11652 #
11653 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11654 # key_region/cryptoKeys/key
11655 # /cryptoKeyVersions/1
11656 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
11657 # key. If absent, the Compute Engine default service account is used.
11658 # For example:
11659 #
11660 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
11661 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
11662 # encryption key, encoded in RFC
11663 # 4648 base64 to either encrypt or decrypt this resource. You can
11664 # provide either the rawKey or thersaEncryptedKey.
11665 # For example:
11666 #
11667 # &quot;rawKey&quot;:
11668 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
11669 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
11670 # customer-supplied encryption key to either encrypt or decrypt this
11671 # resource. You can provide either the rawKey or thersaEncryptedKey.
11672 # For example:
11673 #
11674 # &quot;rsaEncryptedKey&quot;:
11675 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
11676 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
11677 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
11678 #
11679 # The key must meet the following requirements before you can provide it to
11680 # Compute Engine:
11681 #
11682 # 1. The key is wrapped using a RSA public key certificate provided by
11683 # Google.
11684 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
11685 # encoding.
11686 #
11687 # Gets the RSA public key certificate provided by Google at:
11688 #
11689 #
11690 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
11691 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
11692 # 4648 base64 encoded SHA-256 hash of the customer-supplied
11693 # encryption key that protects this resource.
11694 },
11695 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
11696 # this as a partial or full URL to the resource. For example, the following
11697 # are valid values:
11698 #
11699 #
11700 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
11701 # - projects/project/zones/zone/storagePools/storagePool
11702 # - zones/zone/storagePools/storagePool
11703 },
11704 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
11705 # either SCSI or NVME. For most machine types, the
11706 # default is SCSI. Local SSDs can use either NVME or SCSI.
11707 # In certain configurations, persistent disks can use NVMe. For more
11708 # information, seeAbout
11709 # persistent disks.
11710 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
11711 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
11712 &quot;A String&quot;,
11713 ],
11714 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
11715 # disk is not allowed to be detached from the instance, or to be used as the
11716 # source of the snapshot creation, and the image creation. The instance with
11717 # at least one locked attached disk is not allow to be used as source of
11718 # machine image creation, instant snapshot creation, and not allowed to be
11719 # deleted with --keep-disk parameter set to true for locked disks.
11720 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
11721 # in READ_WRITE mode.
11722 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
11723 # field is set to PRESERVED if the LocalSSD data has been saved
11724 # to a persistent location by customer request. (see the
11725 # discard_local_ssd option on Stop/Suspend).
11726 # Read-only in the api.
11727 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
11728 # these are public keys which are safe to store in public
11729 &quot;dbs&quot;: [ # The Key Database (db).
11730 {
11731 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
11732 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
11733 },
11734 ],
11735 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
11736 {
11737 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
11738 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
11739 },
11740 ],
11741 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
11742 {
11743 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
11744 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
11745 },
11746 ],
11747 &quot;pk&quot;: { # The Platform Key (PK).
11748 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
11749 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
11750 },
11751 },
11752 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
11753 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
11754 # is required.
11755 #
11756 # If desired, you can also attach existing non-root persistent disks using
11757 # this property. This field is only applicable for persistent disks.
11758 #
11759 # Note that for InstanceTemplate, specify the disk name for zonal disk,
11760 # and the URL for regional disk.
11761 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
11762 },
11763 ],
11764 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
11765 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
11766 },
11767 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
11768 # machine image should erase Windows specific VSS signature.
11769 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
11770 # the instance&#x27;s contents and used for optimistic locking. The
11771 # fingerprint is initially generated by Compute Engine and changes after
11772 # every request to modify or update the instance. You must always provide an
11773 # up-to-date fingerprint hash in order to update the instance.
11774 #
11775 # To see the latest fingerprint, make get() request to the
11776 # instance.
11777 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
11778 { # A specification of the type and number of accelerator cards attached to the
11779 # instance.
11780 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
11781 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
11782 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
11783 # If you are creating an instance template, specify only the
11784 # accelerator name.
11785 # See GPUs on Compute Engine
11786 # for a full list of accelerator types.
11787 },
11788 ],
11789 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
11790 # RFC1035 compliant. If hostname is not specified, the default hostname is
11791 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
11792 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
11793 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
11794 # defined by the server.
11795 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
11796 # encryption key.
11797 #
11798 # If you are creating a new instance, this field will encrypt the local SSD
11799 # and in-memory contents of the instance during the suspend operation.
11800 #
11801 # If you do not provide an encryption key when creating the instance, then
11802 # the local SSD and in-memory contents will be encrypted using
11803 # an automatically generated key during the suspend operation.
11804 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
11805 # For example:
11806 #
11807 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11808 # key_region/cryptoKeys/key
11809 #
11810 # The fully-qualifed key name may be returned for resource GET requests. For
11811 # example:
11812 #
11813 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11814 # key_region/cryptoKeys/key
11815 # /cryptoKeyVersions/1
11816 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
11817 # key. If absent, the Compute Engine default service account is used.
11818 # For example:
11819 #
11820 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
11821 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
11822 # encryption key, encoded in RFC
11823 # 4648 base64 to either encrypt or decrypt this resource. You can
11824 # provide either the rawKey or thersaEncryptedKey.
11825 # For example:
11826 #
11827 # &quot;rawKey&quot;:
11828 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
11829 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
11830 # customer-supplied encryption key to either encrypt or decrypt this
11831 # resource. You can provide either the rawKey or thersaEncryptedKey.
11832 # For example:
11833 #
11834 # &quot;rsaEncryptedKey&quot;:
11835 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
11836 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
11837 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
11838 #
11839 # The key must meet the following requirements before you can provide it to
11840 # Compute Engine:
11841 #
11842 # 1. The key is wrapped using a RSA public key certificate provided by
11843 # Google.
11844 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
11845 # encoding.
11846 #
11847 # Gets the RSA public key certificate provided by Google at:
11848 #
11849 #
11850 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
11851 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
11852 # 4648 base64 encoded SHA-256 hash of the customer-supplied
11853 # encryption key that protects this resource.
11854 },
11855 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
11856 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
11857 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
11858 # for instances.
11859 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
11860 # the label&#x27;s contents and used for optimistic locking. The
11861 # fingerprint is initially generated by Compute Engine and changes after
11862 # every request to modify or update labels. You must always provide an
11863 # up-to-date fingerprint hash in order to update or change labels.
11864 #
11865 # To see the latest fingerprint, make get() request to the
11866 # instance.
11867 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
11868 # the setLabels method.
11869 &quot;a_key&quot;: &quot;A String&quot;,
11870 },
11871 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
11872 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
11873 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
11874 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
11875 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
11876 # when the instance is created. For example, the following is a valid partial
11877 # url to a predefined
11878 # machine type:
11879 #
11880 # zones/us-central1-f/machineTypes/n1-standard-1
11881 #
11882 #
11883 # To create acustom
11884 # machine type, provide a URL to a machine type in the following format,
11885 # where CPUS is 1 or an even number up to 32 (2,
11886 # 4, 6, ... 24, etc), and MEMORY is the total
11887 # memory for this instance. Memory must be a multiple of 256 MB and must
11888 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
11889 #
11890 # zones/zone/machineTypes/custom-CPUS-MEMORY
11891 #
11892 #
11893 # For example: zones/us-central1-f/machineTypes/custom-4-5120
11894 # For a full list of restrictions, read theSpecifications
11895 # for custom machine types.
11896 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
11897 # to this instance. This includes metadata keys that were explicitly defined
11898 # for the instance.
11899 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
11900 # the metadata&#x27;s contents and used for optimistic locking. The
11901 # fingerprint is initially generated by Compute Engine and changes after
11902 # every request to modify or update metadata. You must always provide an
11903 # up-to-date fingerprint hash in order to update or change metadata,
11904 # otherwise the request will fail with error412 conditionNotMet.
11905 #
11906 # To see the latest fingerprint, make a get() request to
11907 # retrieve the resource.
11908 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
11909 # less than 512 KB.
11910 { # Metadata
11911 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
11912 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
11913 # This is reflected as part of a URL in the metadata server. Additionally, to
11914 # avoid ambiguity, keys must not conflict with any other metadata keys
11915 # for the project.
11916 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
11917 # have meaning as interpreted by the image running in the instance. The
11918 # only restriction placed on values is that their size must be less than
11919 # or equal to 262144 bytes (256 KiB).
11920 },
11921 ],
11922 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
11923 # for metadata.
11924 },
11925 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
11926 # platform for the VM instance. Applicable values are the friendly names
11927 # of CPU platforms, such as minCpuPlatform: &quot;Intel
11928 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
11929 # Bridge&quot;.
11930 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
11931 # the resource. The resource name must be 1-63 characters long, and comply
11932 # withRFC1035.
11933 # Specifically, the name must be 1-63 characters long and match the regular
11934 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
11935 # character must be a lowercase letter, and all following characters must be
11936 # a dash, lowercase letter, or digit, except the last character, which cannot
11937 # be a dash.
11938 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
11939 # interfaces are configured to interact with other network services, such as
11940 # connecting to the internet. Multiple interfaces are supported
11941 # per instance.
11942 { # A network interface resource attached to an instance.
11943 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
11944 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
11945 # no external internet access.
11946 { # An access configuration attached to an instance&#x27;s network interface.
11947 # Only one access config per instance is supported.
11948 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
11949 # The first IPv6 address of the external IPv6 range associated
11950 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
11951 # use a static external IP address, it must be unused and in the same region
11952 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
11953 # assign an external IPv6 address from the instance&#x27;s subnetwork.
11954 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
11955 # external IPv6 range.
11956 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
11957 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
11958 # (IPv4), the default and recommended name is External NAT, but
11959 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
11960 # recommend name is External IPv6.
11961 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
11962 # address associated with this instance. Specify an unused static
11963 # external IP address available to the project or leave this field undefined
11964 # to use an IP from a shared ephemeral IP address pool. If you specify a
11965 # static external IP address, it must live in the same region as the zone of
11966 # the instance.
11967 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
11968 # configuration and can only take the following values: PREMIUM,STANDARD.
11969 #
11970 # If an AccessConfig is specified without a valid external IP address, an
11971 # ephemeral IP will be created with this networkTier.
11972 #
11973 # If an AccessConfig with a valid external IP address is specified, it must
11974 # match that of the networkTier associated with the Address resource owning
11975 # that IP.
11976 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
11977 #
11978 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
11979 # first IP in associated external IPv6 range.
11980 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
11981 # config.
11982 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
11983 # external IP address of the instance to a DNS domain name.
11984 #
11985 # This field is not used in ipv6AccessConfig. A default PTR
11986 # record will be created if the VM has external IPv6 range associated.
11987 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
11988 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
11989 },
11990 ],
11991 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
11992 # You can only specify this field for network interfaces in VPC networks.
11993 { # An alias IP range attached to an instance&#x27;s network interface.
11994 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
11995 # must belong to the specified subnetwork and cannot contain IP addresses
11996 # reserved by system or used by other network interfaces. This range may be
11997 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
11998 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
11999 # alias range. If not specified, the primary range of the subnetwork is used.
12000 },
12001 ],
12002 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
12003 # You can only specify this field for network interfaces in VPC networks.
12004 { # An alias IP range attached to an instance&#x27;s network interface.
12005 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
12006 # must belong to the specified subnetwork and cannot contain IP addresses
12007 # reserved by system or used by other network interfaces. This range may be
12008 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
12009 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
12010 # alias range. If not specified, the primary range of the subnetwork is used.
12011 },
12012 ],
12013 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
12014 # with network_attachment.
12015 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
12016 # This field will be ignored when inserting an Instance or
12017 # adding a NetworkInterface. An up-to-date
12018 # fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
12019 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
12020 # or not. If enabled, also indicates the version of IGMP supported.
12021 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
12022 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
12023 # one IPv6 access config, DIRECT_IPV6, is supported. If there
12024 # is no ipv6AccessConfig specified, then this instance will
12025 # have no external IPv6 Internet access.
12026 { # An access configuration attached to an instance&#x27;s network interface.
12027 # Only one access config per instance is supported.
12028 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
12029 # The first IPv6 address of the external IPv6 range associated
12030 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
12031 # use a static external IP address, it must be unused and in the same region
12032 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
12033 # assign an external IPv6 address from the instance&#x27;s subnetwork.
12034 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
12035 # external IPv6 range.
12036 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
12037 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
12038 # (IPv4), the default and recommended name is External NAT, but
12039 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
12040 # recommend name is External IPv6.
12041 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
12042 # address associated with this instance. Specify an unused static
12043 # external IP address available to the project or leave this field undefined
12044 # to use an IP from a shared ephemeral IP address pool. If you specify a
12045 # static external IP address, it must live in the same region as the zone of
12046 # the instance.
12047 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
12048 # configuration and can only take the following values: PREMIUM,STANDARD.
12049 #
12050 # If an AccessConfig is specified without a valid external IP address, an
12051 # ephemeral IP will be created with this networkTier.
12052 #
12053 # If an AccessConfig with a valid external IP address is specified, it must
12054 # match that of the networkTier associated with the Address resource owning
12055 # that IP.
12056 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
12057 #
12058 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
12059 # first IP in associated external IPv6 range.
12060 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
12061 # config.
12062 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
12063 # external IP address of the instance to a DNS domain name.
12064 #
12065 # This field is not used in ipv6AccessConfig. A default PTR
12066 # record will be created if the VM has external IPv6 range associated.
12067 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
12068 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
12069 },
12070 ],
12071 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
12072 # accessed from the Internet. This field is always inherited from its
12073 # subnetwork.
12074 #
12075 # Valid only if stackType is IPV4_IPV6.
12076 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
12077 # use a static internal IP address, it must be unused and in the same region
12078 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
12079 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
12080 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
12081 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
12082 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
12083 # server. For a VM, the network interface uses the nicN naming
12084 # format. Where N is a value between 0 and7. The default interface value is nic0.
12085 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
12086 # instance, if neither the network nor the subnetwork is specified, the
12087 # default network global/networks/default is used. If the
12088 # selected project doesn&#x27;t have the default network, you must specify a
12089 # network or subnet. If the network is not specified but the subnetwork is
12090 # specified, the network is inferred.
12091 #
12092 # If you specify this property, you can specify the network as
12093 # a full or partial URL. For example, the following are all valid URLs:
12094 #
12095 #
12096 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
12097 # - projects/project/global/networks/network
12098 # - global/networks/default
12099 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
12100 # to in the following format:
12101 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
12102 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
12103 # interface. If not specified by the user, an unused internal IP is
12104 # assigned by the system.
12105 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
12106 # VirtioNet.
12107 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
12108 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
12109 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
12110 # if not specified by the users.
12111 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
12112 # interface. Can only be used with network_attachment. It is not possible to
12113 # use on its own however, network_attachment can be used without
12114 # service_class_id.
12115 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
12116 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
12117 #
12118 # This field can be both set at instance creation and update network
12119 # interface operations.
12120 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
12121 # resource is inlegacy
12122 # mode, do not specify this field. If the network is in auto subnet
12123 # mode, specifying the subnetwork is optional. If the network is in custom
12124 # subnet mode, specifying the subnetwork is required. If you specify this
12125 # field, you can specify the subnetwork as a full or partial URL. For
12126 # example, the following are all valid URLs:
12127 #
12128 #
12129 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
12130 # - regions/region/subnetworks/subnetwork
12131 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
12132 # from 2 to 255 inclusively.
12133 },
12134 ],
12135 &quot;networkPerformanceConfig&quot;: {
12136 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
12137 },
12138 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
12139 # as part of resource payload.
12140 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
12141 # Instances.Insert API.
12142 # as a count of seconds and fractions of seconds at nanosecond
12143 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12144 # or &quot;month&quot;. Range is approximately 10,000 years.
12145 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12146 # Durations less than one second are represented with a 0
12147 # `seconds` field and a positive `nanos` field. Must be from 0
12148 # to 999,999,999 inclusive.
12149 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12150 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12151 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12152 },
12153 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
12154 # have the same definition as resource
12155 # manager tags. Keys and values can be either in numeric format,
12156 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
12157 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
12158 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
12159 # PATCH) when empty.
12160 &quot;a_key&quot;: &quot;A String&quot;,
12161 },
12162 },
12163 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
12164 # (namespace) to entries map.
12165 &quot;a_key&quot;: {
12166 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
12167 # It accepts any value including google.protobuf.Struct.
12168 &quot;a_key&quot;: &quot;&quot;,
12169 },
12170 },
12171 },
12172 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
12173 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
12174 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
12175 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
12176 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
12177 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
12178 # Consuming reserved instances for examples.
12179 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
12180 # the name of your reservation as its value.
12181 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
12182 # either a name to a reservation in the same project or
12183 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
12184 # shared reservation in the same zone but in a different project.
12185 &quot;A String&quot;,
12186 ],
12187 },
12188 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
12189 &quot;A String&quot;,
12190 ],
12191 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
12192 # compared to the values requested by user in the corresponding input only
12193 # field.
12194 # Use this sub-message for actual values set on Instance attributes as compared
12195 # to the value requested by the user (intent) in their instance CRUD calls.
12196 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
12197 # zonal instance settings, and instance-level predefined metadata keys to
12198 # provide the overridden value for those metadata keys at the instance level.
12199 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
12200 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
12201 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
12202 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
12203 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
12204 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
12205 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
12206 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
12207 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
12208 },
12209 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
12210 # center, including the block, sub-block, and host. The field is formatted as
12211 # follows: blockId/subBlockId/hostId.
12212 &quot;physicalHostTopology&quot;: { # Represents the physical host topology of the host on which the VM is # Output only. [Output Only] A series of fields containing the global name of the Compute
12213 # Engine cluster, as well as the ID of the block, sub-block, and host on
12214 # which the running instance is located.
12215 # running.
12216 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
12217 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
12218 # example
12219 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
12220 # the location ID of the topologies.
12221 &quot;a_key&quot;: &quot;A String&quot;,
12222 },
12223 },
12224 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
12225 # located. Instances within the same block experience low network latency.
12226 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
12227 # running instance is located.
12228 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
12229 # Instances on the same host experience the lowest possible network
12230 # latency.
12231 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
12232 # located. Instances in the same sub-block experience lower network latency
12233 # than instances in the same block.
12234 },
12235 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
12236 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
12237 # instance is consuming from.
12238 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
12239 # instance is consuming from.
12240 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
12241 # this instance is consuming from.
12242 },
12243 &quot;scheduling&quot;: {
12244 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
12245 # must be a number between 1 and the number of availability domains
12246 # specified in the spread placement policy attached to the instance.
12247 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
12248 },
12249 &quot;shutdownDetails&quot;: { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state.
12250 # programmed stop scheduled.
12251 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
12252 # `stop_state=PENDING_STOP`.
12253 # as a count of seconds and fractions of seconds at nanosecond
12254 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12255 # or &quot;month&quot;. Range is approximately 10,000 years.
12256 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12257 # Durations less than one second are represented with a 0
12258 # `seconds` field and a positive `nanos` field. Must be from 0
12259 # to 999,999,999 inclusive.
12260 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12261 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12262 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12263 },
12264 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
12265 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
12266 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
12267 },
12268 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
12269 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
12270 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
12271 # This timestamp value is in RFC3339 text format.
12272 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
12273 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
12274 &quot;A String&quot;,
12275 ],
12276 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
12277 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
12278 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
12279 # This timestamp value is in RFC3339 text format.
12280 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
12281 # This timestamp value is in RFC3339 text format.
12282 },
12283 },
12284 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
12285 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
12286 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
12287 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
12288 # terminated by Compute Engine (not terminated by a user). You can only set
12289 # the automatic restart option for standard instances.Preemptible instances
12290 # cannot be automatically restarted.
12291 #
12292 # By default, this is set to true so an instance is
12293 # automatically restarted if it is terminated by Compute Engine.
12294 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
12295 # must be a number between 1 and the number of availability domains
12296 # specified in the spread placement policy attached to the instance.
12297 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
12298 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
12299 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the
12300 # graceful shutdown isn&#x27;t complete after this time, then the instance
12301 # transitions to the STOPPING state.
12302 # as a count of seconds and fractions of seconds at nanosecond
12303 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12304 # or &quot;month&quot;. Range is approximately 10,000 years.
12305 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12306 # Durations less than one second are represented with a 0
12307 # `seconds` field and a positive `nanos` field. Must be from 0
12308 # to 999,999,999 inclusive.
12309 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12310 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12311 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12312 },
12313 },
12314 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
12315 # within the range of [90, 330] with the increment of 30, if unset, the
12316 # default behavior of host error recovery will be used.
12317 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
12318 &quot;localSsdRecoveryTimeout&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
12319 # recovery of the Local Ssd state is attempted. Its value should be in
12320 # between 0 and 168 hours with hour granularity and the default value being 1
12321 # hour.
12322 # as a count of seconds and fractions of seconds at nanosecond
12323 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12324 # or &quot;month&quot;. Range is approximately 10,000 years.
12325 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12326 # Durations less than one second are represented with a 0
12327 # `seconds` field and a positive `nanos` field. Must be from 0
12328 # to 999,999,999 inclusive.
12329 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12330 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12331 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12332 },
12333 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
12334 # resources.
12335 # This field is for use by internal tools that use the public API.
12336 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
12337 # be scheduled for maintenance.
12338 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
12339 # are: `PERIODIC`.
12340 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
12341 # the instance termination action will be performed at the end of the run
12342 # duration.
12343 # as a count of seconds and fractions of seconds at nanosecond
12344 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12345 # or &quot;month&quot;. Range is approximately 10,000 years.
12346 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12347 # Durations less than one second are represented with a 0
12348 # `seconds` field and a positive `nanos` field. Must be from 0
12349 # to 999,999,999 inclusive.
12350 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12351 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12352 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12353 },
12354 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
12355 # on a sole-tenant node.
12356 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
12357 # affinity for more information.
12358 # Overrides reservationAffinity.
12359 { # Node Affinity: the configuration of desired nodes onto which this Instance
12360 # could be scheduled.
12361 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
12362 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
12363 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
12364 &quot;A String&quot;,
12365 ],
12366 },
12367 ],
12368 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
12369 # the default behavior is MIGRATE. Forpreemptible instances,
12370 # the default and only possible behavior is TERMINATE. For more
12371 # information, see
12372 # Set
12373 # VM host maintenance policy.
12374 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
12375 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
12376 # else, the Local SSD data will be preserved when the instance is stopped
12377 # at the end of the run duration/termination time.
12378 },
12379 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
12380 # instance creation or while the instance isstopped and
12381 # therefore, in a `TERMINATED` state. SeeInstance Life
12382 # Cycle for more information on the possible instance states.
12383 &quot;preemptionNoticeDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
12384 # Off signal is triggered for Spot
12385 # VMs only. If not specified, there will be no wait before the G2 Soft
12386 # Off signal is triggered.
12387 # as a count of seconds and fractions of seconds at nanosecond
12388 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12389 # or &quot;month&quot;. Range is approximately 10,000 years.
12390 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12391 # Durations less than one second are represented with a 0
12392 # `seconds` field and a positive `nanos` field. Must be from 0
12393 # to 999,999,999 inclusive.
12394 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12395 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12396 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12397 },
12398 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
12399 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
12400 # Off and ACPI G3 Mechanical
12401 # Off for Standard VMs and 30 seconds for Spot VMs.
12402 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
12403 # termination action will be performed at the termination time.
12404 },
12405 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
12406 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
12407 # this instance. Only one service account per VM instance is supported.
12408 #
12409 # Service accounts generate access tokens that can be accessed
12410 # through the metadata server and used to authenticate applications on the
12411 # instance. SeeService Accounts
12412 # for more information.
12413 { # A service account.
12414 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
12415 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
12416 &quot;A String&quot;,
12417 ],
12418 },
12419 ],
12420 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
12421 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
12422 # default.
12423 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
12424 # default.
12425 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
12426 # default.
12427 },
12428 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
12429 # Instance boot integrity is measured.
12430 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
12431 # measurements from the VM instance&#x27;s most recent boot.
12432 },
12433 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
12434 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
12435 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
12436 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
12437 },
12438 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
12439 # VM instance boot integrity is measured.
12440 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
12441 # measurements from the VM instance&#x27;s most recent boot.
12442 },
12443 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
12444 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
12445 # machine image.
12446 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
12447 # For example:
12448 #
12449 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12450 # key_region/cryptoKeys/key
12451 #
12452 # The fully-qualifed key name may be returned for resource GET requests. For
12453 # example:
12454 #
12455 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12456 # key_region/cryptoKeys/key
12457 # /cryptoKeyVersions/1
12458 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
12459 # key. If absent, the Compute Engine default service account is used.
12460 # For example:
12461 #
12462 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
12463 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
12464 # encryption key, encoded in RFC
12465 # 4648 base64 to either encrypt or decrypt this resource. You can
12466 # provide either the rawKey or thersaEncryptedKey.
12467 # For example:
12468 #
12469 # &quot;rawKey&quot;:
12470 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
12471 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
12472 # customer-supplied encryption key to either encrypt or decrypt this
12473 # resource. You can provide either the rawKey or thersaEncryptedKey.
12474 # For example:
12475 #
12476 # &quot;rsaEncryptedKey&quot;:
12477 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
12478 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
12479 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
12480 #
12481 # The key must meet the following requirements before you can provide it to
12482 # Compute Engine:
12483 #
12484 # 1. The key is wrapped using a RSA public key certificate provided by
12485 # Google.
12486 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
12487 # encoding.
12488 #
12489 # Gets the RSA public key certificate provided by Google at:
12490 #
12491 #
12492 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
12493 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
12494 # 4648 base64 encoded SHA-256 hash of the customer-supplied
12495 # encryption key that protects this resource.
12496 },
12497 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
12498 # Engine has detected suspicious activity.
12499 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
12500 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
12501 # instance, see
12502 # Instance life cycle.
12503 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
12504 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
12505 # sources or targets for network firewalls and are specified by the client
12506 # during instance creation. The tags can be later modified by the setTags
12507 # method. Each tag within the list must comply withRFC1035.
12508 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
12509 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
12510 # the tags&#x27; contents and used for optimistic locking. The
12511 # fingerprint is initially generated by Compute Engine and changes after
12512 # every request to modify or update tags. You must always provide an
12513 # up-to-date fingerprint hash in order to update or change tags.
12514 #
12515 # To see the latest fingerprint, make get() request to the
12516 # instance.
12517 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
12518 # with RFC1035.
12519 &quot;A String&quot;,
12520 ],
12521 },
12522 &quot;workloadIdentityConfig&quot;: {
12523 &quot;identity&quot;: &quot;A String&quot;,
12524 &quot;identityCertificateEnabled&quot;: True or False,
12525 },
12526 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
12527 # You must specify this field as part of the HTTP request URL. It is
12528 # not settable as a field in the request body.
12529 },
12530 ],
12531 &quot;kind&quot;: &quot;compute#instanceList&quot;, # Output only. [Output Only] Type of resource. Always compute#instanceList
12532 # for lists of Instance resources.
12533 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
12534 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
12535 # the query parameter pageToken in the next list request.
12536 # Subsequent list requests will have their own nextPageToken to
12537 # continue paging through the results.
12538 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
12539 &quot;warning&quot;: { # [Output Only] Informational warning message.
12540 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
12541 # Engine returns NO_RESULTS_ON_PAGE if there
12542 # are no results in the response.
12543 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
12544 # value format. For example:
12545 #
12546 # &quot;data&quot;: [
12547 # {
12548 # &quot;key&quot;: &quot;scope&quot;,
12549 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
12550 # }
12551 {
12552 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
12553 # returned. For example, for warnings where there are no results in a list
12554 # request for a particular zone, this key might be scope and
12555 # the key value might be the zone name. Other examples might be a key
12556 # indicating a deprecated resource and a suggested replacement, or a
12557 # warning about invalid network settings (for example, if an instance
12558 # attempts to perform IP forwarding but is not enabled for IP forwarding).
12559 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
12560 },
12561 ],
12562 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
12563 },
12564 }</pre>
12565 </div>
12566
12567 <div class="method">
12568 <code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
12569 <pre>Retrieves a list of resources that refer to the VM instance specified in
12570 the request. For example, if the VM instance is part of a managed or
12571 unmanaged instance group, the referrers list includes the instance group.
12572 For more information, readViewing
12573 referrers to VM instances.
12574
12575 Args:
12576 project: string, Project ID for this request. (required)
12577 zone: string, The name of the zone for this request. (required)
12578 instance: string, Name of the target instance scoping this request, or &#x27;-&#x27; if the
12579 request should span over all instances in the container. (required)
12580 filter: string, A filter expression that filters resources listed in the response. Most
12581 Compute resources support two types of filter expressions:
12582 expressions that support regular expressions and expressions that follow
12583 API improvement proposal AIP-160.
12584 These two types of filter expressions cannot be mixed in one request.
12585
12586 If you want to use AIP-160, your expression must specify the field name, an
12587 operator, and the value that you want to use for filtering. The value
12588 must be a string, a number, or a boolean. The operator
12589 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
12590
12591 For example, if you are filtering Compute Engine instances, you can
12592 exclude instances named `example-instance` by specifying
12593 `name != example-instance`.
12594
12595 The `:*` comparison can be used to test whether a key has been defined.
12596 For example, to find all objects with `owner` label use:
12597 ```
12598 labels.owner:*
12599 ```
12600
12601 You can also filter nested fields. For example, you could specify
12602 `scheduling.automaticRestart = false` to include instances only
12603 if they are not scheduled for automatic restarts. You can use filtering
12604 on nested fields to filter based onresource labels.
12605
12606 To filter on multiple expressions, provide each separate expression within
12607 parentheses. For example:
12608 ```
12609 (scheduling.automaticRestart = true)
12610 (cpuPlatform = &quot;Intel Skylake&quot;)
12611 ```
12612 By default, each expression is an `AND` expression. However, you
12613 can include `AND` and `OR` expressions explicitly.
12614 For example:
12615 ```
12616 (cpuPlatform = &quot;Intel Skylake&quot;) OR
12617 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
12618 (scheduling.automaticRestart = true)
12619 ```
12620
12621 If you want to use a regular expression, use the `eq` (equal) or `ne`
12622 (not equal) operator against a single un-parenthesized expression with or
12623 without quotes or against multiple parenthesized expressions. Examples:
12624
12625 `fieldname eq unquoted literal`
12626 `fieldname eq &#x27;single quoted literal&#x27;`
12627 `fieldname eq &quot;double quoted literal&quot;`
12628 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
12629
12630 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
12631 The literal value must match the entire field.
12632
12633 For example, to filter for instances that do not end with name &quot;instance&quot;,
12634 you would use `name ne .*instance`.
12635
12636 You cannot combine constraints on multiple fields using regular
12637 expressions.
12638 maxResults: integer, The maximum number of results per page that should be returned.
12639 If the number of available results is larger than `maxResults`,
12640 Compute Engine returns a `nextPageToken` that can be used to get
12641 the next page of results in subsequent list requests. Acceptable values are
12642 `0` to `500`, inclusive. (Default: `500`)
12643 orderBy: string, Sorts list results by a certain order. By default, results
12644 are returned in alphanumerical order based on the resource name.
12645
12646 You can also sort results in descending order based on the creation
12647 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
12648 results based on the `creationTimestamp` field in
12649 reverse chronological order (newest result first). Use this to sort
12650 resources like operations so that the newest operation is returned first.
12651
12652 Currently, only sorting by `name` or
12653 `creationTimestamp desc` is supported.
12654 pageToken: string, Specifies a page token to use. Set `pageToken` to the
12655 `nextPageToken` returned by a previous list request to get
12656 the next page of results.
12657 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
12658 of failure. The default value is false.
12659
12660 For example, when partial success behavior is enabled, aggregatedList for a
12661 single zone scope either returns all resources in the zone or no resources,
12662 with an error code.
12663 x__xgafv: string, V1 error format.
12664 Allowed values
12665 1 - v1 error format
12666 2 - v2 error format
12667
12668 Returns:
12669 An object of the form:
12670
12671 { # Contains a list of instance referrers.
12672 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
12673 &quot;items&quot;: [ # A list of Reference resources.
12674 { # Represents a reference to a resource.
12675 &quot;kind&quot;: &quot;compute#reference&quot;, # Output only. [Output Only] Type of the resource. Always compute#reference
12676 # for references.
12677 &quot;referenceType&quot;: &quot;A String&quot;, # A description of the reference type with no implied semantics. Possible
12678 # values include:
12679 #
12680 #
12681 # 1. MEMBER_OF
12682 &quot;referrer&quot;: &quot;A String&quot;, # URL of the resource which refers to the target.
12683 &quot;target&quot;: &quot;A String&quot;, # URL of the resource to which this reference points.
12684 },
12685 ],
12686 &quot;kind&quot;: &quot;compute#instanceListReferrers&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#instanceListReferrers for lists of Instance referrers.
12687 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
12688 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
12689 # the query parameter pageToken in the next list request.
12690 # Subsequent list requests will have their own nextPageToken to
12691 # continue paging through the results.
12692 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
12693 &quot;warning&quot;: { # [Output Only] Informational warning message.
12694 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
12695 # Engine returns NO_RESULTS_ON_PAGE if there
12696 # are no results in the response.
12697 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
12698 # value format. For example:
12699 #
12700 # &quot;data&quot;: [
12701 # {
12702 # &quot;key&quot;: &quot;scope&quot;,
12703 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
12704 # }
12705 {
12706 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
12707 # returned. For example, for warnings where there are no results in a list
12708 # request for a particular zone, this key might be scope and
12709 # the key value might be the zone name. Other examples might be a key
12710 # indicating a deprecated resource and a suggested replacement, or a
12711 # warning about invalid network settings (for example, if an instance
12712 # attempts to perform IP forwarding but is not enabled for IP forwarding).
12713 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
12714 },
12715 ],
12716 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
12717 },
12718 }</pre>
12719 </div>
12720
12721 <div class="method">
12722 <code class="details" id="listReferrers_next">listReferrers_next()</code>
12723 <pre>Retrieves the next page of results.
12724
12725 Args:
12726 previous_request: The request for the previous page. (required)
12727 previous_response: The response from the request for the previous page. (required)
12728
12729 Returns:
12730 A request object that you can call &#x27;execute()&#x27; on to request the next
12731 page. Returns None if there are no more items in the collection.
12732 </pre>
12733 </div>
12734
12735 <div class="method">
12736 <code class="details" id="list_next">list_next()</code>
12737 <pre>Retrieves the next page of results.
12738
12739 Args:
12740 previous_request: The request for the previous page. (required)
12741 previous_response: The response from the request for the previous page. (required)
12742
12743 Returns:
12744 A request object that you can call &#x27;execute()&#x27; on to request the next
12745 page. Returns None if there are no more items in the collection.
12746 </pre>
12747 </div>
12748
12749 <div class="method">
12750 <code class="details" id="patchPartnerMetadata">patchPartnerMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
12751 <pre>Patches partner metadata of the specified instance.
12752
12753 Args:
12754 project: string, Project ID for this request. (required)
12755 zone: string, The name of the zone for this request. (required)
12756 instance: string, Name of the instance scoping this request. (required)
12757 body: object, The request body.
12758 The object takes the form of:
12759
12760 { # Model definition of partner_metadata field.
12761 # To be used in dedicated Partner Metadata methods and to be inlined in
12762 # the Instance and InstanceTemplate resources.
12763 &quot;fingerprint&quot;: &quot;A String&quot;, # Instance-level hash to be used for optimistic
12764 # locking.
12765 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain to
12766 # entries map. Subdomain name must be compliant withRFC1035
12767 # definition. The total size of all keys and values must be less than 2MB.
12768 # Subdomain &#x27;metadata.compute.googleapis.com&#x27; is reserverd for instance&#x27;s
12769 # metadata.
12770 &quot;a_key&quot;: {
12771 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
12772 # It accepts any value including google.protobuf.Struct.
12773 &quot;a_key&quot;: &quot;&quot;,
12774 },
12775 },
12776 },
12777 }
12778
12779 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
12780 that if you must retry your request, the server will know to ignore the
12781 request if it has already been completed.
12782
12783 For example, consider a situation where you make an initial request and
12784 the request times out. If you make the request again with the same
12785 request ID, the server can check if original operation with the same
12786 request ID was received, and if so, will ignore the second request. This
12787 prevents clients from accidentally creating duplicate commitments.
12788
12789 The request ID must be
12790 a valid UUID with the exception that zero UUID is not supported
12791 (00000000-0000-0000-0000-000000000000).
12792 x__xgafv: string, V1 error format.
12793 Allowed values
12794 1 - v1 error format
12795 2 - v2 error format
12796
12797 Returns:
12798 An object of the form:
12799
12800 { # Represents an Operation resource.
12801 #
12802 # Google Compute Engine has three Operation resources:
12803 #
12804 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
12805 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
12806 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
12807 #
12808 # You can use an operation resource to manage asynchronous API requests.
12809 # For more information, readHandling
12810 # API responses.
12811 #
12812 # Operations can be global, regional or zonal.
12813 #
12814 # - For global operations, use the `globalOperations`
12815 # resource.
12816 # - For regional operations, use the
12817 # `regionOperations` resource.
12818 # - For zonal operations, use
12819 # the `zoneOperations` resource.
12820 #
12821 #
12822 #
12823 # For more information, read
12824 # Global, Regional, and Zonal Resources.
12825 #
12826 # Note that completed Operation resources have a limited
12827 # retention period.
12828 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
12829 # Not present otherwise.
12830 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
12831 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
12832 # set when the operation is created.
12833 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
12834 # text format.
12835 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
12836 # this field will be populated.
12837 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
12838 # operation.
12839 {
12840 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
12841 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
12842 # details. There is a set of defined message types to use for providing
12843 # details.The syntax depends on the error code. For example,
12844 # QuotaExceededInfo will have details when the error code is
12845 # QUOTA_EXCEEDED.
12846 {
12847 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
12848 #
12849 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
12850 # is not enabled:
12851 #
12852 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
12853 # &quot;domain&quot;: &quot;googleapis.com&quot;
12854 # &quot;metadata&quot;: {
12855 # &quot;resource&quot;: &quot;projects/123&quot;,
12856 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
12857 # }
12858 # }
12859 #
12860 # This response indicates that the pubsub.googleapis.com API is not enabled.
12861 #
12862 # Example of an error that is returned when attempting to create a Spanner
12863 # instance in a region that is out of stock:
12864 #
12865 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
12866 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
12867 # &quot;metadata&quot;: {
12868 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
12869 # }
12870 # }
12871 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
12872 # is typically the registered service name of the tool or product that
12873 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
12874 # generated by some common infrastructure, the error domain must be a
12875 # globally unique value that identifies the infrastructure. For Google API
12876 # infrastructure, the error domain is &quot;googleapis.com&quot;.
12877 &quot;metadatas&quot;: { # Additional structured details about this error.
12878 #
12879 # Keys must match a regular expression of `a-z+` but should
12880 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
12881 # length. When identifying the current value of an exceeded limit, the units
12882 # should be contained in the key, not the value. For example, rather than
12883 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
12884 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
12885 # instances that can be created in a single (batch) request.
12886 &quot;a_key&quot;: &quot;A String&quot;,
12887 },
12888 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
12889 # proximate cause of the error. Error reasons are unique within a particular
12890 # domain of errors. This should be at most 63 characters and match a
12891 # regular expression of `A-Z+[A-Z0-9]`, which represents
12892 # UPPER_SNAKE_CASE.
12893 },
12894 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
12895 #
12896 # For example, if a quota check failed with an error indicating the calling
12897 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
12898 # directly to the right place in the developer console to flip the bit.
12899 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
12900 { # Describes a URL link.
12901 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
12902 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
12903 },
12904 ],
12905 },
12906 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
12907 # which can be attached to an RPC error.
12908 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
12909 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
12910 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
12911 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
12912 },
12913 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
12914 &quot;dimensions&quot;: { # The map holding related quota dimensions.
12915 &quot;a_key&quot;: &quot;A String&quot;,
12916 },
12917 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
12918 # type or metric.
12919 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
12920 # or metric.
12921 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
12922 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
12923 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
12924 },
12925 },
12926 ],
12927 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
12928 # This property is optional.
12929 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
12930 },
12931 ],
12932 },
12933 &quot;getVersionOperationMetadata&quot;: {
12934 &quot;inlineSbomInfo&quot;: {
12935 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
12936 # appropriate identifiers.
12937 &quot;a_key&quot;: &quot;A String&quot;,
12938 },
12939 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
12940 # identifiers.
12941 &quot;a_key&quot;: &quot;A String&quot;,
12942 },
12943 },
12944 },
12945 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
12946 # message that was returned, such as `NOT FOUND`.
12947 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
12948 # status code that was returned. For example, a `404` means the
12949 # resource was not found.
12950 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
12951 # defined by the server.
12952 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
12953 # This value is inRFC3339
12954 # text format.
12955 &quot;instancesBulkInsertOperationMetadata&quot;: {
12956 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
12957 # Example key: zones/us-central1-a
12958 &quot;a_key&quot;: {
12959 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
12960 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
12961 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
12962 # error.
12963 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
12964 # if the flow is rolling forward or rolling back.
12965 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
12966 },
12967 },
12968 },
12969 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
12970 # Operation resources.
12971 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
12972 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
12973 # group of operations results from a `bulkInsert` API request.
12974 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
12975 # `update`, or `delete`, and so on.
12976 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
12977 # There is no requirement that this be linear or support any granularity of
12978 # operations. This should not be used to guess when the operation will be
12979 # complete. This number should monotonically increase as the operation
12980 # progresses.
12981 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
12982 # applicable when performing regional operations.
12983 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
12984 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
12985 # this field will contain information on all underlying zonal actions and
12986 # their state.
12987 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
12988 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
12989 # Example key: zones/us-central1-a
12990 &quot;a_key&quot;: {
12991 &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
12992 # populated.
12993 # different programming environments, including REST APIs and RPC APIs. It is
12994 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
12995 # three pieces of data: error code, error message, and error details.
12996 #
12997 # You can find out more about this error model and how to work with it in the
12998 # [API Design Guide](https://cloud.google.com/apis/design/errors).
12999 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
13000 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
13001 # message types for APIs to use.
13002 {
13003 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
13004 },
13005 ],
13006 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
13007 # user-facing error message should be localized and sent in the
13008 # google.rpc.Status.details field, or localized by the client.
13009 },
13010 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
13011 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
13012 },
13013 },
13014 },
13015 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
13016 # This value is inRFC3339
13017 # text format.
13018 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
13019 # following:
13020 # `PENDING`, `RUNNING`, or `DONE`.
13021 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
13022 # operation.
13023 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
13024 # of the target resource.
13025 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
13026 # operations related to creating a snapshot, this points to the disk
13027 # that the snapshot was created from.
13028 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
13029 # `[email protected]` or
13030 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
13031 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
13032 # operation, this field will be populated.
13033 {
13034 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13035 # Engine returns NO_RESULTS_ON_PAGE if there
13036 # are no results in the response.
13037 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13038 # value format. For example:
13039 #
13040 # &quot;data&quot;: [
13041 # {
13042 # &quot;key&quot;: &quot;scope&quot;,
13043 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13044 # }
13045 {
13046 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13047 # returned. For example, for warnings where there are no results in a list
13048 # request for a particular zone, this key might be scope and
13049 # the key value might be the zone name. Other examples might be a key
13050 # indicating a deprecated resource and a suggested replacement, or a
13051 # warning about invalid network settings (for example, if an instance
13052 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13053 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13054 },
13055 ],
13056 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13057 },
13058 ],
13059 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
13060 # applicable when performing per-zone operations.
13061 }</pre>
13062 </div>
13063
13064 <div class="method">
13065 <code class="details" id="performMaintenance">performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)</code>
13066 <pre>Perform a manual maintenance on the instance.
13067
13068 Args:
13069 project: string, Project ID for this request. (required)
13070 zone: string, The name of the zone for this request. (required)
13071 instance: string, Name of the instance scoping this request. (required)
13072 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
13073 that if you must retry your request, the server will know to ignore the
13074 request if it has already been completed.
13075
13076 For example, consider a situation where you make an initial request and
13077 the request times out. If you make the request again with the same
13078 request ID, the server can check if original operation with the same
13079 request ID was received, and if so, will ignore the second request. This
13080 prevents clients from accidentally creating duplicate commitments.
13081
13082 The request ID must be
13083 a valid UUID with the exception that zero UUID is not supported
13084 (00000000-0000-0000-0000-000000000000).
13085 x__xgafv: string, V1 error format.
13086 Allowed values
13087 1 - v1 error format
13088 2 - v2 error format
13089
13090 Returns:
13091 An object of the form:
13092
13093 { # Represents an Operation resource.
13094 #
13095 # Google Compute Engine has three Operation resources:
13096 #
13097 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
13098 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
13099 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
13100 #
13101 # You can use an operation resource to manage asynchronous API requests.
13102 # For more information, readHandling
13103 # API responses.
13104 #
13105 # Operations can be global, regional or zonal.
13106 #
13107 # - For global operations, use the `globalOperations`
13108 # resource.
13109 # - For regional operations, use the
13110 # `regionOperations` resource.
13111 # - For zonal operations, use
13112 # the `zoneOperations` resource.
13113 #
13114 #
13115 #
13116 # For more information, read
13117 # Global, Regional, and Zonal Resources.
13118 #
13119 # Note that completed Operation resources have a limited
13120 # retention period.
13121 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
13122 # Not present otherwise.
13123 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
13124 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
13125 # set when the operation is created.
13126 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
13127 # text format.
13128 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
13129 # this field will be populated.
13130 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
13131 # operation.
13132 {
13133 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
13134 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
13135 # details. There is a set of defined message types to use for providing
13136 # details.The syntax depends on the error code. For example,
13137 # QuotaExceededInfo will have details when the error code is
13138 # QUOTA_EXCEEDED.
13139 {
13140 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
13141 #
13142 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
13143 # is not enabled:
13144 #
13145 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
13146 # &quot;domain&quot;: &quot;googleapis.com&quot;
13147 # &quot;metadata&quot;: {
13148 # &quot;resource&quot;: &quot;projects/123&quot;,
13149 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
13150 # }
13151 # }
13152 #
13153 # This response indicates that the pubsub.googleapis.com API is not enabled.
13154 #
13155 # Example of an error that is returned when attempting to create a Spanner
13156 # instance in a region that is out of stock:
13157 #
13158 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
13159 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
13160 # &quot;metadata&quot;: {
13161 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
13162 # }
13163 # }
13164 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
13165 # is typically the registered service name of the tool or product that
13166 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
13167 # generated by some common infrastructure, the error domain must be a
13168 # globally unique value that identifies the infrastructure. For Google API
13169 # infrastructure, the error domain is &quot;googleapis.com&quot;.
13170 &quot;metadatas&quot;: { # Additional structured details about this error.
13171 #
13172 # Keys must match a regular expression of `a-z+` but should
13173 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
13174 # length. When identifying the current value of an exceeded limit, the units
13175 # should be contained in the key, not the value. For example, rather than
13176 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
13177 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
13178 # instances that can be created in a single (batch) request.
13179 &quot;a_key&quot;: &quot;A String&quot;,
13180 },
13181 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
13182 # proximate cause of the error. Error reasons are unique within a particular
13183 # domain of errors. This should be at most 63 characters and match a
13184 # regular expression of `A-Z+[A-Z0-9]`, which represents
13185 # UPPER_SNAKE_CASE.
13186 },
13187 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
13188 #
13189 # For example, if a quota check failed with an error indicating the calling
13190 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
13191 # directly to the right place in the developer console to flip the bit.
13192 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
13193 { # Describes a URL link.
13194 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
13195 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
13196 },
13197 ],
13198 },
13199 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
13200 # which can be attached to an RPC error.
13201 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
13202 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
13203 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
13204 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
13205 },
13206 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
13207 &quot;dimensions&quot;: { # The map holding related quota dimensions.
13208 &quot;a_key&quot;: &quot;A String&quot;,
13209 },
13210 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
13211 # type or metric.
13212 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
13213 # or metric.
13214 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
13215 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
13216 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
13217 },
13218 },
13219 ],
13220 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
13221 # This property is optional.
13222 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
13223 },
13224 ],
13225 },
13226 &quot;getVersionOperationMetadata&quot;: {
13227 &quot;inlineSbomInfo&quot;: {
13228 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
13229 # appropriate identifiers.
13230 &quot;a_key&quot;: &quot;A String&quot;,
13231 },
13232 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
13233 # identifiers.
13234 &quot;a_key&quot;: &quot;A String&quot;,
13235 },
13236 },
13237 },
13238 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
13239 # message that was returned, such as `NOT FOUND`.
13240 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
13241 # status code that was returned. For example, a `404` means the
13242 # resource was not found.
13243 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
13244 # defined by the server.
13245 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
13246 # This value is inRFC3339
13247 # text format.
13248 &quot;instancesBulkInsertOperationMetadata&quot;: {
13249 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
13250 # Example key: zones/us-central1-a
13251 &quot;a_key&quot;: {
13252 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
13253 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
13254 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
13255 # error.
13256 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
13257 # if the flow is rolling forward or rolling back.
13258 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
13259 },
13260 },
13261 },
13262 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
13263 # Operation resources.
13264 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
13265 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
13266 # group of operations results from a `bulkInsert` API request.
13267 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
13268 # `update`, or `delete`, and so on.
13269 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
13270 # There is no requirement that this be linear or support any granularity of
13271 # operations. This should not be used to guess when the operation will be
13272 # complete. This number should monotonically increase as the operation
13273 # progresses.
13274 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
13275 # applicable when performing regional operations.
13276 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13277 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
13278 # this field will contain information on all underlying zonal actions and
13279 # their state.
13280 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
13281 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
13282 # Example key: zones/us-central1-a
13283 &quot;a_key&quot;: {
13284 &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
13285 # populated.
13286 # different programming environments, including REST APIs and RPC APIs. It is
13287 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
13288 # three pieces of data: error code, error message, and error details.
13289 #
13290 # You can find out more about this error model and how to work with it in the
13291 # [API Design Guide](https://cloud.google.com/apis/design/errors).
13292 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
13293 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
13294 # message types for APIs to use.
13295 {
13296 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
13297 },
13298 ],
13299 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
13300 # user-facing error message should be localized and sent in the
13301 # google.rpc.Status.details field, or localized by the client.
13302 },
13303 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
13304 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
13305 },
13306 },
13307 },
13308 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
13309 # This value is inRFC3339
13310 # text format.
13311 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
13312 # following:
13313 # `PENDING`, `RUNNING`, or `DONE`.
13314 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
13315 # operation.
13316 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
13317 # of the target resource.
13318 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
13319 # operations related to creating a snapshot, this points to the disk
13320 # that the snapshot was created from.
13321 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
13322 # `[email protected]` or
13323 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
13324 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
13325 # operation, this field will be populated.
13326 {
13327 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13328 # Engine returns NO_RESULTS_ON_PAGE if there
13329 # are no results in the response.
13330 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13331 # value format. For example:
13332 #
13333 # &quot;data&quot;: [
13334 # {
13335 # &quot;key&quot;: &quot;scope&quot;,
13336 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13337 # }
13338 {
13339 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13340 # returned. For example, for warnings where there are no results in a list
13341 # request for a particular zone, this key might be scope and
13342 # the key value might be the zone name. Other examples might be a key
13343 # indicating a deprecated resource and a suggested replacement, or a
13344 # warning about invalid network settings (for example, if an instance
13345 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13346 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13347 },
13348 ],
13349 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13350 },
13351 ],
13352 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
13353 # applicable when performing per-zone operations.
13354 }</pre>
13355 </div>
13356
13357 <div class="method">
13358 <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
13359 <pre>Removes resource policies from an instance.
13360
13361 Args:
13362 project: string, Project ID for this request. (required)
13363 zone: string, The name of the zone for this request. (required)
13364 instance: string, The instance name for this request. (required)
13365 body: object, The request body.
13366 The object takes the form of:
13367
13368 {
13369 &quot;resourcePolicies&quot;: [ # Resource policies to be removed from this instance.
13370 &quot;A String&quot;,
13371 ],
13372 }
13373
13374 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
13375 that if you must retry your request, the server will know to ignore the
13376 request if it has already been completed.
13377
13378 For example, consider a situation where you make an initial request and
13379 the request times out. If you make the request again with the same
13380 request ID, the server can check if original operation with the same
13381 request ID was received, and if so, will ignore the second request. This
13382 prevents clients from accidentally creating duplicate commitments.
13383
13384 The request ID must be
13385 a valid UUID with the exception that zero UUID is not supported
13386 (00000000-0000-0000-0000-000000000000).
13387 x__xgafv: string, V1 error format.
13388 Allowed values
13389 1 - v1 error format
13390 2 - v2 error format
13391
13392 Returns:
13393 An object of the form:
13394
13395 { # Represents an Operation resource.
13396 #
13397 # Google Compute Engine has three Operation resources:
13398 #
13399 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
13400 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
13401 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
13402 #
13403 # You can use an operation resource to manage asynchronous API requests.
13404 # For more information, readHandling
13405 # API responses.
13406 #
13407 # Operations can be global, regional or zonal.
13408 #
13409 # - For global operations, use the `globalOperations`
13410 # resource.
13411 # - For regional operations, use the
13412 # `regionOperations` resource.
13413 # - For zonal operations, use
13414 # the `zoneOperations` resource.
13415 #
13416 #
13417 #
13418 # For more information, read
13419 # Global, Regional, and Zonal Resources.
13420 #
13421 # Note that completed Operation resources have a limited
13422 # retention period.
13423 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
13424 # Not present otherwise.
13425 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
13426 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
13427 # set when the operation is created.
13428 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
13429 # text format.
13430 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
13431 # this field will be populated.
13432 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
13433 # operation.
13434 {
13435 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
13436 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
13437 # details. There is a set of defined message types to use for providing
13438 # details.The syntax depends on the error code. For example,
13439 # QuotaExceededInfo will have details when the error code is
13440 # QUOTA_EXCEEDED.
13441 {
13442 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
13443 #
13444 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
13445 # is not enabled:
13446 #
13447 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
13448 # &quot;domain&quot;: &quot;googleapis.com&quot;
13449 # &quot;metadata&quot;: {
13450 # &quot;resource&quot;: &quot;projects/123&quot;,
13451 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
13452 # }
13453 # }
13454 #
13455 # This response indicates that the pubsub.googleapis.com API is not enabled.
13456 #
13457 # Example of an error that is returned when attempting to create a Spanner
13458 # instance in a region that is out of stock:
13459 #
13460 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
13461 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
13462 # &quot;metadata&quot;: {
13463 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
13464 # }
13465 # }
13466 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
13467 # is typically the registered service name of the tool or product that
13468 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
13469 # generated by some common infrastructure, the error domain must be a
13470 # globally unique value that identifies the infrastructure. For Google API
13471 # infrastructure, the error domain is &quot;googleapis.com&quot;.
13472 &quot;metadatas&quot;: { # Additional structured details about this error.
13473 #
13474 # Keys must match a regular expression of `a-z+` but should
13475 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
13476 # length. When identifying the current value of an exceeded limit, the units
13477 # should be contained in the key, not the value. For example, rather than
13478 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
13479 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
13480 # instances that can be created in a single (batch) request.
13481 &quot;a_key&quot;: &quot;A String&quot;,
13482 },
13483 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
13484 # proximate cause of the error. Error reasons are unique within a particular
13485 # domain of errors. This should be at most 63 characters and match a
13486 # regular expression of `A-Z+[A-Z0-9]`, which represents
13487 # UPPER_SNAKE_CASE.
13488 },
13489 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
13490 #
13491 # For example, if a quota check failed with an error indicating the calling
13492 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
13493 # directly to the right place in the developer console to flip the bit.
13494 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
13495 { # Describes a URL link.
13496 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
13497 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
13498 },
13499 ],
13500 },
13501 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
13502 # which can be attached to an RPC error.
13503 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
13504 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
13505 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
13506 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
13507 },
13508 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
13509 &quot;dimensions&quot;: { # The map holding related quota dimensions.
13510 &quot;a_key&quot;: &quot;A String&quot;,
13511 },
13512 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
13513 # type or metric.
13514 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
13515 # or metric.
13516 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
13517 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
13518 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
13519 },
13520 },
13521 ],
13522 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
13523 # This property is optional.
13524 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
13525 },
13526 ],
13527 },
13528 &quot;getVersionOperationMetadata&quot;: {
13529 &quot;inlineSbomInfo&quot;: {
13530 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
13531 # appropriate identifiers.
13532 &quot;a_key&quot;: &quot;A String&quot;,
13533 },
13534 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
13535 # identifiers.
13536 &quot;a_key&quot;: &quot;A String&quot;,
13537 },
13538 },
13539 },
13540 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
13541 # message that was returned, such as `NOT FOUND`.
13542 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
13543 # status code that was returned. For example, a `404` means the
13544 # resource was not found.
13545 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
13546 # defined by the server.
13547 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
13548 # This value is inRFC3339
13549 # text format.
13550 &quot;instancesBulkInsertOperationMetadata&quot;: {
13551 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
13552 # Example key: zones/us-central1-a
13553 &quot;a_key&quot;: {
13554 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
13555 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
13556 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
13557 # error.
13558 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
13559 # if the flow is rolling forward or rolling back.
13560 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
13561 },
13562 },
13563 },
13564 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
13565 # Operation resources.
13566 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
13567 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
13568 # group of operations results from a `bulkInsert` API request.
13569 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
13570 # `update`, or `delete`, and so on.
13571 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
13572 # There is no requirement that this be linear or support any granularity of
13573 # operations. This should not be used to guess when the operation will be
13574 # complete. This number should monotonically increase as the operation
13575 # progresses.
13576 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
13577 # applicable when performing regional operations.
13578 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13579 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
13580 # this field will contain information on all underlying zonal actions and
13581 # their state.
13582 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
13583 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
13584 # Example key: zones/us-central1-a
13585 &quot;a_key&quot;: {
13586 &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
13587 # populated.
13588 # different programming environments, including REST APIs and RPC APIs. It is
13589 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
13590 # three pieces of data: error code, error message, and error details.
13591 #
13592 # You can find out more about this error model and how to work with it in the
13593 # [API Design Guide](https://cloud.google.com/apis/design/errors).
13594 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
13595 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
13596 # message types for APIs to use.
13597 {
13598 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
13599 },
13600 ],
13601 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
13602 # user-facing error message should be localized and sent in the
13603 # google.rpc.Status.details field, or localized by the client.
13604 },
13605 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
13606 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
13607 },
13608 },
13609 },
13610 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
13611 # This value is inRFC3339
13612 # text format.
13613 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
13614 # following:
13615 # `PENDING`, `RUNNING`, or `DONE`.
13616 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
13617 # operation.
13618 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
13619 # of the target resource.
13620 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
13621 # operations related to creating a snapshot, this points to the disk
13622 # that the snapshot was created from.
13623 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
13624 # `[email protected]` or
13625 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
13626 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
13627 # operation, this field will be populated.
13628 {
13629 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13630 # Engine returns NO_RESULTS_ON_PAGE if there
13631 # are no results in the response.
13632 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13633 # value format. For example:
13634 #
13635 # &quot;data&quot;: [
13636 # {
13637 # &quot;key&quot;: &quot;scope&quot;,
13638 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13639 # }
13640 {
13641 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13642 # returned. For example, for warnings where there are no results in a list
13643 # request for a particular zone, this key might be scope and
13644 # the key value might be the zone name. Other examples might be a key
13645 # indicating a deprecated resource and a suggested replacement, or a
13646 # warning about invalid network settings (for example, if an instance
13647 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13648 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13649 },
13650 ],
13651 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13652 },
13653 ],
13654 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
13655 # applicable when performing per-zone operations.
13656 }</pre>
13657 </div>
13658
13659 <div class="method">
13660 <code class="details" id="reportHostAsFaulty">reportHostAsFaulty(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
13661 <pre>Mark the host as faulty and try to restart the instance on a new host.
13662
13663 Args:
13664 project: string, Project ID for this request. (required)
13665 zone: string, The name of the zone for this request. (required)
13666 instance: string, Name of the instance scoping this request. (required)
13667 body: object, The request body.
13668 The object takes the form of:
13669
13670 {
13671 &quot;disruptionSchedule&quot;: &quot;A String&quot;, # The disruption schedule for the VM. Required field, only allows IMMEDIATE.
13672 &quot;faultReasons&quot;: [
13673 {
13674 &quot;behavior&quot;: &quot;A String&quot;,
13675 &quot;description&quot;: &quot;A String&quot;,
13676 },
13677 ],
13678 }
13679
13680 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
13681 that if you must retry your request, the server will know to ignore the
13682 request if it has already been completed.
13683
13684 For example, consider a situation where you make an initial request and
13685 the request times out. If you make the request again with the same
13686 request ID, the server can check if original operation with the same
13687 request ID was received, and if so, will ignore the second request. This
13688 prevents clients from accidentally creating duplicate commitments.
13689
13690 The request ID must be
13691 a valid UUID with the exception that zero UUID is not supported
13692 (00000000-0000-0000-0000-000000000000).
13693 x__xgafv: string, V1 error format.
13694 Allowed values
13695 1 - v1 error format
13696 2 - v2 error format
13697
13698 Returns:
13699 An object of the form:
13700
13701 { # Represents an Operation resource.
13702 #
13703 # Google Compute Engine has three Operation resources:
13704 #
13705 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
13706 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
13707 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
13708 #
13709 # You can use an operation resource to manage asynchronous API requests.
13710 # For more information, readHandling
13711 # API responses.
13712 #
13713 # Operations can be global, regional or zonal.
13714 #
13715 # - For global operations, use the `globalOperations`
13716 # resource.
13717 # - For regional operations, use the
13718 # `regionOperations` resource.
13719 # - For zonal operations, use
13720 # the `zoneOperations` resource.
13721 #
13722 #
13723 #
13724 # For more information, read
13725 # Global, Regional, and Zonal Resources.
13726 #
13727 # Note that completed Operation resources have a limited
13728 # retention period.
13729 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
13730 # Not present otherwise.
13731 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
13732 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
13733 # set when the operation is created.
13734 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
13735 # text format.
13736 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
13737 # this field will be populated.
13738 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
13739 # operation.
13740 {
13741 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
13742 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
13743 # details. There is a set of defined message types to use for providing
13744 # details.The syntax depends on the error code. For example,
13745 # QuotaExceededInfo will have details when the error code is
13746 # QUOTA_EXCEEDED.
13747 {
13748 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
13749 #
13750 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
13751 # is not enabled:
13752 #
13753 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
13754 # &quot;domain&quot;: &quot;googleapis.com&quot;
13755 # &quot;metadata&quot;: {
13756 # &quot;resource&quot;: &quot;projects/123&quot;,
13757 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
13758 # }
13759 # }
13760 #
13761 # This response indicates that the pubsub.googleapis.com API is not enabled.
13762 #
13763 # Example of an error that is returned when attempting to create a Spanner
13764 # instance in a region that is out of stock:
13765 #
13766 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
13767 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
13768 # &quot;metadata&quot;: {
13769 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
13770 # }
13771 # }
13772 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
13773 # is typically the registered service name of the tool or product that
13774 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
13775 # generated by some common infrastructure, the error domain must be a
13776 # globally unique value that identifies the infrastructure. For Google API
13777 # infrastructure, the error domain is &quot;googleapis.com&quot;.
13778 &quot;metadatas&quot;: { # Additional structured details about this error.
13779 #
13780 # Keys must match a regular expression of `a-z+` but should
13781 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
13782 # length. When identifying the current value of an exceeded limit, the units
13783 # should be contained in the key, not the value. For example, rather than
13784 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
13785 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
13786 # instances that can be created in a single (batch) request.
13787 &quot;a_key&quot;: &quot;A String&quot;,
13788 },
13789 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
13790 # proximate cause of the error. Error reasons are unique within a particular
13791 # domain of errors. This should be at most 63 characters and match a
13792 # regular expression of `A-Z+[A-Z0-9]`, which represents
13793 # UPPER_SNAKE_CASE.
13794 },
13795 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
13796 #
13797 # For example, if a quota check failed with an error indicating the calling
13798 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
13799 # directly to the right place in the developer console to flip the bit.
13800 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
13801 { # Describes a URL link.
13802 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
13803 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
13804 },
13805 ],
13806 },
13807 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
13808 # which can be attached to an RPC error.
13809 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
13810 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
13811 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
13812 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
13813 },
13814 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
13815 &quot;dimensions&quot;: { # The map holding related quota dimensions.
13816 &quot;a_key&quot;: &quot;A String&quot;,
13817 },
13818 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
13819 # type or metric.
13820 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
13821 # or metric.
13822 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
13823 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
13824 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
13825 },
13826 },
13827 ],
13828 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
13829 # This property is optional.
13830 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
13831 },
13832 ],
13833 },
13834 &quot;getVersionOperationMetadata&quot;: {
13835 &quot;inlineSbomInfo&quot;: {
13836 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
13837 # appropriate identifiers.
13838 &quot;a_key&quot;: &quot;A String&quot;,
13839 },
13840 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
13841 # identifiers.
13842 &quot;a_key&quot;: &quot;A String&quot;,
13843 },
13844 },
13845 },
13846 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
13847 # message that was returned, such as `NOT FOUND`.
13848 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
13849 # status code that was returned. For example, a `404` means the
13850 # resource was not found.
13851 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
13852 # defined by the server.
13853 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
13854 # This value is inRFC3339
13855 # text format.
13856 &quot;instancesBulkInsertOperationMetadata&quot;: {
13857 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
13858 # Example key: zones/us-central1-a
13859 &quot;a_key&quot;: {
13860 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
13861 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
13862 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
13863 # error.
13864 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
13865 # if the flow is rolling forward or rolling back.
13866 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
13867 },
13868 },
13869 },
13870 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
13871 # Operation resources.
13872 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
13873 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
13874 # group of operations results from a `bulkInsert` API request.
13875 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
13876 # `update`, or `delete`, and so on.
13877 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
13878 # There is no requirement that this be linear or support any granularity of
13879 # operations. This should not be used to guess when the operation will be
13880 # complete. This number should monotonically increase as the operation
13881 # progresses.
13882 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
13883 # applicable when performing regional operations.
13884 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13885 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
13886 # this field will contain information on all underlying zonal actions and
13887 # their state.
13888 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
13889 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
13890 # Example key: zones/us-central1-a
13891 &quot;a_key&quot;: {
13892 &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
13893 # populated.
13894 # different programming environments, including REST APIs and RPC APIs. It is
13895 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
13896 # three pieces of data: error code, error message, and error details.
13897 #
13898 # You can find out more about this error model and how to work with it in the
13899 # [API Design Guide](https://cloud.google.com/apis/design/errors).
13900 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
13901 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
13902 # message types for APIs to use.
13903 {
13904 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
13905 },
13906 ],
13907 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
13908 # user-facing error message should be localized and sent in the
13909 # google.rpc.Status.details field, or localized by the client.
13910 },
13911 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
13912 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
13913 },
13914 },
13915 },
13916 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
13917 # This value is inRFC3339
13918 # text format.
13919 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
13920 # following:
13921 # `PENDING`, `RUNNING`, or `DONE`.
13922 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
13923 # operation.
13924 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
13925 # of the target resource.
13926 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
13927 # operations related to creating a snapshot, this points to the disk
13928 # that the snapshot was created from.
13929 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
13930 # `[email protected]` or
13931 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
13932 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
13933 # operation, this field will be populated.
13934 {
13935 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13936 # Engine returns NO_RESULTS_ON_PAGE if there
13937 # are no results in the response.
13938 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13939 # value format. For example:
13940 #
13941 # &quot;data&quot;: [
13942 # {
13943 # &quot;key&quot;: &quot;scope&quot;,
13944 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13945 # }
13946 {
13947 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13948 # returned. For example, for warnings where there are no results in a list
13949 # request for a particular zone, this key might be scope and
13950 # the key value might be the zone name. Other examples might be a key
13951 # indicating a deprecated resource and a suggested replacement, or a
13952 # warning about invalid network settings (for example, if an instance
13953 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13954 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13955 },
13956 ],
13957 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13958 },
13959 ],
13960 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
13961 # applicable when performing per-zone operations.
13962 }</pre>
13963 </div>
13964
13965 <div class="method">
13966 <code class="details" id="reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</code>
13967 <pre>Performs a reset on the instance. This is a hard reset. The VM
13968 does not do a graceful shutdown. For more information, seeResetting
13969 an instance.
13970
13971 Args:
13972 project: string, Project ID for this request. (required)
13973 zone: string, The name of the zone for this request. (required)
13974 instance: string, Name of the instance scoping this request. (required)
13975 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
13976 that if you must retry your request, the server will know to ignore the
13977 request if it has already been completed.
13978
13979 For example, consider a situation where you make an initial request and
13980 the request times out. If you make the request again with the same
13981 request ID, the server can check if original operation with the same
13982 request ID was received, and if so, will ignore the second request. This
13983 prevents clients from accidentally creating duplicate commitments.
13984
13985 The request ID must be
13986 a valid UUID with the exception that zero UUID is not supported
13987 (00000000-0000-0000-0000-000000000000).
13988 x__xgafv: string, V1 error format.
13989 Allowed values
13990 1 - v1 error format
13991 2 - v2 error format
13992
13993 Returns:
13994 An object of the form:
13995
13996 { # Represents an Operation resource.
13997 #
13998 # Google Compute Engine has three Operation resources:
13999 #
14000 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
14001 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
14002 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
14003 #
14004 # You can use an operation resource to manage asynchronous API requests.
14005 # For more information, readHandling
14006 # API responses.
14007 #
14008 # Operations can be global, regional or zonal.
14009 #
14010 # - For global operations, use the `globalOperations`
14011 # resource.
14012 # - For regional operations, use the
14013 # `regionOperations` resource.
14014 # - For zonal operations, use
14015 # the `zoneOperations` resource.
14016 #
14017 #
14018 #
14019 # For more information, read
14020 # Global, Regional, and Zonal Resources.
14021 #
14022 # Note that completed Operation resources have a limited
14023 # retention period.
14024 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14025 # Not present otherwise.
14026 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14027 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14028 # set when the operation is created.
14029 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14030 # text format.
14031 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14032 # this field will be populated.
14033 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14034 # operation.
14035 {
14036 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14037 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14038 # details. There is a set of defined message types to use for providing
14039 # details.The syntax depends on the error code. For example,
14040 # QuotaExceededInfo will have details when the error code is
14041 # QUOTA_EXCEEDED.
14042 {
14043 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14044 #
14045 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14046 # is not enabled:
14047 #
14048 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14049 # &quot;domain&quot;: &quot;googleapis.com&quot;
14050 # &quot;metadata&quot;: {
14051 # &quot;resource&quot;: &quot;projects/123&quot;,
14052 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14053 # }
14054 # }
14055 #
14056 # This response indicates that the pubsub.googleapis.com API is not enabled.
14057 #
14058 # Example of an error that is returned when attempting to create a Spanner
14059 # instance in a region that is out of stock:
14060 #
14061 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14062 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14063 # &quot;metadata&quot;: {
14064 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14065 # }
14066 # }
14067 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14068 # is typically the registered service name of the tool or product that
14069 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14070 # generated by some common infrastructure, the error domain must be a
14071 # globally unique value that identifies the infrastructure. For Google API
14072 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14073 &quot;metadatas&quot;: { # Additional structured details about this error.
14074 #
14075 # Keys must match a regular expression of `a-z+` but should
14076 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14077 # length. When identifying the current value of an exceeded limit, the units
14078 # should be contained in the key, not the value. For example, rather than
14079 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14080 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14081 # instances that can be created in a single (batch) request.
14082 &quot;a_key&quot;: &quot;A String&quot;,
14083 },
14084 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14085 # proximate cause of the error. Error reasons are unique within a particular
14086 # domain of errors. This should be at most 63 characters and match a
14087 # regular expression of `A-Z+[A-Z0-9]`, which represents
14088 # UPPER_SNAKE_CASE.
14089 },
14090 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14091 #
14092 # For example, if a quota check failed with an error indicating the calling
14093 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14094 # directly to the right place in the developer console to flip the bit.
14095 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14096 { # Describes a URL link.
14097 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14098 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14099 },
14100 ],
14101 },
14102 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14103 # which can be attached to an RPC error.
14104 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14105 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14106 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14107 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14108 },
14109 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14110 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14111 &quot;a_key&quot;: &quot;A String&quot;,
14112 },
14113 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14114 # type or metric.
14115 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14116 # or metric.
14117 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14118 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14119 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14120 },
14121 },
14122 ],
14123 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14124 # This property is optional.
14125 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14126 },
14127 ],
14128 },
14129 &quot;getVersionOperationMetadata&quot;: {
14130 &quot;inlineSbomInfo&quot;: {
14131 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14132 # appropriate identifiers.
14133 &quot;a_key&quot;: &quot;A String&quot;,
14134 },
14135 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14136 # identifiers.
14137 &quot;a_key&quot;: &quot;A String&quot;,
14138 },
14139 },
14140 },
14141 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14142 # message that was returned, such as `NOT FOUND`.
14143 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14144 # status code that was returned. For example, a `404` means the
14145 # resource was not found.
14146 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14147 # defined by the server.
14148 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14149 # This value is inRFC3339
14150 # text format.
14151 &quot;instancesBulkInsertOperationMetadata&quot;: {
14152 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14153 # Example key: zones/us-central1-a
14154 &quot;a_key&quot;: {
14155 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14156 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14157 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14158 # error.
14159 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14160 # if the flow is rolling forward or rolling back.
14161 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14162 },
14163 },
14164 },
14165 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14166 # Operation resources.
14167 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14168 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14169 # group of operations results from a `bulkInsert` API request.
14170 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14171 # `update`, or `delete`, and so on.
14172 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14173 # There is no requirement that this be linear or support any granularity of
14174 # operations. This should not be used to guess when the operation will be
14175 # complete. This number should monotonically increase as the operation
14176 # progresses.
14177 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14178 # applicable when performing regional operations.
14179 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14180 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14181 # this field will contain information on all underlying zonal actions and
14182 # their state.
14183 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14184 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14185 # Example key: zones/us-central1-a
14186 &quot;a_key&quot;: {
14187 &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
14188 # populated.
14189 # different programming environments, including REST APIs and RPC APIs. It is
14190 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14191 # three pieces of data: error code, error message, and error details.
14192 #
14193 # You can find out more about this error model and how to work with it in the
14194 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14195 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14196 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14197 # message types for APIs to use.
14198 {
14199 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14200 },
14201 ],
14202 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14203 # user-facing error message should be localized and sent in the
14204 # google.rpc.Status.details field, or localized by the client.
14205 },
14206 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14207 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14208 },
14209 },
14210 },
14211 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14212 # This value is inRFC3339
14213 # text format.
14214 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14215 # following:
14216 # `PENDING`, `RUNNING`, or `DONE`.
14217 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14218 # operation.
14219 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14220 # of the target resource.
14221 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14222 # operations related to creating a snapshot, this points to the disk
14223 # that the snapshot was created from.
14224 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14225 # `[email protected]` or
14226 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14227 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14228 # operation, this field will be populated.
14229 {
14230 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14231 # Engine returns NO_RESULTS_ON_PAGE if there
14232 # are no results in the response.
14233 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14234 # value format. For example:
14235 #
14236 # &quot;data&quot;: [
14237 # {
14238 # &quot;key&quot;: &quot;scope&quot;,
14239 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
14240 # }
14241 {
14242 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
14243 # returned. For example, for warnings where there are no results in a list
14244 # request for a particular zone, this key might be scope and
14245 # the key value might be the zone name. Other examples might be a key
14246 # indicating a deprecated resource and a suggested replacement, or a
14247 # warning about invalid network settings (for example, if an instance
14248 # attempts to perform IP forwarding but is not enabled for IP forwarding).
14249 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
14250 },
14251 ],
14252 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
14253 },
14254 ],
14255 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
14256 # applicable when performing per-zone operations.
14257 }</pre>
14258 </div>
14259
14260 <div class="method">
14261 <code class="details" id="resume">resume(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
14262 <pre>Resumes an instance that was suspended using theinstances().suspend
14263 method.
14264
14265 Args:
14266 project: string, Project ID for this request. (required)
14267 zone: string, The name of the zone for this request. (required)
14268 instance: string, Name of the instance resource to resume. (required)
14269 body: object, The request body.
14270 The object takes the form of:
14271
14272 {
14273 &quot;disks&quot;: [ # Array of disks associated with this instance that are protected with acustomer-supplied
14274 # encryption key.
14275 #
14276 # In order to resume the instance, the disk url and its corresponding key
14277 # must be provided.
14278 #
14279 # If the disk is not protected with a customer-supplied encryption key it
14280 # should not be specified.
14281 {
14282 &quot;diskEncryptionKey&quot;: { # Decrypts data associated with the disk with acustomer-supplied
14283 # encryption key.
14284 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
14285 # For example:
14286 #
14287 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
14288 # key_region/cryptoKeys/key
14289 #
14290 # The fully-qualifed key name may be returned for resource GET requests. For
14291 # example:
14292 #
14293 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
14294 # key_region/cryptoKeys/key
14295 # /cryptoKeyVersions/1
14296 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
14297 # key. If absent, the Compute Engine default service account is used.
14298 # For example:
14299 #
14300 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
14301 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
14302 # encryption key, encoded in RFC
14303 # 4648 base64 to either encrypt or decrypt this resource. You can
14304 # provide either the rawKey or thersaEncryptedKey.
14305 # For example:
14306 #
14307 # &quot;rawKey&quot;:
14308 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
14309 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
14310 # customer-supplied encryption key to either encrypt or decrypt this
14311 # resource. You can provide either the rawKey or thersaEncryptedKey.
14312 # For example:
14313 #
14314 # &quot;rsaEncryptedKey&quot;:
14315 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
14316 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
14317 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
14318 #
14319 # The key must meet the following requirements before you can provide it to
14320 # Compute Engine:
14321 #
14322 # 1. The key is wrapped using a RSA public key certificate provided by
14323 # Google.
14324 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
14325 # encoding.
14326 #
14327 # Gets the RSA public key certificate provided by Google at:
14328 #
14329 #
14330 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
14331 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
14332 # 4648 base64 encoded SHA-256 hash of the customer-supplied
14333 # encryption key that protects this resource.
14334 },
14335 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
14336 # resource. This field is only applicable for persistent disks.
14337 # For example:
14338 #
14339 # &quot;source&quot;: &quot;/compute/v1/projects/project_id/zones/zone/disks/
14340 # disk_name
14341 },
14342 ],
14343 &quot;instanceEncryptionKey&quot;: { # Decrypts data associated with an instance that is protected with acustomer-supplied
14344 # encryption key.
14345 #
14346 # If the instance you are starting is protected with a customer-supplied
14347 # encryption key, the correct key must be provided otherwise the
14348 # instance resume will not succeed.
14349 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
14350 # For example:
14351 #
14352 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
14353 # key_region/cryptoKeys/key
14354 #
14355 # The fully-qualifed key name may be returned for resource GET requests. For
14356 # example:
14357 #
14358 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
14359 # key_region/cryptoKeys/key
14360 # /cryptoKeyVersions/1
14361 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
14362 # key. If absent, the Compute Engine default service account is used.
14363 # For example:
14364 #
14365 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
14366 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
14367 # encryption key, encoded in RFC
14368 # 4648 base64 to either encrypt or decrypt this resource. You can
14369 # provide either the rawKey or thersaEncryptedKey.
14370 # For example:
14371 #
14372 # &quot;rawKey&quot;:
14373 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
14374 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
14375 # customer-supplied encryption key to either encrypt or decrypt this
14376 # resource. You can provide either the rawKey or thersaEncryptedKey.
14377 # For example:
14378 #
14379 # &quot;rsaEncryptedKey&quot;:
14380 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
14381 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
14382 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
14383 #
14384 # The key must meet the following requirements before you can provide it to
14385 # Compute Engine:
14386 #
14387 # 1. The key is wrapped using a RSA public key certificate provided by
14388 # Google.
14389 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
14390 # encoding.
14391 #
14392 # Gets the RSA public key certificate provided by Google at:
14393 #
14394 #
14395 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
14396 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
14397 # 4648 base64 encoded SHA-256 hash of the customer-supplied
14398 # encryption key that protects this resource.
14399 },
14400 }
14401
14402 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
14403 that if you must retry your request, the server will know to ignore the
14404 request if it has already been completed.
14405
14406 For example, consider a situation where you make an initial request and
14407 the request times out. If you make the request again with the same
14408 request ID, the server can check if original operation with the same
14409 request ID was received, and if so, will ignore the second request. This
14410 prevents clients from accidentally creating duplicate commitments.
14411
14412 The request ID must be
14413 a valid UUID with the exception that zero UUID is not supported
14414 (00000000-0000-0000-0000-000000000000).
14415 x__xgafv: string, V1 error format.
14416 Allowed values
14417 1 - v1 error format
14418 2 - v2 error format
14419
14420 Returns:
14421 An object of the form:
14422
14423 { # Represents an Operation resource.
14424 #
14425 # Google Compute Engine has three Operation resources:
14426 #
14427 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
14428 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
14429 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
14430 #
14431 # You can use an operation resource to manage asynchronous API requests.
14432 # For more information, readHandling
14433 # API responses.
14434 #
14435 # Operations can be global, regional or zonal.
14436 #
14437 # - For global operations, use the `globalOperations`
14438 # resource.
14439 # - For regional operations, use the
14440 # `regionOperations` resource.
14441 # - For zonal operations, use
14442 # the `zoneOperations` resource.
14443 #
14444 #
14445 #
14446 # For more information, read
14447 # Global, Regional, and Zonal Resources.
14448 #
14449 # Note that completed Operation resources have a limited
14450 # retention period.
14451 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14452 # Not present otherwise.
14453 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14454 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14455 # set when the operation is created.
14456 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14457 # text format.
14458 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14459 # this field will be populated.
14460 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14461 # operation.
14462 {
14463 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14464 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14465 # details. There is a set of defined message types to use for providing
14466 # details.The syntax depends on the error code. For example,
14467 # QuotaExceededInfo will have details when the error code is
14468 # QUOTA_EXCEEDED.
14469 {
14470 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14471 #
14472 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14473 # is not enabled:
14474 #
14475 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14476 # &quot;domain&quot;: &quot;googleapis.com&quot;
14477 # &quot;metadata&quot;: {
14478 # &quot;resource&quot;: &quot;projects/123&quot;,
14479 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14480 # }
14481 # }
14482 #
14483 # This response indicates that the pubsub.googleapis.com API is not enabled.
14484 #
14485 # Example of an error that is returned when attempting to create a Spanner
14486 # instance in a region that is out of stock:
14487 #
14488 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14489 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14490 # &quot;metadata&quot;: {
14491 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14492 # }
14493 # }
14494 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14495 # is typically the registered service name of the tool or product that
14496 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14497 # generated by some common infrastructure, the error domain must be a
14498 # globally unique value that identifies the infrastructure. For Google API
14499 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14500 &quot;metadatas&quot;: { # Additional structured details about this error.
14501 #
14502 # Keys must match a regular expression of `a-z+` but should
14503 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14504 # length. When identifying the current value of an exceeded limit, the units
14505 # should be contained in the key, not the value. For example, rather than
14506 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14507 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14508 # instances that can be created in a single (batch) request.
14509 &quot;a_key&quot;: &quot;A String&quot;,
14510 },
14511 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14512 # proximate cause of the error. Error reasons are unique within a particular
14513 # domain of errors. This should be at most 63 characters and match a
14514 # regular expression of `A-Z+[A-Z0-9]`, which represents
14515 # UPPER_SNAKE_CASE.
14516 },
14517 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14518 #
14519 # For example, if a quota check failed with an error indicating the calling
14520 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14521 # directly to the right place in the developer console to flip the bit.
14522 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14523 { # Describes a URL link.
14524 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14525 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14526 },
14527 ],
14528 },
14529 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14530 # which can be attached to an RPC error.
14531 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14532 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14533 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14534 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14535 },
14536 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14537 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14538 &quot;a_key&quot;: &quot;A String&quot;,
14539 },
14540 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14541 # type or metric.
14542 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14543 # or metric.
14544 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14545 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14546 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14547 },
14548 },
14549 ],
14550 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14551 # This property is optional.
14552 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14553 },
14554 ],
14555 },
14556 &quot;getVersionOperationMetadata&quot;: {
14557 &quot;inlineSbomInfo&quot;: {
14558 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14559 # appropriate identifiers.
14560 &quot;a_key&quot;: &quot;A String&quot;,
14561 },
14562 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14563 # identifiers.
14564 &quot;a_key&quot;: &quot;A String&quot;,
14565 },
14566 },
14567 },
14568 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14569 # message that was returned, such as `NOT FOUND`.
14570 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14571 # status code that was returned. For example, a `404` means the
14572 # resource was not found.
14573 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14574 # defined by the server.
14575 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14576 # This value is inRFC3339
14577 # text format.
14578 &quot;instancesBulkInsertOperationMetadata&quot;: {
14579 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14580 # Example key: zones/us-central1-a
14581 &quot;a_key&quot;: {
14582 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14583 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14584 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14585 # error.
14586 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14587 # if the flow is rolling forward or rolling back.
14588 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14589 },
14590 },
14591 },
14592 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14593 # Operation resources.
14594 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14595 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14596 # group of operations results from a `bulkInsert` API request.
14597 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14598 # `update`, or `delete`, and so on.
14599 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14600 # There is no requirement that this be linear or support any granularity of
14601 # operations. This should not be used to guess when the operation will be
14602 # complete. This number should monotonically increase as the operation
14603 # progresses.
14604 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14605 # applicable when performing regional operations.
14606 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14607 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14608 # this field will contain information on all underlying zonal actions and
14609 # their state.
14610 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14611 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14612 # Example key: zones/us-central1-a
14613 &quot;a_key&quot;: {
14614 &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
14615 # populated.
14616 # different programming environments, including REST APIs and RPC APIs. It is
14617 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14618 # three pieces of data: error code, error message, and error details.
14619 #
14620 # You can find out more about this error model and how to work with it in the
14621 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14622 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14623 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14624 # message types for APIs to use.
14625 {
14626 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14627 },
14628 ],
14629 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14630 # user-facing error message should be localized and sent in the
14631 # google.rpc.Status.details field, or localized by the client.
14632 },
14633 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14634 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14635 },
14636 },
14637 },
14638 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14639 # This value is inRFC3339
14640 # text format.
14641 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14642 # following:
14643 # `PENDING`, `RUNNING`, or `DONE`.
14644 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14645 # operation.
14646 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14647 # of the target resource.
14648 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14649 # operations related to creating a snapshot, this points to the disk
14650 # that the snapshot was created from.
14651 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14652 # `[email protected]` or
14653 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14654 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14655 # operation, this field will be populated.
14656 {
14657 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14658 # Engine returns NO_RESULTS_ON_PAGE if there
14659 # are no results in the response.
14660 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14661 # value format. For example:
14662 #
14663 # &quot;data&quot;: [
14664 # {
14665 # &quot;key&quot;: &quot;scope&quot;,
14666 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
14667 # }
14668 {
14669 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
14670 # returned. For example, for warnings where there are no results in a list
14671 # request for a particular zone, this key might be scope and
14672 # the key value might be the zone name. Other examples might be a key
14673 # indicating a deprecated resource and a suggested replacement, or a
14674 # warning about invalid network settings (for example, if an instance
14675 # attempts to perform IP forwarding but is not enabled for IP forwarding).
14676 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
14677 },
14678 ],
14679 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
14680 },
14681 ],
14682 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
14683 # applicable when performing per-zone operations.
14684 }</pre>
14685 </div>
14686
14687 <div class="method">
14688 <code class="details" id="sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</code>
14689 <pre>Sends diagnostic interrupt to the instance.
14690
14691 Args:
14692 project: string, Project ID for this request. (required)
14693 zone: string, The name of the zone for this request. (required)
14694 instance: string, Name of the instance scoping this request. (required)
14695 x__xgafv: string, V1 error format.
14696 Allowed values
14697 1 - v1 error format
14698 2 - v2 error format
14699 </pre>
14700 </div>
14701
14702 <div class="method">
14703 <code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</code>
14704 <pre>Sets deletion protection on the instance.
14705
14706 Args:
14707 project: string, Project ID for this request. (required)
14708 zone: string, The name of the zone for this request. (required)
14709 resource: string, Name or id of the resource for this request. (required)
14710 deletionProtection: boolean, Whether the resource should be protected against deletion.
14711 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
14712 that if you must retry your request, the server will know to ignore the
14713 request if it has already been completed.
14714
14715 For example, consider a situation where you make an initial request and
14716 the request times out. If you make the request again with the same
14717 request ID, the server can check if original operation with the same
14718 request ID was received, and if so, will ignore the second request. This
14719 prevents clients from accidentally creating duplicate commitments.
14720
14721 The request ID must be
14722 a valid UUID with the exception that zero UUID is not supported
14723 (00000000-0000-0000-0000-000000000000).
14724 x__xgafv: string, V1 error format.
14725 Allowed values
14726 1 - v1 error format
14727 2 - v2 error format
14728
14729 Returns:
14730 An object of the form:
14731
14732 { # Represents an Operation resource.
14733 #
14734 # Google Compute Engine has three Operation resources:
14735 #
14736 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
14737 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
14738 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
14739 #
14740 # You can use an operation resource to manage asynchronous API requests.
14741 # For more information, readHandling
14742 # API responses.
14743 #
14744 # Operations can be global, regional or zonal.
14745 #
14746 # - For global operations, use the `globalOperations`
14747 # resource.
14748 # - For regional operations, use the
14749 # `regionOperations` resource.
14750 # - For zonal operations, use
14751 # the `zoneOperations` resource.
14752 #
14753 #
14754 #
14755 # For more information, read
14756 # Global, Regional, and Zonal Resources.
14757 #
14758 # Note that completed Operation resources have a limited
14759 # retention period.
14760 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14761 # Not present otherwise.
14762 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14763 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14764 # set when the operation is created.
14765 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14766 # text format.
14767 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14768 # this field will be populated.
14769 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14770 # operation.
14771 {
14772 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14773 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14774 # details. There is a set of defined message types to use for providing
14775 # details.The syntax depends on the error code. For example,
14776 # QuotaExceededInfo will have details when the error code is
14777 # QUOTA_EXCEEDED.
14778 {
14779 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14780 #
14781 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14782 # is not enabled:
14783 #
14784 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14785 # &quot;domain&quot;: &quot;googleapis.com&quot;
14786 # &quot;metadata&quot;: {
14787 # &quot;resource&quot;: &quot;projects/123&quot;,
14788 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14789 # }
14790 # }
14791 #
14792 # This response indicates that the pubsub.googleapis.com API is not enabled.
14793 #
14794 # Example of an error that is returned when attempting to create a Spanner
14795 # instance in a region that is out of stock:
14796 #
14797 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14798 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14799 # &quot;metadata&quot;: {
14800 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14801 # }
14802 # }
14803 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14804 # is typically the registered service name of the tool or product that
14805 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14806 # generated by some common infrastructure, the error domain must be a
14807 # globally unique value that identifies the infrastructure. For Google API
14808 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14809 &quot;metadatas&quot;: { # Additional structured details about this error.
14810 #
14811 # Keys must match a regular expression of `a-z+` but should
14812 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14813 # length. When identifying the current value of an exceeded limit, the units
14814 # should be contained in the key, not the value. For example, rather than
14815 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14816 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14817 # instances that can be created in a single (batch) request.
14818 &quot;a_key&quot;: &quot;A String&quot;,
14819 },
14820 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14821 # proximate cause of the error. Error reasons are unique within a particular
14822 # domain of errors. This should be at most 63 characters and match a
14823 # regular expression of `A-Z+[A-Z0-9]`, which represents
14824 # UPPER_SNAKE_CASE.
14825 },
14826 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14827 #
14828 # For example, if a quota check failed with an error indicating the calling
14829 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14830 # directly to the right place in the developer console to flip the bit.
14831 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14832 { # Describes a URL link.
14833 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14834 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14835 },
14836 ],
14837 },
14838 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14839 # which can be attached to an RPC error.
14840 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14841 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14842 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14843 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14844 },
14845 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14846 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14847 &quot;a_key&quot;: &quot;A String&quot;,
14848 },
14849 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14850 # type or metric.
14851 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14852 # or metric.
14853 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14854 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14855 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14856 },
14857 },
14858 ],
14859 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14860 # This property is optional.
14861 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14862 },
14863 ],
14864 },
14865 &quot;getVersionOperationMetadata&quot;: {
14866 &quot;inlineSbomInfo&quot;: {
14867 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14868 # appropriate identifiers.
14869 &quot;a_key&quot;: &quot;A String&quot;,
14870 },
14871 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14872 # identifiers.
14873 &quot;a_key&quot;: &quot;A String&quot;,
14874 },
14875 },
14876 },
14877 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14878 # message that was returned, such as `NOT FOUND`.
14879 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14880 # status code that was returned. For example, a `404` means the
14881 # resource was not found.
14882 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14883 # defined by the server.
14884 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14885 # This value is inRFC3339
14886 # text format.
14887 &quot;instancesBulkInsertOperationMetadata&quot;: {
14888 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14889 # Example key: zones/us-central1-a
14890 &quot;a_key&quot;: {
14891 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14892 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14893 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14894 # error.
14895 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14896 # if the flow is rolling forward or rolling back.
14897 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14898 },
14899 },
14900 },
14901 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14902 # Operation resources.
14903 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14904 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14905 # group of operations results from a `bulkInsert` API request.
14906 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14907 # `update`, or `delete`, and so on.
14908 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14909 # There is no requirement that this be linear or support any granularity of
14910 # operations. This should not be used to guess when the operation will be
14911 # complete. This number should monotonically increase as the operation
14912 # progresses.
14913 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14914 # applicable when performing regional operations.
14915 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14916 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14917 # this field will contain information on all underlying zonal actions and
14918 # their state.
14919 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14920 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14921 # Example key: zones/us-central1-a
14922 &quot;a_key&quot;: {
14923 &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
14924 # populated.
14925 # different programming environments, including REST APIs and RPC APIs. It is
14926 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14927 # three pieces of data: error code, error message, and error details.
14928 #
14929 # You can find out more about this error model and how to work with it in the
14930 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14931 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14932 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14933 # message types for APIs to use.
14934 {
14935 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14936 },
14937 ],
14938 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14939 # user-facing error message should be localized and sent in the
14940 # google.rpc.Status.details field, or localized by the client.
14941 },
14942 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14943 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14944 },
14945 },
14946 },
14947 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14948 # This value is inRFC3339
14949 # text format.
14950 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14951 # following:
14952 # `PENDING`, `RUNNING`, or `DONE`.
14953 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14954 # operation.
14955 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14956 # of the target resource.
14957 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14958 # operations related to creating a snapshot, this points to the disk
14959 # that the snapshot was created from.
14960 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14961 # `[email protected]` or
14962 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14963 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14964 # operation, this field will be populated.
14965 {
14966 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14967 # Engine returns NO_RESULTS_ON_PAGE if there
14968 # are no results in the response.
14969 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14970 # value format. For example:
14971 #
14972 # &quot;data&quot;: [
14973 # {
14974 # &quot;key&quot;: &quot;scope&quot;,
14975 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
14976 # }
14977 {
14978 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
14979 # returned. For example, for warnings where there are no results in a list
14980 # request for a particular zone, this key might be scope and
14981 # the key value might be the zone name. Other examples might be a key
14982 # indicating a deprecated resource and a suggested replacement, or a
14983 # warning about invalid network settings (for example, if an instance
14984 # attempts to perform IP forwarding but is not enabled for IP forwarding).
14985 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
14986 },
14987 ],
14988 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
14989 },
14990 ],
14991 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
14992 # applicable when performing per-zone operations.
14993 }</pre>
14994 </div>
14995
14996 <div class="method">
14997 <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</code>
14998 <pre>Sets the auto-delete flag for a disk attached to an instance.
14999
15000 Args:
15001 project: string, Project ID for this request. (required)
15002 zone: string, The name of the zone for this request. (required)
15003 instance: string, The instance name for this request. (required)
15004 autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
15005 deviceName: string, The device name of the disk to modify. Make a get() request
15006 on the instance to view currently attached disks and device names. (required)
15007 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
15008 that if you must retry your request, the server will know to ignore the
15009 request if it has already been completed.
15010
15011 For example, consider a situation where you make an initial request and
15012 the request times out. If you make the request again with the same
15013 request ID, the server can check if original operation with the same
15014 request ID was received, and if so, will ignore the second request. This
15015 prevents clients from accidentally creating duplicate commitments.
15016
15017 The request ID must be
15018 a valid UUID with the exception that zero UUID is not supported
15019 (00000000-0000-0000-0000-000000000000).
15020 x__xgafv: string, V1 error format.
15021 Allowed values
15022 1 - v1 error format
15023 2 - v2 error format
15024
15025 Returns:
15026 An object of the form:
15027
15028 { # Represents an Operation resource.
15029 #
15030 # Google Compute Engine has three Operation resources:
15031 #
15032 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
15033 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
15034 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
15035 #
15036 # You can use an operation resource to manage asynchronous API requests.
15037 # For more information, readHandling
15038 # API responses.
15039 #
15040 # Operations can be global, regional or zonal.
15041 #
15042 # - For global operations, use the `globalOperations`
15043 # resource.
15044 # - For regional operations, use the
15045 # `regionOperations` resource.
15046 # - For zonal operations, use
15047 # the `zoneOperations` resource.
15048 #
15049 #
15050 #
15051 # For more information, read
15052 # Global, Regional, and Zonal Resources.
15053 #
15054 # Note that completed Operation resources have a limited
15055 # retention period.
15056 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
15057 # Not present otherwise.
15058 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
15059 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
15060 # set when the operation is created.
15061 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
15062 # text format.
15063 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
15064 # this field will be populated.
15065 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
15066 # operation.
15067 {
15068 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
15069 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
15070 # details. There is a set of defined message types to use for providing
15071 # details.The syntax depends on the error code. For example,
15072 # QuotaExceededInfo will have details when the error code is
15073 # QUOTA_EXCEEDED.
15074 {
15075 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
15076 #
15077 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
15078 # is not enabled:
15079 #
15080 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
15081 # &quot;domain&quot;: &quot;googleapis.com&quot;
15082 # &quot;metadata&quot;: {
15083 # &quot;resource&quot;: &quot;projects/123&quot;,
15084 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
15085 # }
15086 # }
15087 #
15088 # This response indicates that the pubsub.googleapis.com API is not enabled.
15089 #
15090 # Example of an error that is returned when attempting to create a Spanner
15091 # instance in a region that is out of stock:
15092 #
15093 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
15094 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
15095 # &quot;metadata&quot;: {
15096 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
15097 # }
15098 # }
15099 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
15100 # is typically the registered service name of the tool or product that
15101 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
15102 # generated by some common infrastructure, the error domain must be a
15103 # globally unique value that identifies the infrastructure. For Google API
15104 # infrastructure, the error domain is &quot;googleapis.com&quot;.
15105 &quot;metadatas&quot;: { # Additional structured details about this error.
15106 #
15107 # Keys must match a regular expression of `a-z+` but should
15108 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
15109 # length. When identifying the current value of an exceeded limit, the units
15110 # should be contained in the key, not the value. For example, rather than
15111 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
15112 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
15113 # instances that can be created in a single (batch) request.
15114 &quot;a_key&quot;: &quot;A String&quot;,
15115 },
15116 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
15117 # proximate cause of the error. Error reasons are unique within a particular
15118 # domain of errors. This should be at most 63 characters and match a
15119 # regular expression of `A-Z+[A-Z0-9]`, which represents
15120 # UPPER_SNAKE_CASE.
15121 },
15122 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
15123 #
15124 # For example, if a quota check failed with an error indicating the calling
15125 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
15126 # directly to the right place in the developer console to flip the bit.
15127 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
15128 { # Describes a URL link.
15129 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
15130 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
15131 },
15132 ],
15133 },
15134 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
15135 # which can be attached to an RPC error.
15136 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
15137 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
15138 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
15139 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
15140 },
15141 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
15142 &quot;dimensions&quot;: { # The map holding related quota dimensions.
15143 &quot;a_key&quot;: &quot;A String&quot;,
15144 },
15145 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
15146 # type or metric.
15147 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
15148 # or metric.
15149 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
15150 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
15151 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
15152 },
15153 },
15154 ],
15155 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
15156 # This property is optional.
15157 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
15158 },
15159 ],
15160 },
15161 &quot;getVersionOperationMetadata&quot;: {
15162 &quot;inlineSbomInfo&quot;: {
15163 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
15164 # appropriate identifiers.
15165 &quot;a_key&quot;: &quot;A String&quot;,
15166 },
15167 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
15168 # identifiers.
15169 &quot;a_key&quot;: &quot;A String&quot;,
15170 },
15171 },
15172 },
15173 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
15174 # message that was returned, such as `NOT FOUND`.
15175 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
15176 # status code that was returned. For example, a `404` means the
15177 # resource was not found.
15178 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
15179 # defined by the server.
15180 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
15181 # This value is inRFC3339
15182 # text format.
15183 &quot;instancesBulkInsertOperationMetadata&quot;: {
15184 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
15185 # Example key: zones/us-central1-a
15186 &quot;a_key&quot;: {
15187 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
15188 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
15189 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
15190 # error.
15191 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
15192 # if the flow is rolling forward or rolling back.
15193 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
15194 },
15195 },
15196 },
15197 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
15198 # Operation resources.
15199 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
15200 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
15201 # group of operations results from a `bulkInsert` API request.
15202 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
15203 # `update`, or `delete`, and so on.
15204 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
15205 # There is no requirement that this be linear or support any granularity of
15206 # operations. This should not be used to guess when the operation will be
15207 # complete. This number should monotonically increase as the operation
15208 # progresses.
15209 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
15210 # applicable when performing regional operations.
15211 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
15212 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
15213 # this field will contain information on all underlying zonal actions and
15214 # their state.
15215 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
15216 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
15217 # Example key: zones/us-central1-a
15218 &quot;a_key&quot;: {
15219 &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
15220 # populated.
15221 # different programming environments, including REST APIs and RPC APIs. It is
15222 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
15223 # three pieces of data: error code, error message, and error details.
15224 #
15225 # You can find out more about this error model and how to work with it in the
15226 # [API Design Guide](https://cloud.google.com/apis/design/errors).
15227 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
15228 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
15229 # message types for APIs to use.
15230 {
15231 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
15232 },
15233 ],
15234 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
15235 # user-facing error message should be localized and sent in the
15236 # google.rpc.Status.details field, or localized by the client.
15237 },
15238 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
15239 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
15240 },
15241 },
15242 },
15243 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
15244 # This value is inRFC3339
15245 # text format.
15246 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
15247 # following:
15248 # `PENDING`, `RUNNING`, or `DONE`.
15249 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
15250 # operation.
15251 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
15252 # of the target resource.
15253 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
15254 # operations related to creating a snapshot, this points to the disk
15255 # that the snapshot was created from.
15256 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
15257 # `[email protected]` or
15258 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
15259 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
15260 # operation, this field will be populated.
15261 {
15262 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
15263 # Engine returns NO_RESULTS_ON_PAGE if there
15264 # are no results in the response.
15265 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
15266 # value format. For example:
15267 #
15268 # &quot;data&quot;: [
15269 # {
15270 # &quot;key&quot;: &quot;scope&quot;,
15271 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
15272 # }
15273 {
15274 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
15275 # returned. For example, for warnings where there are no results in a list
15276 # request for a particular zone, this key might be scope and
15277 # the key value might be the zone name. Other examples might be a key
15278 # indicating a deprecated resource and a suggested replacement, or a
15279 # warning about invalid network settings (for example, if an instance
15280 # attempts to perform IP forwarding but is not enabled for IP forwarding).
15281 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
15282 },
15283 ],
15284 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
15285 },
15286 ],
15287 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
15288 # applicable when performing per-zone operations.
15289 }</pre>
15290 </div>
15291
15292 <div class="method">
15293 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>
15294 <pre>Sets the access control policy on the specified resource.
15295 Replaces any existing policy.
15296
15297 Args:
15298 project: string, Project ID for this request. (required)
15299 zone: string, The name of the zone for this request. (required)
15300 resource: string, Name or id of the resource for this request. (required)
15301 body: object, The request body.
15302 The object takes the form of:
15303
15304 {
15305 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
15306 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
15307 { # Associates `members`, or principals, with a `role`.
15308 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
15309 #
15310 # If the condition evaluates to `true`, then this binding applies to the
15311 # current request.
15312 #
15313 # If the condition evaluates to `false`, then this binding does not apply to
15314 # the current request. However, a different role binding might grant the same
15315 # role to one or more of the principals in this binding.
15316 #
15317 # To learn which resources support conditions in their IAM policies, see the
15318 # [IAM
15319 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
15320 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
15321 # are documented at https://github.com/google/cel-spec.
15322 #
15323 # Example (Comparison):
15324 #
15325 # title: &quot;Summary size limit&quot;
15326 # description: &quot;Determines if a summary is less than 100 chars&quot;
15327 # expression: &quot;document.summary.size() &lt; 100&quot;
15328 #
15329 # Example (Equality):
15330 #
15331 # title: &quot;Requestor is owner&quot;
15332 # description: &quot;Determines if requestor is the document owner&quot;
15333 # expression: &quot;document.owner == request.auth.claims.email&quot;
15334 #
15335 # Example (Logic):
15336 #
15337 # title: &quot;Public documents&quot;
15338 # description: &quot;Determine whether the document should be publicly visible&quot;
15339 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
15340 #
15341 # Example (Data Manipulation):
15342 #
15343 # title: &quot;Notification string&quot;
15344 # description: &quot;Create a notification string with a timestamp.&quot;
15345 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
15346 #
15347 # The exact variables and functions that may be referenced within an expression
15348 # are determined by the service that evaluates it. See the service
15349 # documentation for additional information.
15350 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
15351 # describes the expression, e.g. when hovered over it in a UI.
15352 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
15353 # syntax.
15354 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
15355 # reporting, e.g. a file name and a position in the file.
15356 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
15357 # its purpose. This can be used e.g. in UIs which allow to enter the
15358 # expression.
15359 },
15360 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
15361 # `members` can have the following values:
15362 #
15363 # * `allUsers`: A special identifier that represents anyone who is
15364 # on the internet; with or without a Google account.
15365 #
15366 # * `allAuthenticatedUsers`: A special identifier that represents anyone
15367 # who is authenticated with a Google account or a service account.
15368 # Does not include identities that come from external identity providers
15369 # (IdPs) through identity federation.
15370 #
15371 # * `user:{emailid}`: An email address that represents a specific Google
15372 # account. For example, `[email protected]` .
15373 #
15374 #
15375 # * `serviceAccount:{emailid}`: An email address that represents a Google
15376 # service account. For example,
15377 # `[email protected]`.
15378 #
15379 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
15380 # identifier for a
15381 # [Kubernetes service
15382 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
15383 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
15384 #
15385 # * `group:{emailid}`: An email address that represents a Google group.
15386 # For example, `[email protected]`.
15387 #
15388 #
15389 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
15390 # users of that domain. For example, `google.com` or `example.com`.
15391 #
15392 #
15393 #
15394 #
15395 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
15396 # A single identity in a workforce identity pool.
15397 #
15398 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
15399 # All workforce identities in a group.
15400 #
15401 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
15402 # All workforce identities with a specific attribute value.
15403 #
15404 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
15405 # All identities in a workforce identity pool.
15406 #
15407 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
15408 # A single identity in a workload identity pool.
15409 #
15410 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
15411 # A workload identity pool group.
15412 #
15413 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
15414 # All identities in a workload identity pool with a certain attribute.
15415 #
15416 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
15417 # All identities in a workload identity pool.
15418 #
15419 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
15420 # identifier) representing a user that has been recently deleted. For
15421 # example, `[email protected]?uid=123456789012345678901`. If the user is
15422 # recovered, this value reverts to `user:{emailid}` and the recovered user
15423 # retains the role in the binding.
15424 #
15425 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
15426 # unique identifier) representing a service account that has been recently
15427 # deleted. For example,
15428 # `[email protected]?uid=123456789012345678901`.
15429 # If the service account is undeleted, this value reverts to
15430 # `serviceAccount:{emailid}` and the undeleted service account retains the
15431 # role in the binding.
15432 #
15433 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
15434 # identifier) representing a Google group that has been recently
15435 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
15436 # the group is recovered, this value reverts to `group:{emailid}` and the
15437 # recovered group retains the role in the binding.
15438 #
15439 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
15440 # Deleted single identity in a workforce identity pool. For example,
15441 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
15442 &quot;A String&quot;,
15443 ],
15444 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
15445 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
15446 #
15447 # For an overview of the IAM roles and permissions, see the
15448 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
15449 # a list of the available pre-defined roles, see
15450 # [here](https://cloud.google.com/iam/docs/understanding-roles).
15451 },
15452 ],
15453 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
15454 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
15455 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of
15456 # the policy is limited to a few 10s of KB. An empty policy is in general a
15457 # valid policy but certain services (like Projects) might reject them.
15458 # controls for Google Cloud resources.
15459 #
15460 #
15461 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
15462 # `members`, or principals, to a single `role`. Principals can be user
15463 # accounts, service accounts, Google groups, and domains (such as G Suite). A
15464 # `role` is a named list of permissions; each `role` can be an IAM predefined
15465 # role or a user-created custom role.
15466 #
15467 # For some types of Google Cloud resources, a `binding` can also specify a
15468 # `condition`, which is a logical expression that allows access to a resource
15469 # only if the expression evaluates to `true`. A condition can add constraints
15470 # based on attributes of the request, the resource, or both. To learn which
15471 # resources support conditions in their IAM policies, see the
15472 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
15473 #
15474 # **JSON example:**
15475 #
15476 # ```
15477 # {
15478 # &quot;bindings&quot;: [
15479 # {
15480 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
15481 # &quot;members&quot;: [
15482 # &quot;user:[email protected]&quot;,
15483 # &quot;group:[email protected]&quot;,
15484 # &quot;domain:google.com&quot;,
15485 # &quot;serviceAccount:[email protected]&quot;
15486 # ]
15487 # },
15488 # {
15489 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
15490 # &quot;members&quot;: [
15491 # &quot;user:[email protected]&quot;
15492 # ],
15493 # &quot;condition&quot;: {
15494 # &quot;title&quot;: &quot;expirable access&quot;,
15495 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
15496 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
15497 # }
15498 # }
15499 # ],
15500 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
15501 # &quot;version&quot;: 3
15502 # }
15503 # ```
15504 #
15505 # **YAML example:**
15506 #
15507 # ```
15508 # bindings:
15509 # - members:
15510 # - user:[email protected]
15511 # - group:[email protected]
15512 # - domain:google.com
15513 # - serviceAccount:[email protected]
15514 # role: roles/resourcemanager.organizationAdmin
15515 # - members:
15516 # - user:[email protected]
15517 # role: roles/resourcemanager.organizationViewer
15518 # condition:
15519 # title: expirable access
15520 # description: Does not grant access after Sep 2020
15521 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
15522 # etag: BwWWja0YfJA=
15523 # version: 3
15524 # ```
15525 #
15526 # For a description of IAM and its features, see the
15527 # [IAM documentation](https://cloud.google.com/iam/docs/).
15528 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
15529 { # Specifies the audit configuration for a service.
15530 # The configuration determines which permission types are logged, and what
15531 # identities, if any, are exempted from logging.
15532 # An AuditConfig must have one or more AuditLogConfigs.
15533 #
15534 # If there are AuditConfigs for both `allServices` and a specific service,
15535 # the union of the two AuditConfigs is used for that service: the log_types
15536 # specified in each AuditConfig are enabled, and the exempted_members in each
15537 # AuditLogConfig are exempted.
15538 #
15539 # Example Policy with multiple AuditConfigs:
15540 #
15541 # {
15542 # &quot;audit_configs&quot;: [
15543 # {
15544 # &quot;service&quot;: &quot;allServices&quot;,
15545 # &quot;audit_log_configs&quot;: [
15546 # {
15547 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
15548 # &quot;exempted_members&quot;: [
15549 # &quot;user:[email protected]&quot;
15550 # ]
15551 # },
15552 # {
15553 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
15554 # },
15555 # {
15556 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
15557 # }
15558 # ]
15559 # },
15560 # {
15561 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
15562 # &quot;audit_log_configs&quot;: [
15563 # {
15564 # &quot;log_type&quot;: &quot;DATA_READ&quot;
15565 # },
15566 # {
15567 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
15568 # &quot;exempted_members&quot;: [
15569 # &quot;user:[email protected]&quot;
15570 # ]
15571 # }
15572 # ]
15573 # }
15574 # ]
15575 # }
15576 #
15577 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
15578 # logging. It also exempts `[email protected]` from DATA_READ logging, and
15579 # `[email protected]` from DATA_WRITE logging.
15580 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
15581 { # Provides the configuration for logging a type of permissions.
15582 # Example:
15583 #
15584 # {
15585 # &quot;audit_log_configs&quot;: [
15586 # {
15587 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
15588 # &quot;exempted_members&quot;: [
15589 # &quot;user:[email protected]&quot;
15590 # ]
15591 # },
15592 # {
15593 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
15594 # }
15595 # ]
15596 # }
15597 #
15598 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
15599 # [email protected] from DATA_READ logging.
15600 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
15601 # permission.
15602 # Follows the same format of Binding.members.
15603 &quot;A String&quot;,
15604 ],
15605 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
15606 },
15607 ],
15608 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
15609 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
15610 # `allServices` is a special value that covers all services.
15611 },
15612 ],
15613 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
15614 # may specify a `condition` that determines how and when the `bindings` are
15615 # applied. Each of the `bindings` must contain at least one principal.
15616 #
15617 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
15618 # of these principals can be Google groups. Each occurrence of a principal
15619 # counts towards these limits. For example, if the `bindings` grant 50
15620 # different roles to `user:[email protected]`, and not to any other
15621 # principal, then you can add another 1,450 principals to the `bindings` in
15622 # the `Policy`.
15623 { # Associates `members`, or principals, with a `role`.
15624 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
15625 #
15626 # If the condition evaluates to `true`, then this binding applies to the
15627 # current request.
15628 #
15629 # If the condition evaluates to `false`, then this binding does not apply to
15630 # the current request. However, a different role binding might grant the same
15631 # role to one or more of the principals in this binding.
15632 #
15633 # To learn which resources support conditions in their IAM policies, see the
15634 # [IAM
15635 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
15636 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
15637 # are documented at https://github.com/google/cel-spec.
15638 #
15639 # Example (Comparison):
15640 #
15641 # title: &quot;Summary size limit&quot;
15642 # description: &quot;Determines if a summary is less than 100 chars&quot;
15643 # expression: &quot;document.summary.size() &lt; 100&quot;
15644 #
15645 # Example (Equality):
15646 #
15647 # title: &quot;Requestor is owner&quot;
15648 # description: &quot;Determines if requestor is the document owner&quot;
15649 # expression: &quot;document.owner == request.auth.claims.email&quot;
15650 #
15651 # Example (Logic):
15652 #
15653 # title: &quot;Public documents&quot;
15654 # description: &quot;Determine whether the document should be publicly visible&quot;
15655 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
15656 #
15657 # Example (Data Manipulation):
15658 #
15659 # title: &quot;Notification string&quot;
15660 # description: &quot;Create a notification string with a timestamp.&quot;
15661 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
15662 #
15663 # The exact variables and functions that may be referenced within an expression
15664 # are determined by the service that evaluates it. See the service
15665 # documentation for additional information.
15666 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
15667 # describes the expression, e.g. when hovered over it in a UI.
15668 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
15669 # syntax.
15670 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
15671 # reporting, e.g. a file name and a position in the file.
15672 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
15673 # its purpose. This can be used e.g. in UIs which allow to enter the
15674 # expression.
15675 },
15676 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
15677 # `members` can have the following values:
15678 #
15679 # * `allUsers`: A special identifier that represents anyone who is
15680 # on the internet; with or without a Google account.
15681 #
15682 # * `allAuthenticatedUsers`: A special identifier that represents anyone
15683 # who is authenticated with a Google account or a service account.
15684 # Does not include identities that come from external identity providers
15685 # (IdPs) through identity federation.
15686 #
15687 # * `user:{emailid}`: An email address that represents a specific Google
15688 # account. For example, `[email protected]` .
15689 #
15690 #
15691 # * `serviceAccount:{emailid}`: An email address that represents a Google
15692 # service account. For example,
15693 # `[email protected]`.
15694 #
15695 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
15696 # identifier for a
15697 # [Kubernetes service
15698 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
15699 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
15700 #
15701 # * `group:{emailid}`: An email address that represents a Google group.
15702 # For example, `[email protected]`.
15703 #
15704 #
15705 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
15706 # users of that domain. For example, `google.com` or `example.com`.
15707 #
15708 #
15709 #
15710 #
15711 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
15712 # A single identity in a workforce identity pool.
15713 #
15714 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
15715 # All workforce identities in a group.
15716 #
15717 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
15718 # All workforce identities with a specific attribute value.
15719 #
15720 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
15721 # All identities in a workforce identity pool.
15722 #
15723 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
15724 # A single identity in a workload identity pool.
15725 #
15726 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
15727 # A workload identity pool group.
15728 #
15729 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
15730 # All identities in a workload identity pool with a certain attribute.
15731 #
15732 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
15733 # All identities in a workload identity pool.
15734 #
15735 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
15736 # identifier) representing a user that has been recently deleted. For
15737 # example, `[email protected]?uid=123456789012345678901`. If the user is
15738 # recovered, this value reverts to `user:{emailid}` and the recovered user
15739 # retains the role in the binding.
15740 #
15741 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
15742 # unique identifier) representing a service account that has been recently
15743 # deleted. For example,
15744 # `[email protected]?uid=123456789012345678901`.
15745 # If the service account is undeleted, this value reverts to
15746 # `serviceAccount:{emailid}` and the undeleted service account retains the
15747 # role in the binding.
15748 #
15749 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
15750 # identifier) representing a Google group that has been recently
15751 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
15752 # the group is recovered, this value reverts to `group:{emailid}` and the
15753 # recovered group retains the role in the binding.
15754 #
15755 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
15756 # Deleted single identity in a workforce identity pool. For example,
15757 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
15758 &quot;A String&quot;,
15759 ],
15760 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
15761 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
15762 #
15763 # For an overview of the IAM roles and permissions, see the
15764 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
15765 # a list of the available pre-defined roles, see
15766 # [here](https://cloud.google.com/iam/docs/understanding-roles).
15767 },
15768 ],
15769 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
15770 # prevent simultaneous updates of a policy from overwriting each other.
15771 # It is strongly suggested that systems make use of the `etag` in the
15772 # read-modify-write cycle to perform policy updates in order to avoid race
15773 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
15774 # systems are expected to put that etag in the request to `setIamPolicy` to
15775 # ensure that their change will be applied to the same version of the policy.
15776 #
15777 # **Important:** If you use IAM Conditions, you must include the `etag` field
15778 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
15779 # you to overwrite a version `3` policy with a version `1` policy, and all of
15780 # the conditions in the version `3` policy are lost.
15781 &quot;version&quot;: 42, # Specifies the format of the policy.
15782 #
15783 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
15784 # are rejected.
15785 #
15786 # Any operation that affects conditional role bindings must specify version
15787 # `3`. This requirement applies to the following operations:
15788 #
15789 # * Getting a policy that includes a conditional role binding
15790 # * Adding a conditional role binding to a policy
15791 # * Changing a conditional role binding in a policy
15792 # * Removing any role binding, with or without a condition, from a policy
15793 # that includes conditions
15794 #
15795 # **Important:** If you use IAM Conditions, you must include the `etag` field
15796 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
15797 # you to overwrite a version `3` policy with a version `1` policy, and all of
15798 # the conditions in the version `3` policy are lost.
15799 #
15800 # If a policy does not include any conditions, operations on that policy may
15801 # specify any valid version or leave the field unset.
15802 #
15803 # To learn which resources support conditions in their IAM policies, see the
15804 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
15805 },
15806 }
15807
15808 x__xgafv: string, V1 error format.
15809 Allowed values
15810 1 - v1 error format
15811 2 - v2 error format
15812
15813 Returns:
15814 An object of the form:
15815
15816 { # An Identity and Access Management (IAM) policy, which specifies access
15817 # controls for Google Cloud resources.
15818 #
15819 #
15820 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
15821 # `members`, or principals, to a single `role`. Principals can be user
15822 # accounts, service accounts, Google groups, and domains (such as G Suite). A
15823 # `role` is a named list of permissions; each `role` can be an IAM predefined
15824 # role or a user-created custom role.
15825 #
15826 # For some types of Google Cloud resources, a `binding` can also specify a
15827 # `condition`, which is a logical expression that allows access to a resource
15828 # only if the expression evaluates to `true`. A condition can add constraints
15829 # based on attributes of the request, the resource, or both. To learn which
15830 # resources support conditions in their IAM policies, see the
15831 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
15832 #
15833 # **JSON example:**
15834 #
15835 # ```
15836 # {
15837 # &quot;bindings&quot;: [
15838 # {
15839 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
15840 # &quot;members&quot;: [
15841 # &quot;user:[email protected]&quot;,
15842 # &quot;group:[email protected]&quot;,
15843 # &quot;domain:google.com&quot;,
15844 # &quot;serviceAccount:[email protected]&quot;
15845 # ]
15846 # },
15847 # {
15848 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
15849 # &quot;members&quot;: [
15850 # &quot;user:[email protected]&quot;
15851 # ],
15852 # &quot;condition&quot;: {
15853 # &quot;title&quot;: &quot;expirable access&quot;,
15854 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
15855 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
15856 # }
15857 # }
15858 # ],
15859 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
15860 # &quot;version&quot;: 3
15861 # }
15862 # ```
15863 #
15864 # **YAML example:**
15865 #
15866 # ```
15867 # bindings:
15868 # - members:
15869 # - user:[email protected]
15870 # - group:[email protected]
15871 # - domain:google.com
15872 # - serviceAccount:[email protected]
15873 # role: roles/resourcemanager.organizationAdmin
15874 # - members:
15875 # - user:[email protected]
15876 # role: roles/resourcemanager.organizationViewer
15877 # condition:
15878 # title: expirable access
15879 # description: Does not grant access after Sep 2020
15880 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
15881 # etag: BwWWja0YfJA=
15882 # version: 3
15883 # ```
15884 #
15885 # For a description of IAM and its features, see the
15886 # [IAM documentation](https://cloud.google.com/iam/docs/).
15887 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
15888 { # Specifies the audit configuration for a service.
15889 # The configuration determines which permission types are logged, and what
15890 # identities, if any, are exempted from logging.
15891 # An AuditConfig must have one or more AuditLogConfigs.
15892 #
15893 # If there are AuditConfigs for both `allServices` and a specific service,
15894 # the union of the two AuditConfigs is used for that service: the log_types
15895 # specified in each AuditConfig are enabled, and the exempted_members in each
15896 # AuditLogConfig are exempted.
15897 #
15898 # Example Policy with multiple AuditConfigs:
15899 #
15900 # {
15901 # &quot;audit_configs&quot;: [
15902 # {
15903 # &quot;service&quot;: &quot;allServices&quot;,
15904 # &quot;audit_log_configs&quot;: [
15905 # {
15906 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
15907 # &quot;exempted_members&quot;: [
15908 # &quot;user:[email protected]&quot;
15909 # ]
15910 # },
15911 # {
15912 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
15913 # },
15914 # {
15915 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
15916 # }
15917 # ]
15918 # },
15919 # {
15920 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
15921 # &quot;audit_log_configs&quot;: [
15922 # {
15923 # &quot;log_type&quot;: &quot;DATA_READ&quot;
15924 # },
15925 # {
15926 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
15927 # &quot;exempted_members&quot;: [
15928 # &quot;user:[email protected]&quot;
15929 # ]
15930 # }
15931 # ]
15932 # }
15933 # ]
15934 # }
15935 #
15936 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
15937 # logging. It also exempts `[email protected]` from DATA_READ logging, and
15938 # `[email protected]` from DATA_WRITE logging.
15939 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
15940 { # Provides the configuration for logging a type of permissions.
15941 # Example:
15942 #
15943 # {
15944 # &quot;audit_log_configs&quot;: [
15945 # {
15946 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
15947 # &quot;exempted_members&quot;: [
15948 # &quot;user:[email protected]&quot;
15949 # ]
15950 # },
15951 # {
15952 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
15953 # }
15954 # ]
15955 # }
15956 #
15957 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
15958 # [email protected] from DATA_READ logging.
15959 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
15960 # permission.
15961 # Follows the same format of Binding.members.
15962 &quot;A String&quot;,
15963 ],
15964 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
15965 },
15966 ],
15967 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
15968 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
15969 # `allServices` is a special value that covers all services.
15970 },
15971 ],
15972 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
15973 # may specify a `condition` that determines how and when the `bindings` are
15974 # applied. Each of the `bindings` must contain at least one principal.
15975 #
15976 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
15977 # of these principals can be Google groups. Each occurrence of a principal
15978 # counts towards these limits. For example, if the `bindings` grant 50
15979 # different roles to `user:[email protected]`, and not to any other
15980 # principal, then you can add another 1,450 principals to the `bindings` in
15981 # the `Policy`.
15982 { # Associates `members`, or principals, with a `role`.
15983 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
15984 #
15985 # If the condition evaluates to `true`, then this binding applies to the
15986 # current request.
15987 #
15988 # If the condition evaluates to `false`, then this binding does not apply to
15989 # the current request. However, a different role binding might grant the same
15990 # role to one or more of the principals in this binding.
15991 #
15992 # To learn which resources support conditions in their IAM policies, see the
15993 # [IAM
15994 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
15995 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
15996 # are documented at https://github.com/google/cel-spec.
15997 #
15998 # Example (Comparison):
15999 #
16000 # title: &quot;Summary size limit&quot;
16001 # description: &quot;Determines if a summary is less than 100 chars&quot;
16002 # expression: &quot;document.summary.size() &lt; 100&quot;
16003 #
16004 # Example (Equality):
16005 #
16006 # title: &quot;Requestor is owner&quot;
16007 # description: &quot;Determines if requestor is the document owner&quot;
16008 # expression: &quot;document.owner == request.auth.claims.email&quot;
16009 #
16010 # Example (Logic):
16011 #
16012 # title: &quot;Public documents&quot;
16013 # description: &quot;Determine whether the document should be publicly visible&quot;
16014 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
16015 #
16016 # Example (Data Manipulation):
16017 #
16018 # title: &quot;Notification string&quot;
16019 # description: &quot;Create a notification string with a timestamp.&quot;
16020 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
16021 #
16022 # The exact variables and functions that may be referenced within an expression
16023 # are determined by the service that evaluates it. See the service
16024 # documentation for additional information.
16025 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
16026 # describes the expression, e.g. when hovered over it in a UI.
16027 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
16028 # syntax.
16029 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
16030 # reporting, e.g. a file name and a position in the file.
16031 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
16032 # its purpose. This can be used e.g. in UIs which allow to enter the
16033 # expression.
16034 },
16035 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
16036 # `members` can have the following values:
16037 #
16038 # * `allUsers`: A special identifier that represents anyone who is
16039 # on the internet; with or without a Google account.
16040 #
16041 # * `allAuthenticatedUsers`: A special identifier that represents anyone
16042 # who is authenticated with a Google account or a service account.
16043 # Does not include identities that come from external identity providers
16044 # (IdPs) through identity federation.
16045 #
16046 # * `user:{emailid}`: An email address that represents a specific Google
16047 # account. For example, `[email protected]` .
16048 #
16049 #
16050 # * `serviceAccount:{emailid}`: An email address that represents a Google
16051 # service account. For example,
16052 # `[email protected]`.
16053 #
16054 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
16055 # identifier for a
16056 # [Kubernetes service
16057 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
16058 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
16059 #
16060 # * `group:{emailid}`: An email address that represents a Google group.
16061 # For example, `[email protected]`.
16062 #
16063 #
16064 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
16065 # users of that domain. For example, `google.com` or `example.com`.
16066 #
16067 #
16068 #
16069 #
16070 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
16071 # A single identity in a workforce identity pool.
16072 #
16073 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
16074 # All workforce identities in a group.
16075 #
16076 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
16077 # All workforce identities with a specific attribute value.
16078 #
16079 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
16080 # All identities in a workforce identity pool.
16081 #
16082 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
16083 # A single identity in a workload identity pool.
16084 #
16085 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
16086 # A workload identity pool group.
16087 #
16088 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
16089 # All identities in a workload identity pool with a certain attribute.
16090 #
16091 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
16092 # All identities in a workload identity pool.
16093 #
16094 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
16095 # identifier) representing a user that has been recently deleted. For
16096 # example, `[email protected]?uid=123456789012345678901`. If the user is
16097 # recovered, this value reverts to `user:{emailid}` and the recovered user
16098 # retains the role in the binding.
16099 #
16100 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
16101 # unique identifier) representing a service account that has been recently
16102 # deleted. For example,
16103 # `[email protected]?uid=123456789012345678901`.
16104 # If the service account is undeleted, this value reverts to
16105 # `serviceAccount:{emailid}` and the undeleted service account retains the
16106 # role in the binding.
16107 #
16108 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
16109 # identifier) representing a Google group that has been recently
16110 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
16111 # the group is recovered, this value reverts to `group:{emailid}` and the
16112 # recovered group retains the role in the binding.
16113 #
16114 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
16115 # Deleted single identity in a workforce identity pool. For example,
16116 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
16117 &quot;A String&quot;,
16118 ],
16119 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
16120 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
16121 #
16122 # For an overview of the IAM roles and permissions, see the
16123 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
16124 # a list of the available pre-defined roles, see
16125 # [here](https://cloud.google.com/iam/docs/understanding-roles).
16126 },
16127 ],
16128 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
16129 # prevent simultaneous updates of a policy from overwriting each other.
16130 # It is strongly suggested that systems make use of the `etag` in the
16131 # read-modify-write cycle to perform policy updates in order to avoid race
16132 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
16133 # systems are expected to put that etag in the request to `setIamPolicy` to
16134 # ensure that their change will be applied to the same version of the policy.
16135 #
16136 # **Important:** If you use IAM Conditions, you must include the `etag` field
16137 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
16138 # you to overwrite a version `3` policy with a version `1` policy, and all of
16139 # the conditions in the version `3` policy are lost.
16140 &quot;version&quot;: 42, # Specifies the format of the policy.
16141 #
16142 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
16143 # are rejected.
16144 #
16145 # Any operation that affects conditional role bindings must specify version
16146 # `3`. This requirement applies to the following operations:
16147 #
16148 # * Getting a policy that includes a conditional role binding
16149 # * Adding a conditional role binding to a policy
16150 # * Changing a conditional role binding in a policy
16151 # * Removing any role binding, with or without a condition, from a policy
16152 # that includes conditions
16153 #
16154 # **Important:** If you use IAM Conditions, you must include the `etag` field
16155 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
16156 # you to overwrite a version `3` policy with a version `1` policy, and all of
16157 # the conditions in the version `3` policy are lost.
16158 #
16159 # If a policy does not include any conditions, operations on that policy may
16160 # specify any valid version or leave the field unset.
16161 #
16162 # To learn which resources support conditions in their IAM policies, see the
16163 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
16164 }</pre>
16165 </div>
16166
16167 <div class="method">
16168 <code class="details" id="setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
16169 <pre>Sets labels on an instance. To learn more about labels, read theLabeling
16170 Resources documentation.
16171
16172 Args:
16173 project: string, Project ID for this request. (required)
16174 zone: string, The name of the zone for this request. (required)
16175 instance: string, Name of the instance scoping this request. (required)
16176 body: object, The request body.
16177 The object takes the form of:
16178
16179 {
16180 &quot;labelFingerprint&quot;: &quot;A String&quot;, # Fingerprint of the previous set of labels for this resource,
16181 # used to prevent conflicts. Provide the latest fingerprint value when making
16182 # a request to add or change labels.
16183 &quot;labels&quot;: {
16184 &quot;a_key&quot;: &quot;A String&quot;,
16185 },
16186 }
16187
16188 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
16189 that if you must retry your request, the server will know to ignore the
16190 request if it has already been completed.
16191
16192 For example, consider a situation where you make an initial request and
16193 the request times out. If you make the request again with the same
16194 request ID, the server can check if original operation with the same
16195 request ID was received, and if so, will ignore the second request. This
16196 prevents clients from accidentally creating duplicate commitments.
16197
16198 The request ID must be
16199 a valid UUID with the exception that zero UUID is not supported
16200 (00000000-0000-0000-0000-000000000000).
16201 x__xgafv: string, V1 error format.
16202 Allowed values
16203 1 - v1 error format
16204 2 - v2 error format
16205
16206 Returns:
16207 An object of the form:
16208
16209 { # Represents an Operation resource.
16210 #
16211 # Google Compute Engine has three Operation resources:
16212 #
16213 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
16214 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
16215 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
16216 #
16217 # You can use an operation resource to manage asynchronous API requests.
16218 # For more information, readHandling
16219 # API responses.
16220 #
16221 # Operations can be global, regional or zonal.
16222 #
16223 # - For global operations, use the `globalOperations`
16224 # resource.
16225 # - For regional operations, use the
16226 # `regionOperations` resource.
16227 # - For zonal operations, use
16228 # the `zoneOperations` resource.
16229 #
16230 #
16231 #
16232 # For more information, read
16233 # Global, Regional, and Zonal Resources.
16234 #
16235 # Note that completed Operation resources have a limited
16236 # retention period.
16237 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
16238 # Not present otherwise.
16239 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
16240 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
16241 # set when the operation is created.
16242 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
16243 # text format.
16244 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
16245 # this field will be populated.
16246 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
16247 # operation.
16248 {
16249 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
16250 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
16251 # details. There is a set of defined message types to use for providing
16252 # details.The syntax depends on the error code. For example,
16253 # QuotaExceededInfo will have details when the error code is
16254 # QUOTA_EXCEEDED.
16255 {
16256 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
16257 #
16258 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
16259 # is not enabled:
16260 #
16261 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
16262 # &quot;domain&quot;: &quot;googleapis.com&quot;
16263 # &quot;metadata&quot;: {
16264 # &quot;resource&quot;: &quot;projects/123&quot;,
16265 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
16266 # }
16267 # }
16268 #
16269 # This response indicates that the pubsub.googleapis.com API is not enabled.
16270 #
16271 # Example of an error that is returned when attempting to create a Spanner
16272 # instance in a region that is out of stock:
16273 #
16274 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
16275 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
16276 # &quot;metadata&quot;: {
16277 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
16278 # }
16279 # }
16280 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
16281 # is typically the registered service name of the tool or product that
16282 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
16283 # generated by some common infrastructure, the error domain must be a
16284 # globally unique value that identifies the infrastructure. For Google API
16285 # infrastructure, the error domain is &quot;googleapis.com&quot;.
16286 &quot;metadatas&quot;: { # Additional structured details about this error.
16287 #
16288 # Keys must match a regular expression of `a-z+` but should
16289 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
16290 # length. When identifying the current value of an exceeded limit, the units
16291 # should be contained in the key, not the value. For example, rather than
16292 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
16293 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
16294 # instances that can be created in a single (batch) request.
16295 &quot;a_key&quot;: &quot;A String&quot;,
16296 },
16297 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
16298 # proximate cause of the error. Error reasons are unique within a particular
16299 # domain of errors. This should be at most 63 characters and match a
16300 # regular expression of `A-Z+[A-Z0-9]`, which represents
16301 # UPPER_SNAKE_CASE.
16302 },
16303 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
16304 #
16305 # For example, if a quota check failed with an error indicating the calling
16306 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
16307 # directly to the right place in the developer console to flip the bit.
16308 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
16309 { # Describes a URL link.
16310 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
16311 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
16312 },
16313 ],
16314 },
16315 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
16316 # which can be attached to an RPC error.
16317 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
16318 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
16319 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
16320 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
16321 },
16322 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
16323 &quot;dimensions&quot;: { # The map holding related quota dimensions.
16324 &quot;a_key&quot;: &quot;A String&quot;,
16325 },
16326 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
16327 # type or metric.
16328 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
16329 # or metric.
16330 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
16331 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
16332 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
16333 },
16334 },
16335 ],
16336 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
16337 # This property is optional.
16338 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
16339 },
16340 ],
16341 },
16342 &quot;getVersionOperationMetadata&quot;: {
16343 &quot;inlineSbomInfo&quot;: {
16344 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
16345 # appropriate identifiers.
16346 &quot;a_key&quot;: &quot;A String&quot;,
16347 },
16348 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
16349 # identifiers.
16350 &quot;a_key&quot;: &quot;A String&quot;,
16351 },
16352 },
16353 },
16354 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
16355 # message that was returned, such as `NOT FOUND`.
16356 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
16357 # status code that was returned. For example, a `404` means the
16358 # resource was not found.
16359 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
16360 # defined by the server.
16361 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
16362 # This value is inRFC3339
16363 # text format.
16364 &quot;instancesBulkInsertOperationMetadata&quot;: {
16365 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
16366 # Example key: zones/us-central1-a
16367 &quot;a_key&quot;: {
16368 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
16369 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
16370 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
16371 # error.
16372 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
16373 # if the flow is rolling forward or rolling back.
16374 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
16375 },
16376 },
16377 },
16378 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
16379 # Operation resources.
16380 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
16381 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
16382 # group of operations results from a `bulkInsert` API request.
16383 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
16384 # `update`, or `delete`, and so on.
16385 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
16386 # There is no requirement that this be linear or support any granularity of
16387 # operations. This should not be used to guess when the operation will be
16388 # complete. This number should monotonically increase as the operation
16389 # progresses.
16390 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
16391 # applicable when performing regional operations.
16392 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
16393 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
16394 # this field will contain information on all underlying zonal actions and
16395 # their state.
16396 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
16397 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
16398 # Example key: zones/us-central1-a
16399 &quot;a_key&quot;: {
16400 &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
16401 # populated.
16402 # different programming environments, including REST APIs and RPC APIs. It is
16403 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
16404 # three pieces of data: error code, error message, and error details.
16405 #
16406 # You can find out more about this error model and how to work with it in the
16407 # [API Design Guide](https://cloud.google.com/apis/design/errors).
16408 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
16409 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
16410 # message types for APIs to use.
16411 {
16412 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
16413 },
16414 ],
16415 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
16416 # user-facing error message should be localized and sent in the
16417 # google.rpc.Status.details field, or localized by the client.
16418 },
16419 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
16420 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
16421 },
16422 },
16423 },
16424 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
16425 # This value is inRFC3339
16426 # text format.
16427 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
16428 # following:
16429 # `PENDING`, `RUNNING`, or `DONE`.
16430 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
16431 # operation.
16432 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
16433 # of the target resource.
16434 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
16435 # operations related to creating a snapshot, this points to the disk
16436 # that the snapshot was created from.
16437 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
16438 # `[email protected]` or
16439 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
16440 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
16441 # operation, this field will be populated.
16442 {
16443 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
16444 # Engine returns NO_RESULTS_ON_PAGE if there
16445 # are no results in the response.
16446 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
16447 # value format. For example:
16448 #
16449 # &quot;data&quot;: [
16450 # {
16451 # &quot;key&quot;: &quot;scope&quot;,
16452 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
16453 # }
16454 {
16455 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
16456 # returned. For example, for warnings where there are no results in a list
16457 # request for a particular zone, this key might be scope and
16458 # the key value might be the zone name. Other examples might be a key
16459 # indicating a deprecated resource and a suggested replacement, or a
16460 # warning about invalid network settings (for example, if an instance
16461 # attempts to perform IP forwarding but is not enabled for IP forwarding).
16462 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
16463 },
16464 ],
16465 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
16466 },
16467 ],
16468 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
16469 # applicable when performing per-zone operations.
16470 }</pre>
16471 </div>
16472
16473 <div class="method">
16474 <code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
16475 <pre>Changes the number and/or type of accelerator for a stopped instance to the
16476 values specified in the request.
16477
16478 Args:
16479 project: string, Project ID for this request. (required)
16480 zone: string, The name of the zone for this request. (required)
16481 instance: string, Name of the instance scoping this request. (required)
16482 body: object, The request body.
16483 The object takes the form of:
16484
16485 {
16486 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
16487 { # A specification of the type and number of accelerator cards attached to the
16488 # instance.
16489 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
16490 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
16491 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
16492 # If you are creating an instance template, specify only the
16493 # accelerator name.
16494 # See GPUs on Compute Engine
16495 # for a full list of accelerator types.
16496 },
16497 ],
16498 }
16499
16500 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
16501 that if you must retry your request, the server will know to ignore the
16502 request if it has already been completed.
16503
16504 For example, consider a situation where you make an initial request and
16505 the request times out. If you make the request again with the same
16506 request ID, the server can check if original operation with the same
16507 request ID was received, and if so, will ignore the second request. This
16508 prevents clients from accidentally creating duplicate commitments.
16509
16510 The request ID must be
16511 a valid UUID with the exception that zero UUID is not supported
16512 (00000000-0000-0000-0000-000000000000).
16513 x__xgafv: string, V1 error format.
16514 Allowed values
16515 1 - v1 error format
16516 2 - v2 error format
16517
16518 Returns:
16519 An object of the form:
16520
16521 { # Represents an Operation resource.
16522 #
16523 # Google Compute Engine has three Operation resources:
16524 #
16525 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
16526 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
16527 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
16528 #
16529 # You can use an operation resource to manage asynchronous API requests.
16530 # For more information, readHandling
16531 # API responses.
16532 #
16533 # Operations can be global, regional or zonal.
16534 #
16535 # - For global operations, use the `globalOperations`
16536 # resource.
16537 # - For regional operations, use the
16538 # `regionOperations` resource.
16539 # - For zonal operations, use
16540 # the `zoneOperations` resource.
16541 #
16542 #
16543 #
16544 # For more information, read
16545 # Global, Regional, and Zonal Resources.
16546 #
16547 # Note that completed Operation resources have a limited
16548 # retention period.
16549 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
16550 # Not present otherwise.
16551 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
16552 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
16553 # set when the operation is created.
16554 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
16555 # text format.
16556 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
16557 # this field will be populated.
16558 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
16559 # operation.
16560 {
16561 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
16562 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
16563 # details. There is a set of defined message types to use for providing
16564 # details.The syntax depends on the error code. For example,
16565 # QuotaExceededInfo will have details when the error code is
16566 # QUOTA_EXCEEDED.
16567 {
16568 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
16569 #
16570 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
16571 # is not enabled:
16572 #
16573 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
16574 # &quot;domain&quot;: &quot;googleapis.com&quot;
16575 # &quot;metadata&quot;: {
16576 # &quot;resource&quot;: &quot;projects/123&quot;,
16577 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
16578 # }
16579 # }
16580 #
16581 # This response indicates that the pubsub.googleapis.com API is not enabled.
16582 #
16583 # Example of an error that is returned when attempting to create a Spanner
16584 # instance in a region that is out of stock:
16585 #
16586 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
16587 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
16588 # &quot;metadata&quot;: {
16589 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
16590 # }
16591 # }
16592 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
16593 # is typically the registered service name of the tool or product that
16594 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
16595 # generated by some common infrastructure, the error domain must be a
16596 # globally unique value that identifies the infrastructure. For Google API
16597 # infrastructure, the error domain is &quot;googleapis.com&quot;.
16598 &quot;metadatas&quot;: { # Additional structured details about this error.
16599 #
16600 # Keys must match a regular expression of `a-z+` but should
16601 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
16602 # length. When identifying the current value of an exceeded limit, the units
16603 # should be contained in the key, not the value. For example, rather than
16604 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
16605 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
16606 # instances that can be created in a single (batch) request.
16607 &quot;a_key&quot;: &quot;A String&quot;,
16608 },
16609 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
16610 # proximate cause of the error. Error reasons are unique within a particular
16611 # domain of errors. This should be at most 63 characters and match a
16612 # regular expression of `A-Z+[A-Z0-9]`, which represents
16613 # UPPER_SNAKE_CASE.
16614 },
16615 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
16616 #
16617 # For example, if a quota check failed with an error indicating the calling
16618 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
16619 # directly to the right place in the developer console to flip the bit.
16620 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
16621 { # Describes a URL link.
16622 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
16623 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
16624 },
16625 ],
16626 },
16627 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
16628 # which can be attached to an RPC error.
16629 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
16630 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
16631 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
16632 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
16633 },
16634 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
16635 &quot;dimensions&quot;: { # The map holding related quota dimensions.
16636 &quot;a_key&quot;: &quot;A String&quot;,
16637 },
16638 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
16639 # type or metric.
16640 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
16641 # or metric.
16642 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
16643 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
16644 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
16645 },
16646 },
16647 ],
16648 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
16649 # This property is optional.
16650 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
16651 },
16652 ],
16653 },
16654 &quot;getVersionOperationMetadata&quot;: {
16655 &quot;inlineSbomInfo&quot;: {
16656 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
16657 # appropriate identifiers.
16658 &quot;a_key&quot;: &quot;A String&quot;,
16659 },
16660 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
16661 # identifiers.
16662 &quot;a_key&quot;: &quot;A String&quot;,
16663 },
16664 },
16665 },
16666 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
16667 # message that was returned, such as `NOT FOUND`.
16668 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
16669 # status code that was returned. For example, a `404` means the
16670 # resource was not found.
16671 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
16672 # defined by the server.
16673 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
16674 # This value is inRFC3339
16675 # text format.
16676 &quot;instancesBulkInsertOperationMetadata&quot;: {
16677 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
16678 # Example key: zones/us-central1-a
16679 &quot;a_key&quot;: {
16680 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
16681 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
16682 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
16683 # error.
16684 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
16685 # if the flow is rolling forward or rolling back.
16686 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
16687 },
16688 },
16689 },
16690 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
16691 # Operation resources.
16692 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
16693 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
16694 # group of operations results from a `bulkInsert` API request.
16695 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
16696 # `update`, or `delete`, and so on.
16697 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
16698 # There is no requirement that this be linear or support any granularity of
16699 # operations. This should not be used to guess when the operation will be
16700 # complete. This number should monotonically increase as the operation
16701 # progresses.
16702 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
16703 # applicable when performing regional operations.
16704 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
16705 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
16706 # this field will contain information on all underlying zonal actions and
16707 # their state.
16708 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
16709 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
16710 # Example key: zones/us-central1-a
16711 &quot;a_key&quot;: {
16712 &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
16713 # populated.
16714 # different programming environments, including REST APIs and RPC APIs. It is
16715 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
16716 # three pieces of data: error code, error message, and error details.
16717 #
16718 # You can find out more about this error model and how to work with it in the
16719 # [API Design Guide](https://cloud.google.com/apis/design/errors).
16720 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
16721 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
16722 # message types for APIs to use.
16723 {
16724 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
16725 },
16726 ],
16727 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
16728 # user-facing error message should be localized and sent in the
16729 # google.rpc.Status.details field, or localized by the client.
16730 },
16731 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
16732 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
16733 },
16734 },
16735 },
16736 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
16737 # This value is inRFC3339
16738 # text format.
16739 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
16740 # following:
16741 # `PENDING`, `RUNNING`, or `DONE`.
16742 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
16743 # operation.
16744 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
16745 # of the target resource.
16746 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
16747 # operations related to creating a snapshot, this points to the disk
16748 # that the snapshot was created from.
16749 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
16750 # `[email protected]` or
16751 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
16752 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
16753 # operation, this field will be populated.
16754 {
16755 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
16756 # Engine returns NO_RESULTS_ON_PAGE if there
16757 # are no results in the response.
16758 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
16759 # value format. For example:
16760 #
16761 # &quot;data&quot;: [
16762 # {
16763 # &quot;key&quot;: &quot;scope&quot;,
16764 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
16765 # }
16766 {
16767 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
16768 # returned. For example, for warnings where there are no results in a list
16769 # request for a particular zone, this key might be scope and
16770 # the key value might be the zone name. Other examples might be a key
16771 # indicating a deprecated resource and a suggested replacement, or a
16772 # warning about invalid network settings (for example, if an instance
16773 # attempts to perform IP forwarding but is not enabled for IP forwarding).
16774 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
16775 },
16776 ],
16777 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
16778 },
16779 ],
16780 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
16781 # applicable when performing per-zone operations.
16782 }</pre>
16783 </div>
16784
16785 <div class="method">
16786 <code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
16787 <pre>Changes the machine type for a stopped instance to the machine
16788 type specified in the request.
16789
16790 Args:
16791 project: string, Project ID for this request. (required)
16792 zone: string, The name of the zone for this request. (required)
16793 instance: string, Name of the instance scoping this request. (required)
16794 body: object, The request body.
16795 The object takes the form of:
16796
16797 {
16798 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource. See Machine Types for a full list of
16799 # machine types. For example:zones/us-central1-f/machineTypes/n1-standard-1
16800 }
16801
16802 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
16803 that if you must retry your request, the server will know to ignore the
16804 request if it has already been completed.
16805
16806 For example, consider a situation where you make an initial request and
16807 the request times out. If you make the request again with the same
16808 request ID, the server can check if original operation with the same
16809 request ID was received, and if so, will ignore the second request. This
16810 prevents clients from accidentally creating duplicate commitments.
16811
16812 The request ID must be
16813 a valid UUID with the exception that zero UUID is not supported
16814 (00000000-0000-0000-0000-000000000000).
16815 x__xgafv: string, V1 error format.
16816 Allowed values
16817 1 - v1 error format
16818 2 - v2 error format
16819
16820 Returns:
16821 An object of the form:
16822
16823 { # Represents an Operation resource.
16824 #
16825 # Google Compute Engine has three Operation resources:
16826 #
16827 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
16828 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
16829 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
16830 #
16831 # You can use an operation resource to manage asynchronous API requests.
16832 # For more information, readHandling
16833 # API responses.
16834 #
16835 # Operations can be global, regional or zonal.
16836 #
16837 # - For global operations, use the `globalOperations`
16838 # resource.
16839 # - For regional operations, use the
16840 # `regionOperations` resource.
16841 # - For zonal operations, use
16842 # the `zoneOperations` resource.
16843 #
16844 #
16845 #
16846 # For more information, read
16847 # Global, Regional, and Zonal Resources.
16848 #
16849 # Note that completed Operation resources have a limited
16850 # retention period.
16851 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
16852 # Not present otherwise.
16853 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
16854 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
16855 # set when the operation is created.
16856 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
16857 # text format.
16858 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
16859 # this field will be populated.
16860 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
16861 # operation.
16862 {
16863 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
16864 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
16865 # details. There is a set of defined message types to use for providing
16866 # details.The syntax depends on the error code. For example,
16867 # QuotaExceededInfo will have details when the error code is
16868 # QUOTA_EXCEEDED.
16869 {
16870 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
16871 #
16872 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
16873 # is not enabled:
16874 #
16875 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
16876 # &quot;domain&quot;: &quot;googleapis.com&quot;
16877 # &quot;metadata&quot;: {
16878 # &quot;resource&quot;: &quot;projects/123&quot;,
16879 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
16880 # }
16881 # }
16882 #
16883 # This response indicates that the pubsub.googleapis.com API is not enabled.
16884 #
16885 # Example of an error that is returned when attempting to create a Spanner
16886 # instance in a region that is out of stock:
16887 #
16888 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
16889 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
16890 # &quot;metadata&quot;: {
16891 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
16892 # }
16893 # }
16894 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
16895 # is typically the registered service name of the tool or product that
16896 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
16897 # generated by some common infrastructure, the error domain must be a
16898 # globally unique value that identifies the infrastructure. For Google API
16899 # infrastructure, the error domain is &quot;googleapis.com&quot;.
16900 &quot;metadatas&quot;: { # Additional structured details about this error.
16901 #
16902 # Keys must match a regular expression of `a-z+` but should
16903 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
16904 # length. When identifying the current value of an exceeded limit, the units
16905 # should be contained in the key, not the value. For example, rather than
16906 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
16907 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
16908 # instances that can be created in a single (batch) request.
16909 &quot;a_key&quot;: &quot;A String&quot;,
16910 },
16911 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
16912 # proximate cause of the error. Error reasons are unique within a particular
16913 # domain of errors. This should be at most 63 characters and match a
16914 # regular expression of `A-Z+[A-Z0-9]`, which represents
16915 # UPPER_SNAKE_CASE.
16916 },
16917 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
16918 #
16919 # For example, if a quota check failed with an error indicating the calling
16920 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
16921 # directly to the right place in the developer console to flip the bit.
16922 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
16923 { # Describes a URL link.
16924 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
16925 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
16926 },
16927 ],
16928 },
16929 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
16930 # which can be attached to an RPC error.
16931 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
16932 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
16933 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
16934 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
16935 },
16936 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
16937 &quot;dimensions&quot;: { # The map holding related quota dimensions.
16938 &quot;a_key&quot;: &quot;A String&quot;,
16939 },
16940 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
16941 # type or metric.
16942 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
16943 # or metric.
16944 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
16945 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
16946 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
16947 },
16948 },
16949 ],
16950 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
16951 # This property is optional.
16952 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
16953 },
16954 ],
16955 },
16956 &quot;getVersionOperationMetadata&quot;: {
16957 &quot;inlineSbomInfo&quot;: {
16958 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
16959 # appropriate identifiers.
16960 &quot;a_key&quot;: &quot;A String&quot;,
16961 },
16962 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
16963 # identifiers.
16964 &quot;a_key&quot;: &quot;A String&quot;,
16965 },
16966 },
16967 },
16968 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
16969 # message that was returned, such as `NOT FOUND`.
16970 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
16971 # status code that was returned. For example, a `404` means the
16972 # resource was not found.
16973 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
16974 # defined by the server.
16975 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
16976 # This value is inRFC3339
16977 # text format.
16978 &quot;instancesBulkInsertOperationMetadata&quot;: {
16979 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
16980 # Example key: zones/us-central1-a
16981 &quot;a_key&quot;: {
16982 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
16983 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
16984 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
16985 # error.
16986 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
16987 # if the flow is rolling forward or rolling back.
16988 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
16989 },
16990 },
16991 },
16992 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
16993 # Operation resources.
16994 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
16995 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
16996 # group of operations results from a `bulkInsert` API request.
16997 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
16998 # `update`, or `delete`, and so on.
16999 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17000 # There is no requirement that this be linear or support any granularity of
17001 # operations. This should not be used to guess when the operation will be
17002 # complete. This number should monotonically increase as the operation
17003 # progresses.
17004 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17005 # applicable when performing regional operations.
17006 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17007 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
17008 # this field will contain information on all underlying zonal actions and
17009 # their state.
17010 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
17011 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
17012 # Example key: zones/us-central1-a
17013 &quot;a_key&quot;: {
17014 &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
17015 # populated.
17016 # different programming environments, including REST APIs and RPC APIs. It is
17017 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
17018 # three pieces of data: error code, error message, and error details.
17019 #
17020 # You can find out more about this error model and how to work with it in the
17021 # [API Design Guide](https://cloud.google.com/apis/design/errors).
17022 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
17023 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
17024 # message types for APIs to use.
17025 {
17026 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
17027 },
17028 ],
17029 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
17030 # user-facing error message should be localized and sent in the
17031 # google.rpc.Status.details field, or localized by the client.
17032 },
17033 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
17034 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
17035 },
17036 },
17037 },
17038 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
17039 # This value is inRFC3339
17040 # text format.
17041 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
17042 # following:
17043 # `PENDING`, `RUNNING`, or `DONE`.
17044 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
17045 # operation.
17046 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
17047 # of the target resource.
17048 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
17049 # operations related to creating a snapshot, this points to the disk
17050 # that the snapshot was created from.
17051 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
17052 # `[email protected]` or
17053 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
17054 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
17055 # operation, this field will be populated.
17056 {
17057 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
17058 # Engine returns NO_RESULTS_ON_PAGE if there
17059 # are no results in the response.
17060 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
17061 # value format. For example:
17062 #
17063 # &quot;data&quot;: [
17064 # {
17065 # &quot;key&quot;: &quot;scope&quot;,
17066 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
17067 # }
17068 {
17069 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
17070 # returned. For example, for warnings where there are no results in a list
17071 # request for a particular zone, this key might be scope and
17072 # the key value might be the zone name. Other examples might be a key
17073 # indicating a deprecated resource and a suggested replacement, or a
17074 # warning about invalid network settings (for example, if an instance
17075 # attempts to perform IP forwarding but is not enabled for IP forwarding).
17076 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
17077 },
17078 ],
17079 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
17080 },
17081 ],
17082 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
17083 # applicable when performing per-zone operations.
17084 }</pre>
17085 </div>
17086
17087 <div class="method">
17088 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
17089 <pre>Sets metadata for the specified instance to the data included
17090 in the request.
17091
17092 Args:
17093 project: string, Project ID for this request. (required)
17094 zone: string, The name of the zone for this request. (required)
17095 instance: string, Name of the instance scoping this request. (required)
17096 body: object, The request body.
17097 The object takes the form of:
17098
17099 { # A metadata key/value entry.
17100 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
17101 # the metadata&#x27;s contents and used for optimistic locking. The
17102 # fingerprint is initially generated by Compute Engine and changes after
17103 # every request to modify or update metadata. You must always provide an
17104 # up-to-date fingerprint hash in order to update or change metadata,
17105 # otherwise the request will fail with error412 conditionNotMet.
17106 #
17107 # To see the latest fingerprint, make a get() request to
17108 # retrieve the resource.
17109 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
17110 # less than 512 KB.
17111 { # Metadata
17112 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
17113 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
17114 # This is reflected as part of a URL in the metadata server. Additionally, to
17115 # avoid ambiguity, keys must not conflict with any other metadata keys
17116 # for the project.
17117 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
17118 # have meaning as interpreted by the image running in the instance. The
17119 # only restriction placed on values is that their size must be less than
17120 # or equal to 262144 bytes (256 KiB).
17121 },
17122 ],
17123 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
17124 # for metadata.
17125 }
17126
17127 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
17128 that if you must retry your request, the server will know to ignore the
17129 request if it has already been completed.
17130
17131 For example, consider a situation where you make an initial request and
17132 the request times out. If you make the request again with the same
17133 request ID, the server can check if original operation with the same
17134 request ID was received, and if so, will ignore the second request. This
17135 prevents clients from accidentally creating duplicate commitments.
17136
17137 The request ID must be
17138 a valid UUID with the exception that zero UUID is not supported
17139 (00000000-0000-0000-0000-000000000000).
17140 x__xgafv: string, V1 error format.
17141 Allowed values
17142 1 - v1 error format
17143 2 - v2 error format
17144
17145 Returns:
17146 An object of the form:
17147
17148 { # Represents an Operation resource.
17149 #
17150 # Google Compute Engine has three Operation resources:
17151 #
17152 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
17153 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
17154 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
17155 #
17156 # You can use an operation resource to manage asynchronous API requests.
17157 # For more information, readHandling
17158 # API responses.
17159 #
17160 # Operations can be global, regional or zonal.
17161 #
17162 # - For global operations, use the `globalOperations`
17163 # resource.
17164 # - For regional operations, use the
17165 # `regionOperations` resource.
17166 # - For zonal operations, use
17167 # the `zoneOperations` resource.
17168 #
17169 #
17170 #
17171 # For more information, read
17172 # Global, Regional, and Zonal Resources.
17173 #
17174 # Note that completed Operation resources have a limited
17175 # retention period.
17176 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17177 # Not present otherwise.
17178 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17179 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17180 # set when the operation is created.
17181 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17182 # text format.
17183 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17184 # this field will be populated.
17185 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17186 # operation.
17187 {
17188 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17189 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17190 # details. There is a set of defined message types to use for providing
17191 # details.The syntax depends on the error code. For example,
17192 # QuotaExceededInfo will have details when the error code is
17193 # QUOTA_EXCEEDED.
17194 {
17195 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17196 #
17197 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17198 # is not enabled:
17199 #
17200 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17201 # &quot;domain&quot;: &quot;googleapis.com&quot;
17202 # &quot;metadata&quot;: {
17203 # &quot;resource&quot;: &quot;projects/123&quot;,
17204 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17205 # }
17206 # }
17207 #
17208 # This response indicates that the pubsub.googleapis.com API is not enabled.
17209 #
17210 # Example of an error that is returned when attempting to create a Spanner
17211 # instance in a region that is out of stock:
17212 #
17213 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17214 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17215 # &quot;metadata&quot;: {
17216 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17217 # }
17218 # }
17219 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17220 # is typically the registered service name of the tool or product that
17221 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17222 # generated by some common infrastructure, the error domain must be a
17223 # globally unique value that identifies the infrastructure. For Google API
17224 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17225 &quot;metadatas&quot;: { # Additional structured details about this error.
17226 #
17227 # Keys must match a regular expression of `a-z+` but should
17228 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17229 # length. When identifying the current value of an exceeded limit, the units
17230 # should be contained in the key, not the value. For example, rather than
17231 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17232 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17233 # instances that can be created in a single (batch) request.
17234 &quot;a_key&quot;: &quot;A String&quot;,
17235 },
17236 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17237 # proximate cause of the error. Error reasons are unique within a particular
17238 # domain of errors. This should be at most 63 characters and match a
17239 # regular expression of `A-Z+[A-Z0-9]`, which represents
17240 # UPPER_SNAKE_CASE.
17241 },
17242 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17243 #
17244 # For example, if a quota check failed with an error indicating the calling
17245 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17246 # directly to the right place in the developer console to flip the bit.
17247 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
17248 { # Describes a URL link.
17249 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
17250 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
17251 },
17252 ],
17253 },
17254 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
17255 # which can be attached to an RPC error.
17256 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
17257 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
17258 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
17259 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
17260 },
17261 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
17262 &quot;dimensions&quot;: { # The map holding related quota dimensions.
17263 &quot;a_key&quot;: &quot;A String&quot;,
17264 },
17265 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
17266 # type or metric.
17267 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
17268 # or metric.
17269 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
17270 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
17271 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
17272 },
17273 },
17274 ],
17275 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
17276 # This property is optional.
17277 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
17278 },
17279 ],
17280 },
17281 &quot;getVersionOperationMetadata&quot;: {
17282 &quot;inlineSbomInfo&quot;: {
17283 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
17284 # appropriate identifiers.
17285 &quot;a_key&quot;: &quot;A String&quot;,
17286 },
17287 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
17288 # identifiers.
17289 &quot;a_key&quot;: &quot;A String&quot;,
17290 },
17291 },
17292 },
17293 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
17294 # message that was returned, such as `NOT FOUND`.
17295 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
17296 # status code that was returned. For example, a `404` means the
17297 # resource was not found.
17298 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
17299 # defined by the server.
17300 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
17301 # This value is inRFC3339
17302 # text format.
17303 &quot;instancesBulkInsertOperationMetadata&quot;: {
17304 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
17305 # Example key: zones/us-central1-a
17306 &quot;a_key&quot;: {
17307 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
17308 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
17309 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
17310 # error.
17311 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
17312 # if the flow is rolling forward or rolling back.
17313 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
17314 },
17315 },
17316 },
17317 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
17318 # Operation resources.
17319 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
17320 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
17321 # group of operations results from a `bulkInsert` API request.
17322 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
17323 # `update`, or `delete`, and so on.
17324 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17325 # There is no requirement that this be linear or support any granularity of
17326 # operations. This should not be used to guess when the operation will be
17327 # complete. This number should monotonically increase as the operation
17328 # progresses.
17329 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17330 # applicable when performing regional operations.
17331 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17332 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
17333 # this field will contain information on all underlying zonal actions and
17334 # their state.
17335 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
17336 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
17337 # Example key: zones/us-central1-a
17338 &quot;a_key&quot;: {
17339 &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
17340 # populated.
17341 # different programming environments, including REST APIs and RPC APIs. It is
17342 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
17343 # three pieces of data: error code, error message, and error details.
17344 #
17345 # You can find out more about this error model and how to work with it in the
17346 # [API Design Guide](https://cloud.google.com/apis/design/errors).
17347 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
17348 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
17349 # message types for APIs to use.
17350 {
17351 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
17352 },
17353 ],
17354 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
17355 # user-facing error message should be localized and sent in the
17356 # google.rpc.Status.details field, or localized by the client.
17357 },
17358 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
17359 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
17360 },
17361 },
17362 },
17363 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
17364 # This value is inRFC3339
17365 # text format.
17366 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
17367 # following:
17368 # `PENDING`, `RUNNING`, or `DONE`.
17369 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
17370 # operation.
17371 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
17372 # of the target resource.
17373 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
17374 # operations related to creating a snapshot, this points to the disk
17375 # that the snapshot was created from.
17376 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
17377 # `[email protected]` or
17378 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
17379 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
17380 # operation, this field will be populated.
17381 {
17382 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
17383 # Engine returns NO_RESULTS_ON_PAGE if there
17384 # are no results in the response.
17385 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
17386 # value format. For example:
17387 #
17388 # &quot;data&quot;: [
17389 # {
17390 # &quot;key&quot;: &quot;scope&quot;,
17391 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
17392 # }
17393 {
17394 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
17395 # returned. For example, for warnings where there are no results in a list
17396 # request for a particular zone, this key might be scope and
17397 # the key value might be the zone name. Other examples might be a key
17398 # indicating a deprecated resource and a suggested replacement, or a
17399 # warning about invalid network settings (for example, if an instance
17400 # attempts to perform IP forwarding but is not enabled for IP forwarding).
17401 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
17402 },
17403 ],
17404 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
17405 },
17406 ],
17407 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
17408 # applicable when performing per-zone operations.
17409 }</pre>
17410 </div>
17411
17412 <div class="method">
17413 <code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
17414 <pre>Changes the minimum CPU platform that this instance should use.
17415 This method can only
17416 be called on a stopped instance. For more information, readSpecifying a
17417 Minimum CPU Platform.
17418
17419 Args:
17420 project: string, Project ID for this request. (required)
17421 zone: string, The name of the zone for this request. (required)
17422 instance: string, Name of the instance scoping this request. (required)
17423 body: object, The request body.
17424 The object takes the form of:
17425
17426 {
17427 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform this instance should be started at.
17428 }
17429
17430 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
17431 that if you must retry your request, the server will know to ignore the
17432 request if it has already been completed.
17433
17434 For example, consider a situation where you make an initial request and
17435 the request times out. If you make the request again with the same
17436 request ID, the server can check if original operation with the same
17437 request ID was received, and if so, will ignore the second request. This
17438 prevents clients from accidentally creating duplicate commitments.
17439
17440 The request ID must be
17441 a valid UUID with the exception that zero UUID is not supported
17442 (00000000-0000-0000-0000-000000000000).
17443 x__xgafv: string, V1 error format.
17444 Allowed values
17445 1 - v1 error format
17446 2 - v2 error format
17447
17448 Returns:
17449 An object of the form:
17450
17451 { # Represents an Operation resource.
17452 #
17453 # Google Compute Engine has three Operation resources:
17454 #
17455 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
17456 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
17457 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
17458 #
17459 # You can use an operation resource to manage asynchronous API requests.
17460 # For more information, readHandling
17461 # API responses.
17462 #
17463 # Operations can be global, regional or zonal.
17464 #
17465 # - For global operations, use the `globalOperations`
17466 # resource.
17467 # - For regional operations, use the
17468 # `regionOperations` resource.
17469 # - For zonal operations, use
17470 # the `zoneOperations` resource.
17471 #
17472 #
17473 #
17474 # For more information, read
17475 # Global, Regional, and Zonal Resources.
17476 #
17477 # Note that completed Operation resources have a limited
17478 # retention period.
17479 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17480 # Not present otherwise.
17481 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17482 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17483 # set when the operation is created.
17484 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17485 # text format.
17486 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17487 # this field will be populated.
17488 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17489 # operation.
17490 {
17491 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17492 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17493 # details. There is a set of defined message types to use for providing
17494 # details.The syntax depends on the error code. For example,
17495 # QuotaExceededInfo will have details when the error code is
17496 # QUOTA_EXCEEDED.
17497 {
17498 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17499 #
17500 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17501 # is not enabled:
17502 #
17503 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17504 # &quot;domain&quot;: &quot;googleapis.com&quot;
17505 # &quot;metadata&quot;: {
17506 # &quot;resource&quot;: &quot;projects/123&quot;,
17507 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17508 # }
17509 # }
17510 #
17511 # This response indicates that the pubsub.googleapis.com API is not enabled.
17512 #
17513 # Example of an error that is returned when attempting to create a Spanner
17514 # instance in a region that is out of stock:
17515 #
17516 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17517 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17518 # &quot;metadata&quot;: {
17519 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17520 # }
17521 # }
17522 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17523 # is typically the registered service name of the tool or product that
17524 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17525 # generated by some common infrastructure, the error domain must be a
17526 # globally unique value that identifies the infrastructure. For Google API
17527 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17528 &quot;metadatas&quot;: { # Additional structured details about this error.
17529 #
17530 # Keys must match a regular expression of `a-z+` but should
17531 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17532 # length. When identifying the current value of an exceeded limit, the units
17533 # should be contained in the key, not the value. For example, rather than
17534 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17535 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17536 # instances that can be created in a single (batch) request.
17537 &quot;a_key&quot;: &quot;A String&quot;,
17538 },
17539 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17540 # proximate cause of the error. Error reasons are unique within a particular
17541 # domain of errors. This should be at most 63 characters and match a
17542 # regular expression of `A-Z+[A-Z0-9]`, which represents
17543 # UPPER_SNAKE_CASE.
17544 },
17545 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17546 #
17547 # For example, if a quota check failed with an error indicating the calling
17548 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17549 # directly to the right place in the developer console to flip the bit.
17550 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
17551 { # Describes a URL link.
17552 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
17553 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
17554 },
17555 ],
17556 },
17557 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
17558 # which can be attached to an RPC error.
17559 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
17560 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
17561 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
17562 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
17563 },
17564 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
17565 &quot;dimensions&quot;: { # The map holding related quota dimensions.
17566 &quot;a_key&quot;: &quot;A String&quot;,
17567 },
17568 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
17569 # type or metric.
17570 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
17571 # or metric.
17572 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
17573 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
17574 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
17575 },
17576 },
17577 ],
17578 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
17579 # This property is optional.
17580 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
17581 },
17582 ],
17583 },
17584 &quot;getVersionOperationMetadata&quot;: {
17585 &quot;inlineSbomInfo&quot;: {
17586 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
17587 # appropriate identifiers.
17588 &quot;a_key&quot;: &quot;A String&quot;,
17589 },
17590 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
17591 # identifiers.
17592 &quot;a_key&quot;: &quot;A String&quot;,
17593 },
17594 },
17595 },
17596 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
17597 # message that was returned, such as `NOT FOUND`.
17598 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
17599 # status code that was returned. For example, a `404` means the
17600 # resource was not found.
17601 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
17602 # defined by the server.
17603 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
17604 # This value is inRFC3339
17605 # text format.
17606 &quot;instancesBulkInsertOperationMetadata&quot;: {
17607 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
17608 # Example key: zones/us-central1-a
17609 &quot;a_key&quot;: {
17610 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
17611 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
17612 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
17613 # error.
17614 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
17615 # if the flow is rolling forward or rolling back.
17616 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
17617 },
17618 },
17619 },
17620 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
17621 # Operation resources.
17622 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
17623 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
17624 # group of operations results from a `bulkInsert` API request.
17625 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
17626 # `update`, or `delete`, and so on.
17627 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17628 # There is no requirement that this be linear or support any granularity of
17629 # operations. This should not be used to guess when the operation will be
17630 # complete. This number should monotonically increase as the operation
17631 # progresses.
17632 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17633 # applicable when performing regional operations.
17634 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17635 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
17636 # this field will contain information on all underlying zonal actions and
17637 # their state.
17638 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
17639 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
17640 # Example key: zones/us-central1-a
17641 &quot;a_key&quot;: {
17642 &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
17643 # populated.
17644 # different programming environments, including REST APIs and RPC APIs. It is
17645 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
17646 # three pieces of data: error code, error message, and error details.
17647 #
17648 # You can find out more about this error model and how to work with it in the
17649 # [API Design Guide](https://cloud.google.com/apis/design/errors).
17650 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
17651 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
17652 # message types for APIs to use.
17653 {
17654 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
17655 },
17656 ],
17657 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
17658 # user-facing error message should be localized and sent in the
17659 # google.rpc.Status.details field, or localized by the client.
17660 },
17661 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
17662 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
17663 },
17664 },
17665 },
17666 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
17667 # This value is inRFC3339
17668 # text format.
17669 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
17670 # following:
17671 # `PENDING`, `RUNNING`, or `DONE`.
17672 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
17673 # operation.
17674 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
17675 # of the target resource.
17676 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
17677 # operations related to creating a snapshot, this points to the disk
17678 # that the snapshot was created from.
17679 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
17680 # `[email protected]` or
17681 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
17682 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
17683 # operation, this field will be populated.
17684 {
17685 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
17686 # Engine returns NO_RESULTS_ON_PAGE if there
17687 # are no results in the response.
17688 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
17689 # value format. For example:
17690 #
17691 # &quot;data&quot;: [
17692 # {
17693 # &quot;key&quot;: &quot;scope&quot;,
17694 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
17695 # }
17696 {
17697 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
17698 # returned. For example, for warnings where there are no results in a list
17699 # request for a particular zone, this key might be scope and
17700 # the key value might be the zone name. Other examples might be a key
17701 # indicating a deprecated resource and a suggested replacement, or a
17702 # warning about invalid network settings (for example, if an instance
17703 # attempts to perform IP forwarding but is not enabled for IP forwarding).
17704 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
17705 },
17706 ],
17707 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
17708 },
17709 ],
17710 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
17711 # applicable when performing per-zone operations.
17712 }</pre>
17713 </div>
17714
17715 <div class="method">
17716 <code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
17717 <pre>Sets name of an instance.
17718
17719 Args:
17720 project: string, Project ID for this request. (required)
17721 zone: string, The name of the zone for this request. (required)
17722 instance: string, The instance name for this request. (required)
17723 body: object, The request body.
17724 The object takes the form of:
17725
17726 {
17727 &quot;currentName&quot;: &quot;A String&quot;, # The current name of this resource, used to prevent conflicts. Provide the
17728 # latest name when making a request to change name.
17729 &quot;name&quot;: &quot;A String&quot;, # The name to be applied to the instance. Needs to be RFC 1035 compliant.
17730 }
17731
17732 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
17733 that if you must retry your request, the server will know to ignore the
17734 request if it has already been completed.
17735
17736 For example, consider a situation where you make an initial request and
17737 the request times out. If you make the request again with the same
17738 request ID, the server can check if original operation with the same
17739 request ID was received, and if so, will ignore the second request. This
17740 prevents clients from accidentally creating duplicate commitments.
17741
17742 The request ID must be
17743 a valid UUID with the exception that zero UUID is not supported
17744 (00000000-0000-0000-0000-000000000000).
17745 x__xgafv: string, V1 error format.
17746 Allowed values
17747 1 - v1 error format
17748 2 - v2 error format
17749
17750 Returns:
17751 An object of the form:
17752
17753 { # Represents an Operation resource.
17754 #
17755 # Google Compute Engine has three Operation resources:
17756 #
17757 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
17758 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
17759 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
17760 #
17761 # You can use an operation resource to manage asynchronous API requests.
17762 # For more information, readHandling
17763 # API responses.
17764 #
17765 # Operations can be global, regional or zonal.
17766 #
17767 # - For global operations, use the `globalOperations`
17768 # resource.
17769 # - For regional operations, use the
17770 # `regionOperations` resource.
17771 # - For zonal operations, use
17772 # the `zoneOperations` resource.
17773 #
17774 #
17775 #
17776 # For more information, read
17777 # Global, Regional, and Zonal Resources.
17778 #
17779 # Note that completed Operation resources have a limited
17780 # retention period.
17781 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17782 # Not present otherwise.
17783 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17784 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17785 # set when the operation is created.
17786 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17787 # text format.
17788 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17789 # this field will be populated.
17790 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17791 # operation.
17792 {
17793 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17794 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17795 # details. There is a set of defined message types to use for providing
17796 # details.The syntax depends on the error code. For example,
17797 # QuotaExceededInfo will have details when the error code is
17798 # QUOTA_EXCEEDED.
17799 {
17800 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17801 #
17802 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17803 # is not enabled:
17804 #
17805 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17806 # &quot;domain&quot;: &quot;googleapis.com&quot;
17807 # &quot;metadata&quot;: {
17808 # &quot;resource&quot;: &quot;projects/123&quot;,
17809 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17810 # }
17811 # }
17812 #
17813 # This response indicates that the pubsub.googleapis.com API is not enabled.
17814 #
17815 # Example of an error that is returned when attempting to create a Spanner
17816 # instance in a region that is out of stock:
17817 #
17818 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17819 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17820 # &quot;metadata&quot;: {
17821 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17822 # }
17823 # }
17824 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17825 # is typically the registered service name of the tool or product that
17826 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17827 # generated by some common infrastructure, the error domain must be a
17828 # globally unique value that identifies the infrastructure. For Google API
17829 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17830 &quot;metadatas&quot;: { # Additional structured details about this error.
17831 #
17832 # Keys must match a regular expression of `a-z+` but should
17833 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17834 # length. When identifying the current value of an exceeded limit, the units
17835 # should be contained in the key, not the value. For example, rather than
17836 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17837 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17838 # instances that can be created in a single (batch) request.
17839 &quot;a_key&quot;: &quot;A String&quot;,
17840 },
17841 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17842 # proximate cause of the error. Error reasons are unique within a particular
17843 # domain of errors. This should be at most 63 characters and match a
17844 # regular expression of `A-Z+[A-Z0-9]`, which represents
17845 # UPPER_SNAKE_CASE.
17846 },
17847 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17848 #
17849 # For example, if a quota check failed with an error indicating the calling
17850 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17851 # directly to the right place in the developer console to flip the bit.
17852 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
17853 { # Describes a URL link.
17854 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
17855 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
17856 },
17857 ],
17858 },
17859 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
17860 # which can be attached to an RPC error.
17861 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
17862 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
17863 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
17864 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
17865 },
17866 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
17867 &quot;dimensions&quot;: { # The map holding related quota dimensions.
17868 &quot;a_key&quot;: &quot;A String&quot;,
17869 },
17870 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
17871 # type or metric.
17872 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
17873 # or metric.
17874 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
17875 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
17876 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
17877 },
17878 },
17879 ],
17880 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
17881 # This property is optional.
17882 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
17883 },
17884 ],
17885 },
17886 &quot;getVersionOperationMetadata&quot;: {
17887 &quot;inlineSbomInfo&quot;: {
17888 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
17889 # appropriate identifiers.
17890 &quot;a_key&quot;: &quot;A String&quot;,
17891 },
17892 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
17893 # identifiers.
17894 &quot;a_key&quot;: &quot;A String&quot;,
17895 },
17896 },
17897 },
17898 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
17899 # message that was returned, such as `NOT FOUND`.
17900 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
17901 # status code that was returned. For example, a `404` means the
17902 # resource was not found.
17903 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
17904 # defined by the server.
17905 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
17906 # This value is inRFC3339
17907 # text format.
17908 &quot;instancesBulkInsertOperationMetadata&quot;: {
17909 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
17910 # Example key: zones/us-central1-a
17911 &quot;a_key&quot;: {
17912 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
17913 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
17914 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
17915 # error.
17916 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
17917 # if the flow is rolling forward or rolling back.
17918 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
17919 },
17920 },
17921 },
17922 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
17923 # Operation resources.
17924 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
17925 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
17926 # group of operations results from a `bulkInsert` API request.
17927 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
17928 # `update`, or `delete`, and so on.
17929 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17930 # There is no requirement that this be linear or support any granularity of
17931 # operations. This should not be used to guess when the operation will be
17932 # complete. This number should monotonically increase as the operation
17933 # progresses.
17934 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17935 # applicable when performing regional operations.
17936 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17937 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
17938 # this field will contain information on all underlying zonal actions and
17939 # their state.
17940 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
17941 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
17942 # Example key: zones/us-central1-a
17943 &quot;a_key&quot;: {
17944 &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
17945 # populated.
17946 # different programming environments, including REST APIs and RPC APIs. It is
17947 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
17948 # three pieces of data: error code, error message, and error details.
17949 #
17950 # You can find out more about this error model and how to work with it in the
17951 # [API Design Guide](https://cloud.google.com/apis/design/errors).
17952 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
17953 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
17954 # message types for APIs to use.
17955 {
17956 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
17957 },
17958 ],
17959 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
17960 # user-facing error message should be localized and sent in the
17961 # google.rpc.Status.details field, or localized by the client.
17962 },
17963 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
17964 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
17965 },
17966 },
17967 },
17968 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
17969 # This value is inRFC3339
17970 # text format.
17971 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
17972 # following:
17973 # `PENDING`, `RUNNING`, or `DONE`.
17974 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
17975 # operation.
17976 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
17977 # of the target resource.
17978 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
17979 # operations related to creating a snapshot, this points to the disk
17980 # that the snapshot was created from.
17981 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
17982 # `[email protected]` or
17983 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
17984 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
17985 # operation, this field will be populated.
17986 {
17987 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
17988 # Engine returns NO_RESULTS_ON_PAGE if there
17989 # are no results in the response.
17990 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
17991 # value format. For example:
17992 #
17993 # &quot;data&quot;: [
17994 # {
17995 # &quot;key&quot;: &quot;scope&quot;,
17996 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
17997 # }
17998 {
17999 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18000 # returned. For example, for warnings where there are no results in a list
18001 # request for a particular zone, this key might be scope and
18002 # the key value might be the zone name. Other examples might be a key
18003 # indicating a deprecated resource and a suggested replacement, or a
18004 # warning about invalid network settings (for example, if an instance
18005 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18006 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18007 },
18008 ],
18009 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18010 },
18011 ],
18012 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18013 # applicable when performing per-zone operations.
18014 }</pre>
18015 </div>
18016
18017 <div class="method">
18018 <code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
18019 <pre>Sets an instance&#x27;s scheduling options. You can only call this method on astopped instance,
18020 that is, a VM instance that is in a `TERMINATED` state. SeeInstance Life
18021 Cycle for more information on the possible instance states.
18022 For more information about setting scheduling options for a VM, seeSet
18023 VM host maintenance policy.
18024
18025 Args:
18026 project: string, Project ID for this request. (required)
18027 zone: string, The name of the zone for this request. (required)
18028 instance: string, Instance name for this request. (required)
18029 body: object, The request body.
18030 The object takes the form of:
18031
18032 { # Sets the scheduling options for an Instance.
18033 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
18034 # terminated by Compute Engine (not terminated by a user). You can only set
18035 # the automatic restart option for standard instances.Preemptible instances
18036 # cannot be automatically restarted.
18037 #
18038 # By default, this is set to true so an instance is
18039 # automatically restarted if it is terminated by Compute Engine.
18040 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
18041 # must be a number between 1 and the number of availability domains
18042 # specified in the spread placement policy attached to the instance.
18043 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
18044 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
18045 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the
18046 # graceful shutdown isn&#x27;t complete after this time, then the instance
18047 # transitions to the STOPPING state.
18048 # as a count of seconds and fractions of seconds at nanosecond
18049 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
18050 # or &quot;month&quot;. Range is approximately 10,000 years.
18051 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
18052 # Durations less than one second are represented with a 0
18053 # `seconds` field and a positive `nanos` field. Must be from 0
18054 # to 999,999,999 inclusive.
18055 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
18056 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
18057 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
18058 },
18059 },
18060 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
18061 # within the range of [90, 330] with the increment of 30, if unset, the
18062 # default behavior of host error recovery will be used.
18063 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
18064 &quot;localSsdRecoveryTimeout&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
18065 # recovery of the Local Ssd state is attempted. Its value should be in
18066 # between 0 and 168 hours with hour granularity and the default value being 1
18067 # hour.
18068 # as a count of seconds and fractions of seconds at nanosecond
18069 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
18070 # or &quot;month&quot;. Range is approximately 10,000 years.
18071 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
18072 # Durations less than one second are represented with a 0
18073 # `seconds` field and a positive `nanos` field. Must be from 0
18074 # to 999,999,999 inclusive.
18075 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
18076 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
18077 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
18078 },
18079 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
18080 # resources.
18081 # This field is for use by internal tools that use the public API.
18082 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
18083 # be scheduled for maintenance.
18084 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
18085 # are: `PERIODIC`.
18086 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
18087 # the instance termination action will be performed at the end of the run
18088 # duration.
18089 # as a count of seconds and fractions of seconds at nanosecond
18090 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
18091 # or &quot;month&quot;. Range is approximately 10,000 years.
18092 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
18093 # Durations less than one second are represented with a 0
18094 # `seconds` field and a positive `nanos` field. Must be from 0
18095 # to 999,999,999 inclusive.
18096 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
18097 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
18098 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
18099 },
18100 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
18101 # on a sole-tenant node.
18102 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
18103 # affinity for more information.
18104 # Overrides reservationAffinity.
18105 { # Node Affinity: the configuration of desired nodes onto which this Instance
18106 # could be scheduled.
18107 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
18108 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
18109 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
18110 &quot;A String&quot;,
18111 ],
18112 },
18113 ],
18114 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
18115 # the default behavior is MIGRATE. Forpreemptible instances,
18116 # the default and only possible behavior is TERMINATE. For more
18117 # information, see
18118 # Set
18119 # VM host maintenance policy.
18120 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
18121 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
18122 # else, the Local SSD data will be preserved when the instance is stopped
18123 # at the end of the run duration/termination time.
18124 },
18125 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
18126 # instance creation or while the instance isstopped and
18127 # therefore, in a `TERMINATED` state. SeeInstance Life
18128 # Cycle for more information on the possible instance states.
18129 &quot;preemptionNoticeDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
18130 # Off signal is triggered for Spot
18131 # VMs only. If not specified, there will be no wait before the G2 Soft
18132 # Off signal is triggered.
18133 # as a count of seconds and fractions of seconds at nanosecond
18134 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
18135 # or &quot;month&quot;. Range is approximately 10,000 years.
18136 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
18137 # Durations less than one second are represented with a 0
18138 # `seconds` field and a positive `nanos` field. Must be from 0
18139 # to 999,999,999 inclusive.
18140 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
18141 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
18142 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
18143 },
18144 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
18145 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
18146 # Off and ACPI G3 Mechanical
18147 # Off for Standard VMs and 30 seconds for Spot VMs.
18148 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
18149 # termination action will be performed at the termination time.
18150 }
18151
18152 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18153 that if you must retry your request, the server will know to ignore the
18154 request if it has already been completed.
18155
18156 For example, consider a situation where you make an initial request and
18157 the request times out. If you make the request again with the same
18158 request ID, the server can check if original operation with the same
18159 request ID was received, and if so, will ignore the second request. This
18160 prevents clients from accidentally creating duplicate commitments.
18161
18162 The request ID must be
18163 a valid UUID with the exception that zero UUID is not supported
18164 (00000000-0000-0000-0000-000000000000).
18165 x__xgafv: string, V1 error format.
18166 Allowed values
18167 1 - v1 error format
18168 2 - v2 error format
18169
18170 Returns:
18171 An object of the form:
18172
18173 { # Represents an Operation resource.
18174 #
18175 # Google Compute Engine has three Operation resources:
18176 #
18177 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
18178 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
18179 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
18180 #
18181 # You can use an operation resource to manage asynchronous API requests.
18182 # For more information, readHandling
18183 # API responses.
18184 #
18185 # Operations can be global, regional or zonal.
18186 #
18187 # - For global operations, use the `globalOperations`
18188 # resource.
18189 # - For regional operations, use the
18190 # `regionOperations` resource.
18191 # - For zonal operations, use
18192 # the `zoneOperations` resource.
18193 #
18194 #
18195 #
18196 # For more information, read
18197 # Global, Regional, and Zonal Resources.
18198 #
18199 # Note that completed Operation resources have a limited
18200 # retention period.
18201 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
18202 # Not present otherwise.
18203 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
18204 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
18205 # set when the operation is created.
18206 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
18207 # text format.
18208 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
18209 # this field will be populated.
18210 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
18211 # operation.
18212 {
18213 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
18214 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
18215 # details. There is a set of defined message types to use for providing
18216 # details.The syntax depends on the error code. For example,
18217 # QuotaExceededInfo will have details when the error code is
18218 # QUOTA_EXCEEDED.
18219 {
18220 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
18221 #
18222 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
18223 # is not enabled:
18224 #
18225 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
18226 # &quot;domain&quot;: &quot;googleapis.com&quot;
18227 # &quot;metadata&quot;: {
18228 # &quot;resource&quot;: &quot;projects/123&quot;,
18229 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
18230 # }
18231 # }
18232 #
18233 # This response indicates that the pubsub.googleapis.com API is not enabled.
18234 #
18235 # Example of an error that is returned when attempting to create a Spanner
18236 # instance in a region that is out of stock:
18237 #
18238 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
18239 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
18240 # &quot;metadata&quot;: {
18241 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
18242 # }
18243 # }
18244 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
18245 # is typically the registered service name of the tool or product that
18246 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
18247 # generated by some common infrastructure, the error domain must be a
18248 # globally unique value that identifies the infrastructure. For Google API
18249 # infrastructure, the error domain is &quot;googleapis.com&quot;.
18250 &quot;metadatas&quot;: { # Additional structured details about this error.
18251 #
18252 # Keys must match a regular expression of `a-z+` but should
18253 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
18254 # length. When identifying the current value of an exceeded limit, the units
18255 # should be contained in the key, not the value. For example, rather than
18256 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
18257 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
18258 # instances that can be created in a single (batch) request.
18259 &quot;a_key&quot;: &quot;A String&quot;,
18260 },
18261 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
18262 # proximate cause of the error. Error reasons are unique within a particular
18263 # domain of errors. This should be at most 63 characters and match a
18264 # regular expression of `A-Z+[A-Z0-9]`, which represents
18265 # UPPER_SNAKE_CASE.
18266 },
18267 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
18268 #
18269 # For example, if a quota check failed with an error indicating the calling
18270 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
18271 # directly to the right place in the developer console to flip the bit.
18272 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18273 { # Describes a URL link.
18274 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18275 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18276 },
18277 ],
18278 },
18279 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18280 # which can be attached to an RPC error.
18281 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18282 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18283 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18284 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18285 },
18286 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18287 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18288 &quot;a_key&quot;: &quot;A String&quot;,
18289 },
18290 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18291 # type or metric.
18292 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18293 # or metric.
18294 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18295 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18296 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18297 },
18298 },
18299 ],
18300 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18301 # This property is optional.
18302 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18303 },
18304 ],
18305 },
18306 &quot;getVersionOperationMetadata&quot;: {
18307 &quot;inlineSbomInfo&quot;: {
18308 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
18309 # appropriate identifiers.
18310 &quot;a_key&quot;: &quot;A String&quot;,
18311 },
18312 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
18313 # identifiers.
18314 &quot;a_key&quot;: &quot;A String&quot;,
18315 },
18316 },
18317 },
18318 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
18319 # message that was returned, such as `NOT FOUND`.
18320 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
18321 # status code that was returned. For example, a `404` means the
18322 # resource was not found.
18323 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
18324 # defined by the server.
18325 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
18326 # This value is inRFC3339
18327 # text format.
18328 &quot;instancesBulkInsertOperationMetadata&quot;: {
18329 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
18330 # Example key: zones/us-central1-a
18331 &quot;a_key&quot;: {
18332 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
18333 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
18334 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
18335 # error.
18336 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
18337 # if the flow is rolling forward or rolling back.
18338 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
18339 },
18340 },
18341 },
18342 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
18343 # Operation resources.
18344 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
18345 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
18346 # group of operations results from a `bulkInsert` API request.
18347 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
18348 # `update`, or `delete`, and so on.
18349 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
18350 # There is no requirement that this be linear or support any granularity of
18351 # operations. This should not be used to guess when the operation will be
18352 # complete. This number should monotonically increase as the operation
18353 # progresses.
18354 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
18355 # applicable when performing regional operations.
18356 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
18357 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
18358 # this field will contain information on all underlying zonal actions and
18359 # their state.
18360 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
18361 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
18362 # Example key: zones/us-central1-a
18363 &quot;a_key&quot;: {
18364 &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
18365 # populated.
18366 # different programming environments, including REST APIs and RPC APIs. It is
18367 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
18368 # three pieces of data: error code, error message, and error details.
18369 #
18370 # You can find out more about this error model and how to work with it in the
18371 # [API Design Guide](https://cloud.google.com/apis/design/errors).
18372 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
18373 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
18374 # message types for APIs to use.
18375 {
18376 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
18377 },
18378 ],
18379 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
18380 # user-facing error message should be localized and sent in the
18381 # google.rpc.Status.details field, or localized by the client.
18382 },
18383 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
18384 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
18385 },
18386 },
18387 },
18388 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
18389 # This value is inRFC3339
18390 # text format.
18391 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
18392 # following:
18393 # `PENDING`, `RUNNING`, or `DONE`.
18394 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
18395 # operation.
18396 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
18397 # of the target resource.
18398 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
18399 # operations related to creating a snapshot, this points to the disk
18400 # that the snapshot was created from.
18401 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
18402 # `[email protected]` or
18403 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
18404 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
18405 # operation, this field will be populated.
18406 {
18407 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
18408 # Engine returns NO_RESULTS_ON_PAGE if there
18409 # are no results in the response.
18410 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
18411 # value format. For example:
18412 #
18413 # &quot;data&quot;: [
18414 # {
18415 # &quot;key&quot;: &quot;scope&quot;,
18416 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
18417 # }
18418 {
18419 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18420 # returned. For example, for warnings where there are no results in a list
18421 # request for a particular zone, this key might be scope and
18422 # the key value might be the zone name. Other examples might be a key
18423 # indicating a deprecated resource and a suggested replacement, or a
18424 # warning about invalid network settings (for example, if an instance
18425 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18426 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18427 },
18428 ],
18429 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18430 },
18431 ],
18432 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18433 # applicable when performing per-zone operations.
18434 }</pre>
18435 </div>
18436
18437 <div class="method">
18438 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
18439 <pre>Sets the Google Cloud Armor security policy for the specified instance.
18440 For more information, seeGoogle
18441 Cloud Armor Overview
18442
18443 Args:
18444 project: string, Project ID for this request. (required)
18445 zone: string, Name of the zone scoping this request. (required)
18446 instance: string, Name of the Instance resource to which the security policy should be
18447 set. The name should conform to RFC1035. (required)
18448 body: object, The request body.
18449 The object takes the form of:
18450
18451 {
18452 &quot;networkInterfaces&quot;: [ # The network interfaces that the security policy will be applied to. Network
18453 # interfaces use the nicN naming format. You can only set a
18454 # security policy for network interfaces with an access config.
18455 &quot;A String&quot;,
18456 ],
18457 &quot;securityPolicy&quot;: &quot;A String&quot;, # A full or partial URL to a security policy to add to this instance.
18458 # If this field is set to an empty string it will remove the associated
18459 # security policy.
18460 }
18461
18462 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18463 that if you must retry your request, the server will know to ignore the
18464 request if it has already been completed.
18465
18466 For example, consider a situation where you make an initial request and
18467 the request times out. If you make the request again with the same
18468 request ID, the server can check if original operation with the same
18469 request ID was received, and if so, will ignore the second request. This
18470 prevents clients from accidentally creating duplicate commitments.
18471
18472 The request ID must be
18473 a valid UUID with the exception that zero UUID is not supported
18474 (00000000-0000-0000-0000-000000000000).
18475 x__xgafv: string, V1 error format.
18476 Allowed values
18477 1 - v1 error format
18478 2 - v2 error format
18479
18480 Returns:
18481 An object of the form:
18482
18483 { # Represents an Operation resource.
18484 #
18485 # Google Compute Engine has three Operation resources:
18486 #
18487 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
18488 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
18489 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
18490 #
18491 # You can use an operation resource to manage asynchronous API requests.
18492 # For more information, readHandling
18493 # API responses.
18494 #
18495 # Operations can be global, regional or zonal.
18496 #
18497 # - For global operations, use the `globalOperations`
18498 # resource.
18499 # - For regional operations, use the
18500 # `regionOperations` resource.
18501 # - For zonal operations, use
18502 # the `zoneOperations` resource.
18503 #
18504 #
18505 #
18506 # For more information, read
18507 # Global, Regional, and Zonal Resources.
18508 #
18509 # Note that completed Operation resources have a limited
18510 # retention period.
18511 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
18512 # Not present otherwise.
18513 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
18514 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
18515 # set when the operation is created.
18516 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
18517 # text format.
18518 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
18519 # this field will be populated.
18520 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
18521 # operation.
18522 {
18523 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
18524 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
18525 # details. There is a set of defined message types to use for providing
18526 # details.The syntax depends on the error code. For example,
18527 # QuotaExceededInfo will have details when the error code is
18528 # QUOTA_EXCEEDED.
18529 {
18530 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
18531 #
18532 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
18533 # is not enabled:
18534 #
18535 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
18536 # &quot;domain&quot;: &quot;googleapis.com&quot;
18537 # &quot;metadata&quot;: {
18538 # &quot;resource&quot;: &quot;projects/123&quot;,
18539 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
18540 # }
18541 # }
18542 #
18543 # This response indicates that the pubsub.googleapis.com API is not enabled.
18544 #
18545 # Example of an error that is returned when attempting to create a Spanner
18546 # instance in a region that is out of stock:
18547 #
18548 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
18549 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
18550 # &quot;metadata&quot;: {
18551 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
18552 # }
18553 # }
18554 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
18555 # is typically the registered service name of the tool or product that
18556 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
18557 # generated by some common infrastructure, the error domain must be a
18558 # globally unique value that identifies the infrastructure. For Google API
18559 # infrastructure, the error domain is &quot;googleapis.com&quot;.
18560 &quot;metadatas&quot;: { # Additional structured details about this error.
18561 #
18562 # Keys must match a regular expression of `a-z+` but should
18563 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
18564 # length. When identifying the current value of an exceeded limit, the units
18565 # should be contained in the key, not the value. For example, rather than
18566 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
18567 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
18568 # instances that can be created in a single (batch) request.
18569 &quot;a_key&quot;: &quot;A String&quot;,
18570 },
18571 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
18572 # proximate cause of the error. Error reasons are unique within a particular
18573 # domain of errors. This should be at most 63 characters and match a
18574 # regular expression of `A-Z+[A-Z0-9]`, which represents
18575 # UPPER_SNAKE_CASE.
18576 },
18577 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
18578 #
18579 # For example, if a quota check failed with an error indicating the calling
18580 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
18581 # directly to the right place in the developer console to flip the bit.
18582 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18583 { # Describes a URL link.
18584 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18585 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18586 },
18587 ],
18588 },
18589 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18590 # which can be attached to an RPC error.
18591 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18592 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18593 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18594 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18595 },
18596 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18597 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18598 &quot;a_key&quot;: &quot;A String&quot;,
18599 },
18600 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18601 # type or metric.
18602 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18603 # or metric.
18604 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18605 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18606 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18607 },
18608 },
18609 ],
18610 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18611 # This property is optional.
18612 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18613 },
18614 ],
18615 },
18616 &quot;getVersionOperationMetadata&quot;: {
18617 &quot;inlineSbomInfo&quot;: {
18618 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
18619 # appropriate identifiers.
18620 &quot;a_key&quot;: &quot;A String&quot;,
18621 },
18622 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
18623 # identifiers.
18624 &quot;a_key&quot;: &quot;A String&quot;,
18625 },
18626 },
18627 },
18628 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
18629 # message that was returned, such as `NOT FOUND`.
18630 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
18631 # status code that was returned. For example, a `404` means the
18632 # resource was not found.
18633 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
18634 # defined by the server.
18635 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
18636 # This value is inRFC3339
18637 # text format.
18638 &quot;instancesBulkInsertOperationMetadata&quot;: {
18639 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
18640 # Example key: zones/us-central1-a
18641 &quot;a_key&quot;: {
18642 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
18643 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
18644 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
18645 # error.
18646 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
18647 # if the flow is rolling forward or rolling back.
18648 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
18649 },
18650 },
18651 },
18652 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
18653 # Operation resources.
18654 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
18655 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
18656 # group of operations results from a `bulkInsert` API request.
18657 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
18658 # `update`, or `delete`, and so on.
18659 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
18660 # There is no requirement that this be linear or support any granularity of
18661 # operations. This should not be used to guess when the operation will be
18662 # complete. This number should monotonically increase as the operation
18663 # progresses.
18664 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
18665 # applicable when performing regional operations.
18666 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
18667 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
18668 # this field will contain information on all underlying zonal actions and
18669 # their state.
18670 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
18671 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
18672 # Example key: zones/us-central1-a
18673 &quot;a_key&quot;: {
18674 &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
18675 # populated.
18676 # different programming environments, including REST APIs and RPC APIs. It is
18677 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
18678 # three pieces of data: error code, error message, and error details.
18679 #
18680 # You can find out more about this error model and how to work with it in the
18681 # [API Design Guide](https://cloud.google.com/apis/design/errors).
18682 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
18683 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
18684 # message types for APIs to use.
18685 {
18686 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
18687 },
18688 ],
18689 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
18690 # user-facing error message should be localized and sent in the
18691 # google.rpc.Status.details field, or localized by the client.
18692 },
18693 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
18694 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
18695 },
18696 },
18697 },
18698 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
18699 # This value is inRFC3339
18700 # text format.
18701 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
18702 # following:
18703 # `PENDING`, `RUNNING`, or `DONE`.
18704 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
18705 # operation.
18706 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
18707 # of the target resource.
18708 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
18709 # operations related to creating a snapshot, this points to the disk
18710 # that the snapshot was created from.
18711 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
18712 # `[email protected]` or
18713 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
18714 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
18715 # operation, this field will be populated.
18716 {
18717 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
18718 # Engine returns NO_RESULTS_ON_PAGE if there
18719 # are no results in the response.
18720 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
18721 # value format. For example:
18722 #
18723 # &quot;data&quot;: [
18724 # {
18725 # &quot;key&quot;: &quot;scope&quot;,
18726 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
18727 # }
18728 {
18729 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18730 # returned. For example, for warnings where there are no results in a list
18731 # request for a particular zone, this key might be scope and
18732 # the key value might be the zone name. Other examples might be a key
18733 # indicating a deprecated resource and a suggested replacement, or a
18734 # warning about invalid network settings (for example, if an instance
18735 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18736 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18737 },
18738 ],
18739 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18740 },
18741 ],
18742 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18743 # applicable when performing per-zone operations.
18744 }</pre>
18745 </div>
18746
18747 <div class="method">
18748 <code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
18749 <pre>Sets the service account on the instance. For more information,
18750 readChanging
18751 the service account and access scopes for an instance.
18752
18753 Args:
18754 project: string, Project ID for this request. (required)
18755 zone: string, The name of the zone for this request. (required)
18756 instance: string, Name of the instance resource to start. (required)
18757 body: object, The request body.
18758 The object takes the form of:
18759
18760 {
18761 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
18762 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
18763 &quot;A String&quot;,
18764 ],
18765 }
18766
18767 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18768 that if you must retry your request, the server will know to ignore the
18769 request if it has already been completed.
18770
18771 For example, consider a situation where you make an initial request and
18772 the request times out. If you make the request again with the same
18773 request ID, the server can check if original operation with the same
18774 request ID was received, and if so, will ignore the second request. This
18775 prevents clients from accidentally creating duplicate commitments.
18776
18777 The request ID must be
18778 a valid UUID with the exception that zero UUID is not supported
18779 (00000000-0000-0000-0000-000000000000).
18780 x__xgafv: string, V1 error format.
18781 Allowed values
18782 1 - v1 error format
18783 2 - v2 error format
18784
18785 Returns:
18786 An object of the form:
18787
18788 { # Represents an Operation resource.
18789 #
18790 # Google Compute Engine has three Operation resources:
18791 #
18792 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
18793 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
18794 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
18795 #
18796 # You can use an operation resource to manage asynchronous API requests.
18797 # For more information, readHandling
18798 # API responses.
18799 #
18800 # Operations can be global, regional or zonal.
18801 #
18802 # - For global operations, use the `globalOperations`
18803 # resource.
18804 # - For regional operations, use the
18805 # `regionOperations` resource.
18806 # - For zonal operations, use
18807 # the `zoneOperations` resource.
18808 #
18809 #
18810 #
18811 # For more information, read
18812 # Global, Regional, and Zonal Resources.
18813 #
18814 # Note that completed Operation resources have a limited
18815 # retention period.
18816 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
18817 # Not present otherwise.
18818 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
18819 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
18820 # set when the operation is created.
18821 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
18822 # text format.
18823 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
18824 # this field will be populated.
18825 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
18826 # operation.
18827 {
18828 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
18829 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
18830 # details. There is a set of defined message types to use for providing
18831 # details.The syntax depends on the error code. For example,
18832 # QuotaExceededInfo will have details when the error code is
18833 # QUOTA_EXCEEDED.
18834 {
18835 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
18836 #
18837 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
18838 # is not enabled:
18839 #
18840 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
18841 # &quot;domain&quot;: &quot;googleapis.com&quot;
18842 # &quot;metadata&quot;: {
18843 # &quot;resource&quot;: &quot;projects/123&quot;,
18844 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
18845 # }
18846 # }
18847 #
18848 # This response indicates that the pubsub.googleapis.com API is not enabled.
18849 #
18850 # Example of an error that is returned when attempting to create a Spanner
18851 # instance in a region that is out of stock:
18852 #
18853 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
18854 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
18855 # &quot;metadata&quot;: {
18856 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
18857 # }
18858 # }
18859 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
18860 # is typically the registered service name of the tool or product that
18861 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
18862 # generated by some common infrastructure, the error domain must be a
18863 # globally unique value that identifies the infrastructure. For Google API
18864 # infrastructure, the error domain is &quot;googleapis.com&quot;.
18865 &quot;metadatas&quot;: { # Additional structured details about this error.
18866 #
18867 # Keys must match a regular expression of `a-z+` but should
18868 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
18869 # length. When identifying the current value of an exceeded limit, the units
18870 # should be contained in the key, not the value. For example, rather than
18871 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
18872 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
18873 # instances that can be created in a single (batch) request.
18874 &quot;a_key&quot;: &quot;A String&quot;,
18875 },
18876 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
18877 # proximate cause of the error. Error reasons are unique within a particular
18878 # domain of errors. This should be at most 63 characters and match a
18879 # regular expression of `A-Z+[A-Z0-9]`, which represents
18880 # UPPER_SNAKE_CASE.
18881 },
18882 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
18883 #
18884 # For example, if a quota check failed with an error indicating the calling
18885 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
18886 # directly to the right place in the developer console to flip the bit.
18887 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18888 { # Describes a URL link.
18889 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18890 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18891 },
18892 ],
18893 },
18894 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18895 # which can be attached to an RPC error.
18896 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18897 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18898 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18899 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18900 },
18901 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18902 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18903 &quot;a_key&quot;: &quot;A String&quot;,
18904 },
18905 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18906 # type or metric.
18907 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18908 # or metric.
18909 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18910 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18911 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18912 },
18913 },
18914 ],
18915 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18916 # This property is optional.
18917 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18918 },
18919 ],
18920 },
18921 &quot;getVersionOperationMetadata&quot;: {
18922 &quot;inlineSbomInfo&quot;: {
18923 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
18924 # appropriate identifiers.
18925 &quot;a_key&quot;: &quot;A String&quot;,
18926 },
18927 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
18928 # identifiers.
18929 &quot;a_key&quot;: &quot;A String&quot;,
18930 },
18931 },
18932 },
18933 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
18934 # message that was returned, such as `NOT FOUND`.
18935 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
18936 # status code that was returned. For example, a `404` means the
18937 # resource was not found.
18938 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
18939 # defined by the server.
18940 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
18941 # This value is inRFC3339
18942 # text format.
18943 &quot;instancesBulkInsertOperationMetadata&quot;: {
18944 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
18945 # Example key: zones/us-central1-a
18946 &quot;a_key&quot;: {
18947 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
18948 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
18949 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
18950 # error.
18951 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
18952 # if the flow is rolling forward or rolling back.
18953 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
18954 },
18955 },
18956 },
18957 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
18958 # Operation resources.
18959 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
18960 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
18961 # group of operations results from a `bulkInsert` API request.
18962 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
18963 # `update`, or `delete`, and so on.
18964 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
18965 # There is no requirement that this be linear or support any granularity of
18966 # operations. This should not be used to guess when the operation will be
18967 # complete. This number should monotonically increase as the operation
18968 # progresses.
18969 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
18970 # applicable when performing regional operations.
18971 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
18972 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
18973 # this field will contain information on all underlying zonal actions and
18974 # their state.
18975 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
18976 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
18977 # Example key: zones/us-central1-a
18978 &quot;a_key&quot;: {
18979 &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
18980 # populated.
18981 # different programming environments, including REST APIs and RPC APIs. It is
18982 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
18983 # three pieces of data: error code, error message, and error details.
18984 #
18985 # You can find out more about this error model and how to work with it in the
18986 # [API Design Guide](https://cloud.google.com/apis/design/errors).
18987 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
18988 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
18989 # message types for APIs to use.
18990 {
18991 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
18992 },
18993 ],
18994 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
18995 # user-facing error message should be localized and sent in the
18996 # google.rpc.Status.details field, or localized by the client.
18997 },
18998 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
18999 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
19000 },
19001 },
19002 },
19003 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
19004 # This value is inRFC3339
19005 # text format.
19006 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
19007 # following:
19008 # `PENDING`, `RUNNING`, or `DONE`.
19009 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
19010 # operation.
19011 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
19012 # of the target resource.
19013 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
19014 # operations related to creating a snapshot, this points to the disk
19015 # that the snapshot was created from.
19016 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
19017 # `[email protected]` or
19018 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
19019 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
19020 # operation, this field will be populated.
19021 {
19022 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
19023 # Engine returns NO_RESULTS_ON_PAGE if there
19024 # are no results in the response.
19025 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
19026 # value format. For example:
19027 #
19028 # &quot;data&quot;: [
19029 # {
19030 # &quot;key&quot;: &quot;scope&quot;,
19031 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
19032 # }
19033 {
19034 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
19035 # returned. For example, for warnings where there are no results in a list
19036 # request for a particular zone, this key might be scope and
19037 # the key value might be the zone name. Other examples might be a key
19038 # indicating a deprecated resource and a suggested replacement, or a
19039 # warning about invalid network settings (for example, if an instance
19040 # attempts to perform IP forwarding but is not enabled for IP forwarding).
19041 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
19042 },
19043 ],
19044 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
19045 },
19046 ],
19047 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
19048 # applicable when performing per-zone operations.
19049 }</pre>
19050 </div>
19051
19052 <div class="method">
19053 <code class="details" id="setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
19054 <pre>Sets the Shielded Instance integrity policy for an instance. You can
19055 only use this method on a running instance. This method
19056 supports PATCH semantics and uses the JSON merge
19057 patch format and processing rules.
19058
19059 Args:
19060 project: string, Project ID for this request. (required)
19061 zone: string, The name of the zone for this request. (required)
19062 instance: string, Name or id of the instance scoping this request. (required)
19063 body: object, The request body.
19064 The object takes the form of:
19065
19066 { # The policy describes the baseline against which
19067 # Instance boot integrity is measured.
19068 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
19069 # measurements from the VM instance&#x27;s most recent boot.
19070 }
19071
19072 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
19073 that if you must retry your request, the server will know to ignore the
19074 request if it has already been completed.
19075
19076 For example, consider a situation where you make an initial request and
19077 the request times out. If you make the request again with the same
19078 request ID, the server can check if original operation with the same
19079 request ID was received, and if so, will ignore the second request. This
19080 prevents clients from accidentally creating duplicate commitments.
19081
19082 The request ID must be
19083 a valid UUID with the exception that zero UUID is not supported
19084 (00000000-0000-0000-0000-000000000000).
19085 x__xgafv: string, V1 error format.
19086 Allowed values
19087 1 - v1 error format
19088 2 - v2 error format
19089
19090 Returns:
19091 An object of the form:
19092
19093 { # Represents an Operation resource.
19094 #
19095 # Google Compute Engine has three Operation resources:
19096 #
19097 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
19098 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
19099 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
19100 #
19101 # You can use an operation resource to manage asynchronous API requests.
19102 # For more information, readHandling
19103 # API responses.
19104 #
19105 # Operations can be global, regional or zonal.
19106 #
19107 # - For global operations, use the `globalOperations`
19108 # resource.
19109 # - For regional operations, use the
19110 # `regionOperations` resource.
19111 # - For zonal operations, use
19112 # the `zoneOperations` resource.
19113 #
19114 #
19115 #
19116 # For more information, read
19117 # Global, Regional, and Zonal Resources.
19118 #
19119 # Note that completed Operation resources have a limited
19120 # retention period.
19121 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
19122 # Not present otherwise.
19123 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
19124 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
19125 # set when the operation is created.
19126 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
19127 # text format.
19128 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
19129 # this field will be populated.
19130 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
19131 # operation.
19132 {
19133 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
19134 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
19135 # details. There is a set of defined message types to use for providing
19136 # details.The syntax depends on the error code. For example,
19137 # QuotaExceededInfo will have details when the error code is
19138 # QUOTA_EXCEEDED.
19139 {
19140 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
19141 #
19142 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
19143 # is not enabled:
19144 #
19145 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
19146 # &quot;domain&quot;: &quot;googleapis.com&quot;
19147 # &quot;metadata&quot;: {
19148 # &quot;resource&quot;: &quot;projects/123&quot;,
19149 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
19150 # }
19151 # }
19152 #
19153 # This response indicates that the pubsub.googleapis.com API is not enabled.
19154 #
19155 # Example of an error that is returned when attempting to create a Spanner
19156 # instance in a region that is out of stock:
19157 #
19158 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
19159 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
19160 # &quot;metadata&quot;: {
19161 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
19162 # }
19163 # }
19164 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
19165 # is typically the registered service name of the tool or product that
19166 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
19167 # generated by some common infrastructure, the error domain must be a
19168 # globally unique value that identifies the infrastructure. For Google API
19169 # infrastructure, the error domain is &quot;googleapis.com&quot;.
19170 &quot;metadatas&quot;: { # Additional structured details about this error.
19171 #
19172 # Keys must match a regular expression of `a-z+` but should
19173 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
19174 # length. When identifying the current value of an exceeded limit, the units
19175 # should be contained in the key, not the value. For example, rather than
19176 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
19177 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
19178 # instances that can be created in a single (batch) request.
19179 &quot;a_key&quot;: &quot;A String&quot;,
19180 },
19181 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
19182 # proximate cause of the error. Error reasons are unique within a particular
19183 # domain of errors. This should be at most 63 characters and match a
19184 # regular expression of `A-Z+[A-Z0-9]`, which represents
19185 # UPPER_SNAKE_CASE.
19186 },
19187 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
19188 #
19189 # For example, if a quota check failed with an error indicating the calling
19190 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
19191 # directly to the right place in the developer console to flip the bit.
19192 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
19193 { # Describes a URL link.
19194 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
19195 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
19196 },
19197 ],
19198 },
19199 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
19200 # which can be attached to an RPC error.
19201 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
19202 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
19203 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
19204 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
19205 },
19206 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
19207 &quot;dimensions&quot;: { # The map holding related quota dimensions.
19208 &quot;a_key&quot;: &quot;A String&quot;,
19209 },
19210 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
19211 # type or metric.
19212 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
19213 # or metric.
19214 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
19215 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
19216 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
19217 },
19218 },
19219 ],
19220 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
19221 # This property is optional.
19222 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
19223 },
19224 ],
19225 },
19226 &quot;getVersionOperationMetadata&quot;: {
19227 &quot;inlineSbomInfo&quot;: {
19228 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
19229 # appropriate identifiers.
19230 &quot;a_key&quot;: &quot;A String&quot;,
19231 },
19232 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
19233 # identifiers.
19234 &quot;a_key&quot;: &quot;A String&quot;,
19235 },
19236 },
19237 },
19238 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
19239 # message that was returned, such as `NOT FOUND`.
19240 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
19241 # status code that was returned. For example, a `404` means the
19242 # resource was not found.
19243 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
19244 # defined by the server.
19245 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
19246 # This value is inRFC3339
19247 # text format.
19248 &quot;instancesBulkInsertOperationMetadata&quot;: {
19249 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
19250 # Example key: zones/us-central1-a
19251 &quot;a_key&quot;: {
19252 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
19253 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
19254 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
19255 # error.
19256 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
19257 # if the flow is rolling forward or rolling back.
19258 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
19259 },
19260 },
19261 },
19262 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
19263 # Operation resources.
19264 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
19265 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
19266 # group of operations results from a `bulkInsert` API request.
19267 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
19268 # `update`, or `delete`, and so on.
19269 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
19270 # There is no requirement that this be linear or support any granularity of
19271 # operations. This should not be used to guess when the operation will be
19272 # complete. This number should monotonically increase as the operation
19273 # progresses.
19274 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
19275 # applicable when performing regional operations.
19276 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
19277 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
19278 # this field will contain information on all underlying zonal actions and
19279 # their state.
19280 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
19281 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
19282 # Example key: zones/us-central1-a
19283 &quot;a_key&quot;: {
19284 &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
19285 # populated.
19286 # different programming environments, including REST APIs and RPC APIs. It is
19287 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
19288 # three pieces of data: error code, error message, and error details.
19289 #
19290 # You can find out more about this error model and how to work with it in the
19291 # [API Design Guide](https://cloud.google.com/apis/design/errors).
19292 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
19293 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
19294 # message types for APIs to use.
19295 {
19296 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
19297 },
19298 ],
19299 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
19300 # user-facing error message should be localized and sent in the
19301 # google.rpc.Status.details field, or localized by the client.
19302 },
19303 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
19304 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
19305 },
19306 },
19307 },
19308 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
19309 # This value is inRFC3339
19310 # text format.
19311 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
19312 # following:
19313 # `PENDING`, `RUNNING`, or `DONE`.
19314 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
19315 # operation.
19316 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
19317 # of the target resource.
19318 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
19319 # operations related to creating a snapshot, this points to the disk
19320 # that the snapshot was created from.
19321 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
19322 # `[email protected]` or
19323 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
19324 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
19325 # operation, this field will be populated.
19326 {
19327 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
19328 # Engine returns NO_RESULTS_ON_PAGE if there
19329 # are no results in the response.
19330 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
19331 # value format. For example:
19332 #
19333 # &quot;data&quot;: [
19334 # {
19335 # &quot;key&quot;: &quot;scope&quot;,
19336 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
19337 # }
19338 {
19339 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
19340 # returned. For example, for warnings where there are no results in a list
19341 # request for a particular zone, this key might be scope and
19342 # the key value might be the zone name. Other examples might be a key
19343 # indicating a deprecated resource and a suggested replacement, or a
19344 # warning about invalid network settings (for example, if an instance
19345 # attempts to perform IP forwarding but is not enabled for IP forwarding).
19346 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
19347 },
19348 ],
19349 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
19350 },
19351 ],
19352 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
19353 # applicable when performing per-zone operations.
19354 }</pre>
19355 </div>
19356
19357 <div class="method">
19358 <code class="details" id="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
19359 <pre>Sets the Shielded VM integrity policy for a VM instance. You can
19360 only use this method on a running VM instance. This method
19361 supports PATCH semantics and uses the JSON merge
19362 patch format and processing rules.
19363
19364 Args:
19365 project: string, Project ID for this request. (required)
19366 zone: string, The name of the zone for this request. (required)
19367 instance: string, Name of the instance scoping this request. (required)
19368 body: object, The request body.
19369 The object takes the form of:
19370
19371 { # The policy describes the baseline against which
19372 # VM instance boot integrity is measured.
19373 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
19374 # measurements from the VM instance&#x27;s most recent boot.
19375 }
19376
19377 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
19378 that if you must retry your request, the server will know to ignore the
19379 request if it has already been completed.
19380
19381 For example, consider a situation where you make an initial request and
19382 the request times out. If you make the request again with the same
19383 request ID, the server can check if original operation with the same
19384 request ID was received, and if so, will ignore the second request. This
19385 prevents clients from accidentally creating duplicate commitments.
19386
19387 The request ID must be
19388 a valid UUID with the exception that zero UUID is not supported
19389 (00000000-0000-0000-0000-000000000000).
19390 x__xgafv: string, V1 error format.
19391 Allowed values
19392 1 - v1 error format
19393 2 - v2 error format
19394
19395 Returns:
19396 An object of the form:
19397
19398 { # Represents an Operation resource.
19399 #
19400 # Google Compute Engine has three Operation resources:
19401 #
19402 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
19403 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
19404 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
19405 #
19406 # You can use an operation resource to manage asynchronous API requests.
19407 # For more information, readHandling
19408 # API responses.
19409 #
19410 # Operations can be global, regional or zonal.
19411 #
19412 # - For global operations, use the `globalOperations`
19413 # resource.
19414 # - For regional operations, use the
19415 # `regionOperations` resource.
19416 # - For zonal operations, use
19417 # the `zoneOperations` resource.
19418 #
19419 #
19420 #
19421 # For more information, read
19422 # Global, Regional, and Zonal Resources.
19423 #
19424 # Note that completed Operation resources have a limited
19425 # retention period.
19426 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
19427 # Not present otherwise.
19428 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
19429 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
19430 # set when the operation is created.
19431 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
19432 # text format.
19433 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
19434 # this field will be populated.
19435 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
19436 # operation.
19437 {
19438 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
19439 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
19440 # details. There is a set of defined message types to use for providing
19441 # details.The syntax depends on the error code. For example,
19442 # QuotaExceededInfo will have details when the error code is
19443 # QUOTA_EXCEEDED.
19444 {
19445 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
19446 #
19447 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
19448 # is not enabled:
19449 #
19450 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
19451 # &quot;domain&quot;: &quot;googleapis.com&quot;
19452 # &quot;metadata&quot;: {
19453 # &quot;resource&quot;: &quot;projects/123&quot;,
19454 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
19455 # }
19456 # }
19457 #
19458 # This response indicates that the pubsub.googleapis.com API is not enabled.
19459 #
19460 # Example of an error that is returned when attempting to create a Spanner
19461 # instance in a region that is out of stock:
19462 #
19463 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
19464 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
19465 # &quot;metadata&quot;: {
19466 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
19467 # }
19468 # }
19469 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
19470 # is typically the registered service name of the tool or product that
19471 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
19472 # generated by some common infrastructure, the error domain must be a
19473 # globally unique value that identifies the infrastructure. For Google API
19474 # infrastructure, the error domain is &quot;googleapis.com&quot;.
19475 &quot;metadatas&quot;: { # Additional structured details about this error.
19476 #
19477 # Keys must match a regular expression of `a-z+` but should
19478 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
19479 # length. When identifying the current value of an exceeded limit, the units
19480 # should be contained in the key, not the value. For example, rather than
19481 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
19482 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
19483 # instances that can be created in a single (batch) request.
19484 &quot;a_key&quot;: &quot;A String&quot;,
19485 },
19486 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
19487 # proximate cause of the error. Error reasons are unique within a particular
19488 # domain of errors. This should be at most 63 characters and match a
19489 # regular expression of `A-Z+[A-Z0-9]`, which represents
19490 # UPPER_SNAKE_CASE.
19491 },
19492 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
19493 #
19494 # For example, if a quota check failed with an error indicating the calling
19495 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
19496 # directly to the right place in the developer console to flip the bit.
19497 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
19498 { # Describes a URL link.
19499 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
19500 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
19501 },
19502 ],
19503 },
19504 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
19505 # which can be attached to an RPC error.
19506 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
19507 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
19508 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
19509 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
19510 },
19511 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
19512 &quot;dimensions&quot;: { # The map holding related quota dimensions.
19513 &quot;a_key&quot;: &quot;A String&quot;,
19514 },
19515 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
19516 # type or metric.
19517 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
19518 # or metric.
19519 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
19520 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
19521 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
19522 },
19523 },
19524 ],
19525 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
19526 # This property is optional.
19527 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
19528 },
19529 ],
19530 },
19531 &quot;getVersionOperationMetadata&quot;: {
19532 &quot;inlineSbomInfo&quot;: {
19533 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
19534 # appropriate identifiers.
19535 &quot;a_key&quot;: &quot;A String&quot;,
19536 },
19537 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
19538 # identifiers.
19539 &quot;a_key&quot;: &quot;A String&quot;,
19540 },
19541 },
19542 },
19543 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
19544 # message that was returned, such as `NOT FOUND`.
19545 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
19546 # status code that was returned. For example, a `404` means the
19547 # resource was not found.
19548 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
19549 # defined by the server.
19550 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
19551 # This value is inRFC3339
19552 # text format.
19553 &quot;instancesBulkInsertOperationMetadata&quot;: {
19554 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
19555 # Example key: zones/us-central1-a
19556 &quot;a_key&quot;: {
19557 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
19558 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
19559 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
19560 # error.
19561 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
19562 # if the flow is rolling forward or rolling back.
19563 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
19564 },
19565 },
19566 },
19567 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
19568 # Operation resources.
19569 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
19570 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
19571 # group of operations results from a `bulkInsert` API request.
19572 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
19573 # `update`, or `delete`, and so on.
19574 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
19575 # There is no requirement that this be linear or support any granularity of
19576 # operations. This should not be used to guess when the operation will be
19577 # complete. This number should monotonically increase as the operation
19578 # progresses.
19579 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
19580 # applicable when performing regional operations.
19581 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
19582 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
19583 # this field will contain information on all underlying zonal actions and
19584 # their state.
19585 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
19586 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
19587 # Example key: zones/us-central1-a
19588 &quot;a_key&quot;: {
19589 &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
19590 # populated.
19591 # different programming environments, including REST APIs and RPC APIs. It is
19592 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
19593 # three pieces of data: error code, error message, and error details.
19594 #
19595 # You can find out more about this error model and how to work with it in the
19596 # [API Design Guide](https://cloud.google.com/apis/design/errors).
19597 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
19598 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
19599 # message types for APIs to use.
19600 {
19601 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
19602 },
19603 ],
19604 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
19605 # user-facing error message should be localized and sent in the
19606 # google.rpc.Status.details field, or localized by the client.
19607 },
19608 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
19609 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
19610 },
19611 },
19612 },
19613 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
19614 # This value is inRFC3339
19615 # text format.
19616 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
19617 # following:
19618 # `PENDING`, `RUNNING`, or `DONE`.
19619 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
19620 # operation.
19621 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
19622 # of the target resource.
19623 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
19624 # operations related to creating a snapshot, this points to the disk
19625 # that the snapshot was created from.
19626 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
19627 # `[email protected]` or
19628 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
19629 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
19630 # operation, this field will be populated.
19631 {
19632 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
19633 # Engine returns NO_RESULTS_ON_PAGE if there
19634 # are no results in the response.
19635 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
19636 # value format. For example:
19637 #
19638 # &quot;data&quot;: [
19639 # {
19640 # &quot;key&quot;: &quot;scope&quot;,
19641 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
19642 # }
19643 {
19644 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
19645 # returned. For example, for warnings where there are no results in a list
19646 # request for a particular zone, this key might be scope and
19647 # the key value might be the zone name. Other examples might be a key
19648 # indicating a deprecated resource and a suggested replacement, or a
19649 # warning about invalid network settings (for example, if an instance
19650 # attempts to perform IP forwarding but is not enabled for IP forwarding).
19651 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
19652 },
19653 ],
19654 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
19655 },
19656 ],
19657 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
19658 # applicable when performing per-zone operations.
19659 }</pre>
19660 </div>
19661
19662 <div class="method">
19663 <code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
19664 <pre>Sets network tags
19665 for the specified instance to the data included in the request.
19666
19667 Args:
19668 project: string, Project ID for this request. (required)
19669 zone: string, The name of the zone for this request. (required)
19670 instance: string, Name of the instance scoping this request. (required)
19671 body: object, The request body.
19672 The object takes the form of:
19673
19674 { # A set of instance tags.
19675 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
19676 # the tags&#x27; contents and used for optimistic locking. The
19677 # fingerprint is initially generated by Compute Engine and changes after
19678 # every request to modify or update tags. You must always provide an
19679 # up-to-date fingerprint hash in order to update or change tags.
19680 #
19681 # To see the latest fingerprint, make get() request to the
19682 # instance.
19683 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
19684 # with RFC1035.
19685 &quot;A String&quot;,
19686 ],
19687 }
19688
19689 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
19690 that if you must retry your request, the server will know to ignore the
19691 request if it has already been completed.
19692
19693 For example, consider a situation where you make an initial request and
19694 the request times out. If you make the request again with the same
19695 request ID, the server can check if original operation with the same
19696 request ID was received, and if so, will ignore the second request. This
19697 prevents clients from accidentally creating duplicate commitments.
19698
19699 The request ID must be
19700 a valid UUID with the exception that zero UUID is not supported
19701 (00000000-0000-0000-0000-000000000000).
19702 x__xgafv: string, V1 error format.
19703 Allowed values
19704 1 - v1 error format
19705 2 - v2 error format
19706
19707 Returns:
19708 An object of the form:
19709
19710 { # Represents an Operation resource.
19711 #
19712 # Google Compute Engine has three Operation resources:
19713 #
19714 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
19715 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
19716 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
19717 #
19718 # You can use an operation resource to manage asynchronous API requests.
19719 # For more information, readHandling
19720 # API responses.
19721 #
19722 # Operations can be global, regional or zonal.
19723 #
19724 # - For global operations, use the `globalOperations`
19725 # resource.
19726 # - For regional operations, use the
19727 # `regionOperations` resource.
19728 # - For zonal operations, use
19729 # the `zoneOperations` resource.
19730 #
19731 #
19732 #
19733 # For more information, read
19734 # Global, Regional, and Zonal Resources.
19735 #
19736 # Note that completed Operation resources have a limited
19737 # retention period.
19738 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
19739 # Not present otherwise.
19740 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
19741 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
19742 # set when the operation is created.
19743 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
19744 # text format.
19745 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
19746 # this field will be populated.
19747 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
19748 # operation.
19749 {
19750 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
19751 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
19752 # details. There is a set of defined message types to use for providing
19753 # details.The syntax depends on the error code. For example,
19754 # QuotaExceededInfo will have details when the error code is
19755 # QUOTA_EXCEEDED.
19756 {
19757 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
19758 #
19759 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
19760 # is not enabled:
19761 #
19762 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
19763 # &quot;domain&quot;: &quot;googleapis.com&quot;
19764 # &quot;metadata&quot;: {
19765 # &quot;resource&quot;: &quot;projects/123&quot;,
19766 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
19767 # }
19768 # }
19769 #
19770 # This response indicates that the pubsub.googleapis.com API is not enabled.
19771 #
19772 # Example of an error that is returned when attempting to create a Spanner
19773 # instance in a region that is out of stock:
19774 #
19775 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
19776 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
19777 # &quot;metadata&quot;: {
19778 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
19779 # }
19780 # }
19781 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
19782 # is typically the registered service name of the tool or product that
19783 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
19784 # generated by some common infrastructure, the error domain must be a
19785 # globally unique value that identifies the infrastructure. For Google API
19786 # infrastructure, the error domain is &quot;googleapis.com&quot;.
19787 &quot;metadatas&quot;: { # Additional structured details about this error.
19788 #
19789 # Keys must match a regular expression of `a-z+` but should
19790 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
19791 # length. When identifying the current value of an exceeded limit, the units
19792 # should be contained in the key, not the value. For example, rather than
19793 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
19794 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
19795 # instances that can be created in a single (batch) request.
19796 &quot;a_key&quot;: &quot;A String&quot;,
19797 },
19798 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
19799 # proximate cause of the error. Error reasons are unique within a particular
19800 # domain of errors. This should be at most 63 characters and match a
19801 # regular expression of `A-Z+[A-Z0-9]`, which represents
19802 # UPPER_SNAKE_CASE.
19803 },
19804 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
19805 #
19806 # For example, if a quota check failed with an error indicating the calling
19807 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
19808 # directly to the right place in the developer console to flip the bit.
19809 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
19810 { # Describes a URL link.
19811 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
19812 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
19813 },
19814 ],
19815 },
19816 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
19817 # which can be attached to an RPC error.
19818 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
19819 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
19820 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
19821 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
19822 },
19823 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
19824 &quot;dimensions&quot;: { # The map holding related quota dimensions.
19825 &quot;a_key&quot;: &quot;A String&quot;,
19826 },
19827 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
19828 # type or metric.
19829 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
19830 # or metric.
19831 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
19832 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
19833 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
19834 },
19835 },
19836 ],
19837 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
19838 # This property is optional.
19839 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
19840 },
19841 ],
19842 },
19843 &quot;getVersionOperationMetadata&quot;: {
19844 &quot;inlineSbomInfo&quot;: {
19845 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
19846 # appropriate identifiers.
19847 &quot;a_key&quot;: &quot;A String&quot;,
19848 },
19849 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
19850 # identifiers.
19851 &quot;a_key&quot;: &quot;A String&quot;,
19852 },
19853 },
19854 },
19855 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
19856 # message that was returned, such as `NOT FOUND`.
19857 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
19858 # status code that was returned. For example, a `404` means the
19859 # resource was not found.
19860 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
19861 # defined by the server.
19862 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
19863 # This value is inRFC3339
19864 # text format.
19865 &quot;instancesBulkInsertOperationMetadata&quot;: {
19866 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
19867 # Example key: zones/us-central1-a
19868 &quot;a_key&quot;: {
19869 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
19870 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
19871 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
19872 # error.
19873 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
19874 # if the flow is rolling forward or rolling back.
19875 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
19876 },
19877 },
19878 },
19879 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
19880 # Operation resources.
19881 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
19882 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
19883 # group of operations results from a `bulkInsert` API request.
19884 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
19885 # `update`, or `delete`, and so on.
19886 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
19887 # There is no requirement that this be linear or support any granularity of
19888 # operations. This should not be used to guess when the operation will be
19889 # complete. This number should monotonically increase as the operation
19890 # progresses.
19891 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
19892 # applicable when performing regional operations.
19893 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
19894 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
19895 # this field will contain information on all underlying zonal actions and
19896 # their state.
19897 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
19898 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
19899 # Example key: zones/us-central1-a
19900 &quot;a_key&quot;: {
19901 &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
19902 # populated.
19903 # different programming environments, including REST APIs and RPC APIs. It is
19904 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
19905 # three pieces of data: error code, error message, and error details.
19906 #
19907 # You can find out more about this error model and how to work with it in the
19908 # [API Design Guide](https://cloud.google.com/apis/design/errors).
19909 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
19910 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
19911 # message types for APIs to use.
19912 {
19913 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
19914 },
19915 ],
19916 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
19917 # user-facing error message should be localized and sent in the
19918 # google.rpc.Status.details field, or localized by the client.
19919 },
19920 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
19921 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
19922 },
19923 },
19924 },
19925 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
19926 # This value is inRFC3339
19927 # text format.
19928 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
19929 # following:
19930 # `PENDING`, `RUNNING`, or `DONE`.
19931 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
19932 # operation.
19933 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
19934 # of the target resource.
19935 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
19936 # operations related to creating a snapshot, this points to the disk
19937 # that the snapshot was created from.
19938 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
19939 # `[email protected]` or
19940 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
19941 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
19942 # operation, this field will be populated.
19943 {
19944 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
19945 # Engine returns NO_RESULTS_ON_PAGE if there
19946 # are no results in the response.
19947 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
19948 # value format. For example:
19949 #
19950 # &quot;data&quot;: [
19951 # {
19952 # &quot;key&quot;: &quot;scope&quot;,
19953 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
19954 # }
19955 {
19956 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
19957 # returned. For example, for warnings where there are no results in a list
19958 # request for a particular zone, this key might be scope and
19959 # the key value might be the zone name. Other examples might be a key
19960 # indicating a deprecated resource and a suggested replacement, or a
19961 # warning about invalid network settings (for example, if an instance
19962 # attempts to perform IP forwarding but is not enabled for IP forwarding).
19963 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
19964 },
19965 ],
19966 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
19967 },
19968 ],
19969 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
19970 # applicable when performing per-zone operations.
19971 }</pre>
19972 </div>
19973
19974 <div class="method">
19975 <code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, requestId=None, withExtendedNotifications=None, x__xgafv=None)</code>
19976 <pre>Simulates a host maintenance event on a VM. For more information, see
19977 Simulate a host maintenance event.
19978
19979 Args:
19980 project: string, Project ID for this request. (required)
19981 zone: string, The name of the zone for this request. (required)
19982 instance: string, Name of the instance scoping this request. (required)
19983 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
19984 that if you must retry your request, the server will know to ignore the
19985 request if it has already been completed.
19986
19987 For example, consider a situation where you make an initial request and
19988 the request times out. If you make the request again with the same
19989 request ID, the server can check if original operation with the same
19990 request ID was received, and if so, will ignore the second request. This
19991 prevents clients from accidentally creating duplicate commitments.
19992
19993 The request ID must be
19994 a valid UUID with the exception that zero UUID is not supported
19995 (00000000-0000-0000-0000-000000000000).
19996 withExtendedNotifications: boolean, Determines whether the customers receive notifications before migration.
19997 Only applicable to SF vms.
19998 x__xgafv: string, V1 error format.
19999 Allowed values
20000 1 - v1 error format
20001 2 - v2 error format
20002
20003 Returns:
20004 An object of the form:
20005
20006 { # Represents an Operation resource.
20007 #
20008 # Google Compute Engine has three Operation resources:
20009 #
20010 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
20011 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
20012 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
20013 #
20014 # You can use an operation resource to manage asynchronous API requests.
20015 # For more information, readHandling
20016 # API responses.
20017 #
20018 # Operations can be global, regional or zonal.
20019 #
20020 # - For global operations, use the `globalOperations`
20021 # resource.
20022 # - For regional operations, use the
20023 # `regionOperations` resource.
20024 # - For zonal operations, use
20025 # the `zoneOperations` resource.
20026 #
20027 #
20028 #
20029 # For more information, read
20030 # Global, Regional, and Zonal Resources.
20031 #
20032 # Note that completed Operation resources have a limited
20033 # retention period.
20034 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
20035 # Not present otherwise.
20036 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
20037 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
20038 # set when the operation is created.
20039 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
20040 # text format.
20041 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
20042 # this field will be populated.
20043 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
20044 # operation.
20045 {
20046 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
20047 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
20048 # details. There is a set of defined message types to use for providing
20049 # details.The syntax depends on the error code. For example,
20050 # QuotaExceededInfo will have details when the error code is
20051 # QUOTA_EXCEEDED.
20052 {
20053 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
20054 #
20055 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
20056 # is not enabled:
20057 #
20058 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
20059 # &quot;domain&quot;: &quot;googleapis.com&quot;
20060 # &quot;metadata&quot;: {
20061 # &quot;resource&quot;: &quot;projects/123&quot;,
20062 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
20063 # }
20064 # }
20065 #
20066 # This response indicates that the pubsub.googleapis.com API is not enabled.
20067 #
20068 # Example of an error that is returned when attempting to create a Spanner
20069 # instance in a region that is out of stock:
20070 #
20071 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
20072 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
20073 # &quot;metadata&quot;: {
20074 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
20075 # }
20076 # }
20077 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
20078 # is typically the registered service name of the tool or product that
20079 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
20080 # generated by some common infrastructure, the error domain must be a
20081 # globally unique value that identifies the infrastructure. For Google API
20082 # infrastructure, the error domain is &quot;googleapis.com&quot;.
20083 &quot;metadatas&quot;: { # Additional structured details about this error.
20084 #
20085 # Keys must match a regular expression of `a-z+` but should
20086 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
20087 # length. When identifying the current value of an exceeded limit, the units
20088 # should be contained in the key, not the value. For example, rather than
20089 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
20090 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
20091 # instances that can be created in a single (batch) request.
20092 &quot;a_key&quot;: &quot;A String&quot;,
20093 },
20094 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
20095 # proximate cause of the error. Error reasons are unique within a particular
20096 # domain of errors. This should be at most 63 characters and match a
20097 # regular expression of `A-Z+[A-Z0-9]`, which represents
20098 # UPPER_SNAKE_CASE.
20099 },
20100 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
20101 #
20102 # For example, if a quota check failed with an error indicating the calling
20103 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
20104 # directly to the right place in the developer console to flip the bit.
20105 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
20106 { # Describes a URL link.
20107 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
20108 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
20109 },
20110 ],
20111 },
20112 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
20113 # which can be attached to an RPC error.
20114 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
20115 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
20116 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
20117 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
20118 },
20119 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
20120 &quot;dimensions&quot;: { # The map holding related quota dimensions.
20121 &quot;a_key&quot;: &quot;A String&quot;,
20122 },
20123 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
20124 # type or metric.
20125 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
20126 # or metric.
20127 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
20128 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
20129 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
20130 },
20131 },
20132 ],
20133 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
20134 # This property is optional.
20135 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
20136 },
20137 ],
20138 },
20139 &quot;getVersionOperationMetadata&quot;: {
20140 &quot;inlineSbomInfo&quot;: {
20141 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
20142 # appropriate identifiers.
20143 &quot;a_key&quot;: &quot;A String&quot;,
20144 },
20145 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
20146 # identifiers.
20147 &quot;a_key&quot;: &quot;A String&quot;,
20148 },
20149 },
20150 },
20151 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
20152 # message that was returned, such as `NOT FOUND`.
20153 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
20154 # status code that was returned. For example, a `404` means the
20155 # resource was not found.
20156 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
20157 # defined by the server.
20158 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
20159 # This value is inRFC3339
20160 # text format.
20161 &quot;instancesBulkInsertOperationMetadata&quot;: {
20162 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
20163 # Example key: zones/us-central1-a
20164 &quot;a_key&quot;: {
20165 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
20166 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
20167 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
20168 # error.
20169 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
20170 # if the flow is rolling forward or rolling back.
20171 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
20172 },
20173 },
20174 },
20175 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
20176 # Operation resources.
20177 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
20178 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
20179 # group of operations results from a `bulkInsert` API request.
20180 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
20181 # `update`, or `delete`, and so on.
20182 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
20183 # There is no requirement that this be linear or support any granularity of
20184 # operations. This should not be used to guess when the operation will be
20185 # complete. This number should monotonically increase as the operation
20186 # progresses.
20187 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
20188 # applicable when performing regional operations.
20189 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
20190 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
20191 # this field will contain information on all underlying zonal actions and
20192 # their state.
20193 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
20194 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
20195 # Example key: zones/us-central1-a
20196 &quot;a_key&quot;: {
20197 &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
20198 # populated.
20199 # different programming environments, including REST APIs and RPC APIs. It is
20200 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
20201 # three pieces of data: error code, error message, and error details.
20202 #
20203 # You can find out more about this error model and how to work with it in the
20204 # [API Design Guide](https://cloud.google.com/apis/design/errors).
20205 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
20206 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
20207 # message types for APIs to use.
20208 {
20209 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
20210 },
20211 ],
20212 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
20213 # user-facing error message should be localized and sent in the
20214 # google.rpc.Status.details field, or localized by the client.
20215 },
20216 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
20217 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
20218 },
20219 },
20220 },
20221 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
20222 # This value is inRFC3339
20223 # text format.
20224 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
20225 # following:
20226 # `PENDING`, `RUNNING`, or `DONE`.
20227 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
20228 # operation.
20229 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
20230 # of the target resource.
20231 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
20232 # operations related to creating a snapshot, this points to the disk
20233 # that the snapshot was created from.
20234 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
20235 # `[email protected]` or
20236 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
20237 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
20238 # operation, this field will be populated.
20239 {
20240 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
20241 # Engine returns NO_RESULTS_ON_PAGE if there
20242 # are no results in the response.
20243 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
20244 # value format. For example:
20245 #
20246 # &quot;data&quot;: [
20247 # {
20248 # &quot;key&quot;: &quot;scope&quot;,
20249 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
20250 # }
20251 {
20252 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
20253 # returned. For example, for warnings where there are no results in a list
20254 # request for a particular zone, this key might be scope and
20255 # the key value might be the zone name. Other examples might be a key
20256 # indicating a deprecated resource and a suggested replacement, or a
20257 # warning about invalid network settings (for example, if an instance
20258 # attempts to perform IP forwarding but is not enabled for IP forwarding).
20259 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
20260 },
20261 ],
20262 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
20263 },
20264 ],
20265 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
20266 # applicable when performing per-zone operations.
20267 }</pre>
20268 </div>
20269
20270 <div class="method">
20271 <code class="details" id="start">start(project, zone, instance, requestId=None, x__xgafv=None)</code>
20272 <pre>Starts an instance that was stopped using theinstances().stop
20273 method. For more information, seeRestart an
20274 instance.
20275
20276 Args:
20277 project: string, Project ID for this request. (required)
20278 zone: string, The name of the zone for this request. (required)
20279 instance: string, Name of the instance resource to start. (required)
20280 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
20281 that if you must retry your request, the server will know to ignore the
20282 request if it has already been completed.
20283
20284 For example, consider a situation where you make an initial request and
20285 the request times out. If you make the request again with the same
20286 request ID, the server can check if original operation with the same
20287 request ID was received, and if so, will ignore the second request. This
20288 prevents clients from accidentally creating duplicate commitments.
20289
20290 The request ID must be
20291 a valid UUID with the exception that zero UUID is not supported
20292 (00000000-0000-0000-0000-000000000000).
20293 x__xgafv: string, V1 error format.
20294 Allowed values
20295 1 - v1 error format
20296 2 - v2 error format
20297
20298 Returns:
20299 An object of the form:
20300
20301 { # Represents an Operation resource.
20302 #
20303 # Google Compute Engine has three Operation resources:
20304 #
20305 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
20306 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
20307 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
20308 #
20309 # You can use an operation resource to manage asynchronous API requests.
20310 # For more information, readHandling
20311 # API responses.
20312 #
20313 # Operations can be global, regional or zonal.
20314 #
20315 # - For global operations, use the `globalOperations`
20316 # resource.
20317 # - For regional operations, use the
20318 # `regionOperations` resource.
20319 # - For zonal operations, use
20320 # the `zoneOperations` resource.
20321 #
20322 #
20323 #
20324 # For more information, read
20325 # Global, Regional, and Zonal Resources.
20326 #
20327 # Note that completed Operation resources have a limited
20328 # retention period.
20329 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
20330 # Not present otherwise.
20331 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
20332 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
20333 # set when the operation is created.
20334 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
20335 # text format.
20336 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
20337 # this field will be populated.
20338 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
20339 # operation.
20340 {
20341 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
20342 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
20343 # details. There is a set of defined message types to use for providing
20344 # details.The syntax depends on the error code. For example,
20345 # QuotaExceededInfo will have details when the error code is
20346 # QUOTA_EXCEEDED.
20347 {
20348 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
20349 #
20350 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
20351 # is not enabled:
20352 #
20353 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
20354 # &quot;domain&quot;: &quot;googleapis.com&quot;
20355 # &quot;metadata&quot;: {
20356 # &quot;resource&quot;: &quot;projects/123&quot;,
20357 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
20358 # }
20359 # }
20360 #
20361 # This response indicates that the pubsub.googleapis.com API is not enabled.
20362 #
20363 # Example of an error that is returned when attempting to create a Spanner
20364 # instance in a region that is out of stock:
20365 #
20366 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
20367 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
20368 # &quot;metadata&quot;: {
20369 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
20370 # }
20371 # }
20372 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
20373 # is typically the registered service name of the tool or product that
20374 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
20375 # generated by some common infrastructure, the error domain must be a
20376 # globally unique value that identifies the infrastructure. For Google API
20377 # infrastructure, the error domain is &quot;googleapis.com&quot;.
20378 &quot;metadatas&quot;: { # Additional structured details about this error.
20379 #
20380 # Keys must match a regular expression of `a-z+` but should
20381 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
20382 # length. When identifying the current value of an exceeded limit, the units
20383 # should be contained in the key, not the value. For example, rather than
20384 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
20385 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
20386 # instances that can be created in a single (batch) request.
20387 &quot;a_key&quot;: &quot;A String&quot;,
20388 },
20389 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
20390 # proximate cause of the error. Error reasons are unique within a particular
20391 # domain of errors. This should be at most 63 characters and match a
20392 # regular expression of `A-Z+[A-Z0-9]`, which represents
20393 # UPPER_SNAKE_CASE.
20394 },
20395 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
20396 #
20397 # For example, if a quota check failed with an error indicating the calling
20398 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
20399 # directly to the right place in the developer console to flip the bit.
20400 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
20401 { # Describes a URL link.
20402 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
20403 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
20404 },
20405 ],
20406 },
20407 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
20408 # which can be attached to an RPC error.
20409 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
20410 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
20411 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
20412 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
20413 },
20414 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
20415 &quot;dimensions&quot;: { # The map holding related quota dimensions.
20416 &quot;a_key&quot;: &quot;A String&quot;,
20417 },
20418 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
20419 # type or metric.
20420 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
20421 # or metric.
20422 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
20423 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
20424 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
20425 },
20426 },
20427 ],
20428 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
20429 # This property is optional.
20430 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
20431 },
20432 ],
20433 },
20434 &quot;getVersionOperationMetadata&quot;: {
20435 &quot;inlineSbomInfo&quot;: {
20436 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
20437 # appropriate identifiers.
20438 &quot;a_key&quot;: &quot;A String&quot;,
20439 },
20440 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
20441 # identifiers.
20442 &quot;a_key&quot;: &quot;A String&quot;,
20443 },
20444 },
20445 },
20446 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
20447 # message that was returned, such as `NOT FOUND`.
20448 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
20449 # status code that was returned. For example, a `404` means the
20450 # resource was not found.
20451 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
20452 # defined by the server.
20453 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
20454 # This value is inRFC3339
20455 # text format.
20456 &quot;instancesBulkInsertOperationMetadata&quot;: {
20457 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
20458 # Example key: zones/us-central1-a
20459 &quot;a_key&quot;: {
20460 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
20461 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
20462 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
20463 # error.
20464 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
20465 # if the flow is rolling forward or rolling back.
20466 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
20467 },
20468 },
20469 },
20470 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
20471 # Operation resources.
20472 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
20473 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
20474 # group of operations results from a `bulkInsert` API request.
20475 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
20476 # `update`, or `delete`, and so on.
20477 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
20478 # There is no requirement that this be linear or support any granularity of
20479 # operations. This should not be used to guess when the operation will be
20480 # complete. This number should monotonically increase as the operation
20481 # progresses.
20482 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
20483 # applicable when performing regional operations.
20484 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
20485 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
20486 # this field will contain information on all underlying zonal actions and
20487 # their state.
20488 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
20489 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
20490 # Example key: zones/us-central1-a
20491 &quot;a_key&quot;: {
20492 &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
20493 # populated.
20494 # different programming environments, including REST APIs and RPC APIs. It is
20495 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
20496 # three pieces of data: error code, error message, and error details.
20497 #
20498 # You can find out more about this error model and how to work with it in the
20499 # [API Design Guide](https://cloud.google.com/apis/design/errors).
20500 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
20501 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
20502 # message types for APIs to use.
20503 {
20504 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
20505 },
20506 ],
20507 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
20508 # user-facing error message should be localized and sent in the
20509 # google.rpc.Status.details field, or localized by the client.
20510 },
20511 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
20512 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
20513 },
20514 },
20515 },
20516 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
20517 # This value is inRFC3339
20518 # text format.
20519 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
20520 # following:
20521 # `PENDING`, `RUNNING`, or `DONE`.
20522 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
20523 # operation.
20524 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
20525 # of the target resource.
20526 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
20527 # operations related to creating a snapshot, this points to the disk
20528 # that the snapshot was created from.
20529 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
20530 # `[email protected]` or
20531 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
20532 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
20533 # operation, this field will be populated.
20534 {
20535 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
20536 # Engine returns NO_RESULTS_ON_PAGE if there
20537 # are no results in the response.
20538 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
20539 # value format. For example:
20540 #
20541 # &quot;data&quot;: [
20542 # {
20543 # &quot;key&quot;: &quot;scope&quot;,
20544 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
20545 # }
20546 {
20547 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
20548 # returned. For example, for warnings where there are no results in a list
20549 # request for a particular zone, this key might be scope and
20550 # the key value might be the zone name. Other examples might be a key
20551 # indicating a deprecated resource and a suggested replacement, or a
20552 # warning about invalid network settings (for example, if an instance
20553 # attempts to perform IP forwarding but is not enabled for IP forwarding).
20554 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
20555 },
20556 ],
20557 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
20558 },
20559 ],
20560 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
20561 # applicable when performing per-zone operations.
20562 }</pre>
20563 </div>
20564
20565 <div class="method">
20566 <code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
20567 <pre>Starts an instance that was stopped using theinstances().stop
20568 method. For more information, seeRestart an
20569 instance.
20570
20571 Args:
20572 project: string, Project ID for this request. (required)
20573 zone: string, The name of the zone for this request. (required)
20574 instance: string, Name of the instance resource to start. (required)
20575 body: object, The request body.
20576 The object takes the form of:
20577
20578 {
20579 &quot;disks&quot;: [ # Array of disks associated with this instance that are protected with acustomer-supplied
20580 # encryption key.
20581 #
20582 # In order to start the instance, the disk url and its corresponding key must
20583 # be provided.
20584 #
20585 # If the disk is not protected with a customer-supplied encryption key it
20586 # should not be specified.
20587 {
20588 &quot;diskEncryptionKey&quot;: { # Decrypts data associated with the disk with acustomer-supplied
20589 # encryption key.
20590 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
20591 # For example:
20592 #
20593 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
20594 # key_region/cryptoKeys/key
20595 #
20596 # The fully-qualifed key name may be returned for resource GET requests. For
20597 # example:
20598 #
20599 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
20600 # key_region/cryptoKeys/key
20601 # /cryptoKeyVersions/1
20602 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
20603 # key. If absent, the Compute Engine default service account is used.
20604 # For example:
20605 #
20606 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
20607 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
20608 # encryption key, encoded in RFC
20609 # 4648 base64 to either encrypt or decrypt this resource. You can
20610 # provide either the rawKey or thersaEncryptedKey.
20611 # For example:
20612 #
20613 # &quot;rawKey&quot;:
20614 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
20615 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
20616 # customer-supplied encryption key to either encrypt or decrypt this
20617 # resource. You can provide either the rawKey or thersaEncryptedKey.
20618 # For example:
20619 #
20620 # &quot;rsaEncryptedKey&quot;:
20621 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
20622 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
20623 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
20624 #
20625 # The key must meet the following requirements before you can provide it to
20626 # Compute Engine:
20627 #
20628 # 1. The key is wrapped using a RSA public key certificate provided by
20629 # Google.
20630 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
20631 # encoding.
20632 #
20633 # Gets the RSA public key certificate provided by Google at:
20634 #
20635 #
20636 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
20637 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
20638 # 4648 base64 encoded SHA-256 hash of the customer-supplied
20639 # encryption key that protects this resource.
20640 },
20641 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
20642 # resource. This field is only applicable for persistent disks.
20643 # For example:
20644 #
20645 # &quot;source&quot;: &quot;/compute/v1/projects/project_id/zones/zone/disks/
20646 # disk_name
20647 },
20648 ],
20649 }
20650
20651 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
20652 that if you must retry your request, the server will know to ignore the
20653 request if it has already been completed.
20654
20655 For example, consider a situation where you make an initial request and
20656 the request times out. If you make the request again with the same
20657 request ID, the server can check if original operation with the same
20658 request ID was received, and if so, will ignore the second request. This
20659 prevents clients from accidentally creating duplicate commitments.
20660
20661 The request ID must be
20662 a valid UUID with the exception that zero UUID is not supported
20663 (00000000-0000-0000-0000-000000000000).
20664 x__xgafv: string, V1 error format.
20665 Allowed values
20666 1 - v1 error format
20667 2 - v2 error format
20668
20669 Returns:
20670 An object of the form:
20671
20672 { # Represents an Operation resource.
20673 #
20674 # Google Compute Engine has three Operation resources:
20675 #
20676 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
20677 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
20678 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
20679 #
20680 # You can use an operation resource to manage asynchronous API requests.
20681 # For more information, readHandling
20682 # API responses.
20683 #
20684 # Operations can be global, regional or zonal.
20685 #
20686 # - For global operations, use the `globalOperations`
20687 # resource.
20688 # - For regional operations, use the
20689 # `regionOperations` resource.
20690 # - For zonal operations, use
20691 # the `zoneOperations` resource.
20692 #
20693 #
20694 #
20695 # For more information, read
20696 # Global, Regional, and Zonal Resources.
20697 #
20698 # Note that completed Operation resources have a limited
20699 # retention period.
20700 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
20701 # Not present otherwise.
20702 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
20703 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
20704 # set when the operation is created.
20705 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
20706 # text format.
20707 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
20708 # this field will be populated.
20709 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
20710 # operation.
20711 {
20712 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
20713 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
20714 # details. There is a set of defined message types to use for providing
20715 # details.The syntax depends on the error code. For example,
20716 # QuotaExceededInfo will have details when the error code is
20717 # QUOTA_EXCEEDED.
20718 {
20719 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
20720 #
20721 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
20722 # is not enabled:
20723 #
20724 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
20725 # &quot;domain&quot;: &quot;googleapis.com&quot;
20726 # &quot;metadata&quot;: {
20727 # &quot;resource&quot;: &quot;projects/123&quot;,
20728 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
20729 # }
20730 # }
20731 #
20732 # This response indicates that the pubsub.googleapis.com API is not enabled.
20733 #
20734 # Example of an error that is returned when attempting to create a Spanner
20735 # instance in a region that is out of stock:
20736 #
20737 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
20738 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
20739 # &quot;metadata&quot;: {
20740 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
20741 # }
20742 # }
20743 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
20744 # is typically the registered service name of the tool or product that
20745 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
20746 # generated by some common infrastructure, the error domain must be a
20747 # globally unique value that identifies the infrastructure. For Google API
20748 # infrastructure, the error domain is &quot;googleapis.com&quot;.
20749 &quot;metadatas&quot;: { # Additional structured details about this error.
20750 #
20751 # Keys must match a regular expression of `a-z+` but should
20752 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
20753 # length. When identifying the current value of an exceeded limit, the units
20754 # should be contained in the key, not the value. For example, rather than
20755 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
20756 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
20757 # instances that can be created in a single (batch) request.
20758 &quot;a_key&quot;: &quot;A String&quot;,
20759 },
20760 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
20761 # proximate cause of the error. Error reasons are unique within a particular
20762 # domain of errors. This should be at most 63 characters and match a
20763 # regular expression of `A-Z+[A-Z0-9]`, which represents
20764 # UPPER_SNAKE_CASE.
20765 },
20766 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
20767 #
20768 # For example, if a quota check failed with an error indicating the calling
20769 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
20770 # directly to the right place in the developer console to flip the bit.
20771 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
20772 { # Describes a URL link.
20773 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
20774 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
20775 },
20776 ],
20777 },
20778 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
20779 # which can be attached to an RPC error.
20780 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
20781 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
20782 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
20783 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
20784 },
20785 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
20786 &quot;dimensions&quot;: { # The map holding related quota dimensions.
20787 &quot;a_key&quot;: &quot;A String&quot;,
20788 },
20789 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
20790 # type or metric.
20791 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
20792 # or metric.
20793 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
20794 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
20795 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
20796 },
20797 },
20798 ],
20799 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
20800 # This property is optional.
20801 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
20802 },
20803 ],
20804 },
20805 &quot;getVersionOperationMetadata&quot;: {
20806 &quot;inlineSbomInfo&quot;: {
20807 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
20808 # appropriate identifiers.
20809 &quot;a_key&quot;: &quot;A String&quot;,
20810 },
20811 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
20812 # identifiers.
20813 &quot;a_key&quot;: &quot;A String&quot;,
20814 },
20815 },
20816 },
20817 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
20818 # message that was returned, such as `NOT FOUND`.
20819 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
20820 # status code that was returned. For example, a `404` means the
20821 # resource was not found.
20822 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
20823 # defined by the server.
20824 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
20825 # This value is inRFC3339
20826 # text format.
20827 &quot;instancesBulkInsertOperationMetadata&quot;: {
20828 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
20829 # Example key: zones/us-central1-a
20830 &quot;a_key&quot;: {
20831 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
20832 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
20833 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
20834 # error.
20835 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
20836 # if the flow is rolling forward or rolling back.
20837 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
20838 },
20839 },
20840 },
20841 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
20842 # Operation resources.
20843 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
20844 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
20845 # group of operations results from a `bulkInsert` API request.
20846 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
20847 # `update`, or `delete`, and so on.
20848 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
20849 # There is no requirement that this be linear or support any granularity of
20850 # operations. This should not be used to guess when the operation will be
20851 # complete. This number should monotonically increase as the operation
20852 # progresses.
20853 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
20854 # applicable when performing regional operations.
20855 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
20856 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
20857 # this field will contain information on all underlying zonal actions and
20858 # their state.
20859 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
20860 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
20861 # Example key: zones/us-central1-a
20862 &quot;a_key&quot;: {
20863 &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
20864 # populated.
20865 # different programming environments, including REST APIs and RPC APIs. It is
20866 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
20867 # three pieces of data: error code, error message, and error details.
20868 #
20869 # You can find out more about this error model and how to work with it in the
20870 # [API Design Guide](https://cloud.google.com/apis/design/errors).
20871 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
20872 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
20873 # message types for APIs to use.
20874 {
20875 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
20876 },
20877 ],
20878 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
20879 # user-facing error message should be localized and sent in the
20880 # google.rpc.Status.details field, or localized by the client.
20881 },
20882 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
20883 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
20884 },
20885 },
20886 },
20887 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
20888 # This value is inRFC3339
20889 # text format.
20890 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
20891 # following:
20892 # `PENDING`, `RUNNING`, or `DONE`.
20893 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
20894 # operation.
20895 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
20896 # of the target resource.
20897 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
20898 # operations related to creating a snapshot, this points to the disk
20899 # that the snapshot was created from.
20900 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
20901 # `[email protected]` or
20902 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
20903 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
20904 # operation, this field will be populated.
20905 {
20906 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
20907 # Engine returns NO_RESULTS_ON_PAGE if there
20908 # are no results in the response.
20909 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
20910 # value format. For example:
20911 #
20912 # &quot;data&quot;: [
20913 # {
20914 # &quot;key&quot;: &quot;scope&quot;,
20915 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
20916 # }
20917 {
20918 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
20919 # returned. For example, for warnings where there are no results in a list
20920 # request for a particular zone, this key might be scope and
20921 # the key value might be the zone name. Other examples might be a key
20922 # indicating a deprecated resource and a suggested replacement, or a
20923 # warning about invalid network settings (for example, if an instance
20924 # attempts to perform IP forwarding but is not enabled for IP forwarding).
20925 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
20926 },
20927 ],
20928 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
20929 },
20930 ],
20931 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
20932 # applicable when performing per-zone operations.
20933 }</pre>
20934 </div>
20935
20936 <div class="method">
20937 <code class="details" id="stop">stop(project, zone, instance, discardLocalSsd=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)</code>
20938 <pre>Stops a running instance, shutting it down cleanly, and allows
20939 you to restart the instance at a later time. Stopped instances do not incur
20940 VM usage charges while they are stopped. However, resources that the VM is
20941 using, such as persistent disks and static IP addresses, will continue to
20942 be charged until they are deleted. For more information, seeStopping
20943 an instance.
20944
20945 Args:
20946 project: string, Project ID for this request. (required)
20947 zone: string, The name of the zone for this request. (required)
20948 instance: string, Name of the instance resource to stop. (required)
20949 discardLocalSsd: boolean, This property is required if the instance has any attached Local SSD disks.
20950 If false, Local SSD data will be preserved when the instance is suspended.
20951 If true, the contents of any attached Local SSD disks will be discarded.
20952 noGracefulShutdown: boolean, If set to true, Graceful Shutdown is skipped.
20953 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
20954 that if you must retry your request, the server will know to ignore the
20955 request if it has already been completed.
20956
20957 For example, consider a situation where you make an initial request and
20958 the request times out. If you make the request again with the same
20959 request ID, the server can check if original operation with the same
20960 request ID was received, and if so, will ignore the second request. This
20961 prevents clients from accidentally creating duplicate commitments.
20962
20963 The request ID must be
20964 a valid UUID with the exception that zero UUID is not supported
20965 (00000000-0000-0000-0000-000000000000).
20966 x__xgafv: string, V1 error format.
20967 Allowed values
20968 1 - v1 error format
20969 2 - v2 error format
20970
20971 Returns:
20972 An object of the form:
20973
20974 { # Represents an Operation resource.
20975 #
20976 # Google Compute Engine has three Operation resources:
20977 #
20978 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
20979 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
20980 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
20981 #
20982 # You can use an operation resource to manage asynchronous API requests.
20983 # For more information, readHandling
20984 # API responses.
20985 #
20986 # Operations can be global, regional or zonal.
20987 #
20988 # - For global operations, use the `globalOperations`
20989 # resource.
20990 # - For regional operations, use the
20991 # `regionOperations` resource.
20992 # - For zonal operations, use
20993 # the `zoneOperations` resource.
20994 #
20995 #
20996 #
20997 # For more information, read
20998 # Global, Regional, and Zonal Resources.
20999 #
21000 # Note that completed Operation resources have a limited
21001 # retention period.
21002 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
21003 # Not present otherwise.
21004 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
21005 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
21006 # set when the operation is created.
21007 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
21008 # text format.
21009 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
21010 # this field will be populated.
21011 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
21012 # operation.
21013 {
21014 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
21015 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
21016 # details. There is a set of defined message types to use for providing
21017 # details.The syntax depends on the error code. For example,
21018 # QuotaExceededInfo will have details when the error code is
21019 # QUOTA_EXCEEDED.
21020 {
21021 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
21022 #
21023 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
21024 # is not enabled:
21025 #
21026 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
21027 # &quot;domain&quot;: &quot;googleapis.com&quot;
21028 # &quot;metadata&quot;: {
21029 # &quot;resource&quot;: &quot;projects/123&quot;,
21030 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
21031 # }
21032 # }
21033 #
21034 # This response indicates that the pubsub.googleapis.com API is not enabled.
21035 #
21036 # Example of an error that is returned when attempting to create a Spanner
21037 # instance in a region that is out of stock:
21038 #
21039 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
21040 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
21041 # &quot;metadata&quot;: {
21042 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
21043 # }
21044 # }
21045 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
21046 # is typically the registered service name of the tool or product that
21047 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
21048 # generated by some common infrastructure, the error domain must be a
21049 # globally unique value that identifies the infrastructure. For Google API
21050 # infrastructure, the error domain is &quot;googleapis.com&quot;.
21051 &quot;metadatas&quot;: { # Additional structured details about this error.
21052 #
21053 # Keys must match a regular expression of `a-z+` but should
21054 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
21055 # length. When identifying the current value of an exceeded limit, the units
21056 # should be contained in the key, not the value. For example, rather than
21057 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
21058 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
21059 # instances that can be created in a single (batch) request.
21060 &quot;a_key&quot;: &quot;A String&quot;,
21061 },
21062 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
21063 # proximate cause of the error. Error reasons are unique within a particular
21064 # domain of errors. This should be at most 63 characters and match a
21065 # regular expression of `A-Z+[A-Z0-9]`, which represents
21066 # UPPER_SNAKE_CASE.
21067 },
21068 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
21069 #
21070 # For example, if a quota check failed with an error indicating the calling
21071 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
21072 # directly to the right place in the developer console to flip the bit.
21073 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
21074 { # Describes a URL link.
21075 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
21076 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
21077 },
21078 ],
21079 },
21080 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
21081 # which can be attached to an RPC error.
21082 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
21083 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
21084 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
21085 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
21086 },
21087 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
21088 &quot;dimensions&quot;: { # The map holding related quota dimensions.
21089 &quot;a_key&quot;: &quot;A String&quot;,
21090 },
21091 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
21092 # type or metric.
21093 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
21094 # or metric.
21095 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
21096 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
21097 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
21098 },
21099 },
21100 ],
21101 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
21102 # This property is optional.
21103 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
21104 },
21105 ],
21106 },
21107 &quot;getVersionOperationMetadata&quot;: {
21108 &quot;inlineSbomInfo&quot;: {
21109 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
21110 # appropriate identifiers.
21111 &quot;a_key&quot;: &quot;A String&quot;,
21112 },
21113 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
21114 # identifiers.
21115 &quot;a_key&quot;: &quot;A String&quot;,
21116 },
21117 },
21118 },
21119 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
21120 # message that was returned, such as `NOT FOUND`.
21121 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
21122 # status code that was returned. For example, a `404` means the
21123 # resource was not found.
21124 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
21125 # defined by the server.
21126 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
21127 # This value is inRFC3339
21128 # text format.
21129 &quot;instancesBulkInsertOperationMetadata&quot;: {
21130 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
21131 # Example key: zones/us-central1-a
21132 &quot;a_key&quot;: {
21133 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
21134 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
21135 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
21136 # error.
21137 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
21138 # if the flow is rolling forward or rolling back.
21139 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
21140 },
21141 },
21142 },
21143 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
21144 # Operation resources.
21145 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
21146 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
21147 # group of operations results from a `bulkInsert` API request.
21148 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
21149 # `update`, or `delete`, and so on.
21150 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
21151 # There is no requirement that this be linear or support any granularity of
21152 # operations. This should not be used to guess when the operation will be
21153 # complete. This number should monotonically increase as the operation
21154 # progresses.
21155 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
21156 # applicable when performing regional operations.
21157 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
21158 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
21159 # this field will contain information on all underlying zonal actions and
21160 # their state.
21161 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
21162 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
21163 # Example key: zones/us-central1-a
21164 &quot;a_key&quot;: {
21165 &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
21166 # populated.
21167 # different programming environments, including REST APIs and RPC APIs. It is
21168 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
21169 # three pieces of data: error code, error message, and error details.
21170 #
21171 # You can find out more about this error model and how to work with it in the
21172 # [API Design Guide](https://cloud.google.com/apis/design/errors).
21173 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
21174 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
21175 # message types for APIs to use.
21176 {
21177 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
21178 },
21179 ],
21180 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
21181 # user-facing error message should be localized and sent in the
21182 # google.rpc.Status.details field, or localized by the client.
21183 },
21184 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
21185 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
21186 },
21187 },
21188 },
21189 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
21190 # This value is inRFC3339
21191 # text format.
21192 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
21193 # following:
21194 # `PENDING`, `RUNNING`, or `DONE`.
21195 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
21196 # operation.
21197 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
21198 # of the target resource.
21199 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
21200 # operations related to creating a snapshot, this points to the disk
21201 # that the snapshot was created from.
21202 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
21203 # `[email protected]` or
21204 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
21205 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
21206 # operation, this field will be populated.
21207 {
21208 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
21209 # Engine returns NO_RESULTS_ON_PAGE if there
21210 # are no results in the response.
21211 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
21212 # value format. For example:
21213 #
21214 # &quot;data&quot;: [
21215 # {
21216 # &quot;key&quot;: &quot;scope&quot;,
21217 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
21218 # }
21219 {
21220 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
21221 # returned. For example, for warnings where there are no results in a list
21222 # request for a particular zone, this key might be scope and
21223 # the key value might be the zone name. Other examples might be a key
21224 # indicating a deprecated resource and a suggested replacement, or a
21225 # warning about invalid network settings (for example, if an instance
21226 # attempts to perform IP forwarding but is not enabled for IP forwarding).
21227 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
21228 },
21229 ],
21230 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
21231 },
21232 ],
21233 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
21234 # applicable when performing per-zone operations.
21235 }</pre>
21236 </div>
21237
21238 <div class="method">
21239 <code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</code>
21240 <pre>This method suspends a running instance, saving its state to persistent
21241 storage, and allows you to resume the instance at a later time. Suspended
21242 instances have no compute costs (cores or RAM), and incur only storage
21243 charges for the saved VM memory and localSSD data. Any charged resources
21244 the virtual machine was using, such as persistent disks and static IP
21245 addresses, will continue to be charged while the instance is suspended.
21246 For more information, see
21247 Suspending and resuming an instance.
21248
21249 Args:
21250 project: string, Project ID for this request. (required)
21251 zone: string, The name of the zone for this request. (required)
21252 instance: string, Name of the instance resource to suspend. (required)
21253 discardLocalSsd: boolean, This property is required if the instance has any attached Local SSD disks.
21254 If false, Local SSD data will be preserved when the instance is suspended.
21255 If true, the contents of any attached Local SSD disks will be discarded.
21256 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
21257 that if you must retry your request, the server will know to ignore the
21258 request if it has already been completed.
21259
21260 For example, consider a situation where you make an initial request and
21261 the request times out. If you make the request again with the same
21262 request ID, the server can check if original operation with the same
21263 request ID was received, and if so, will ignore the second request. This
21264 prevents clients from accidentally creating duplicate commitments.
21265
21266 The request ID must be
21267 a valid UUID with the exception that zero UUID is not supported
21268 (00000000-0000-0000-0000-000000000000).
21269 x__xgafv: string, V1 error format.
21270 Allowed values
21271 1 - v1 error format
21272 2 - v2 error format
21273
21274 Returns:
21275 An object of the form:
21276
21277 { # Represents an Operation resource.
21278 #
21279 # Google Compute Engine has three Operation resources:
21280 #
21281 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
21282 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
21283 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
21284 #
21285 # You can use an operation resource to manage asynchronous API requests.
21286 # For more information, readHandling
21287 # API responses.
21288 #
21289 # Operations can be global, regional or zonal.
21290 #
21291 # - For global operations, use the `globalOperations`
21292 # resource.
21293 # - For regional operations, use the
21294 # `regionOperations` resource.
21295 # - For zonal operations, use
21296 # the `zoneOperations` resource.
21297 #
21298 #
21299 #
21300 # For more information, read
21301 # Global, Regional, and Zonal Resources.
21302 #
21303 # Note that completed Operation resources have a limited
21304 # retention period.
21305 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
21306 # Not present otherwise.
21307 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
21308 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
21309 # set when the operation is created.
21310 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
21311 # text format.
21312 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
21313 # this field will be populated.
21314 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
21315 # operation.
21316 {
21317 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
21318 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
21319 # details. There is a set of defined message types to use for providing
21320 # details.The syntax depends on the error code. For example,
21321 # QuotaExceededInfo will have details when the error code is
21322 # QUOTA_EXCEEDED.
21323 {
21324 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
21325 #
21326 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
21327 # is not enabled:
21328 #
21329 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
21330 # &quot;domain&quot;: &quot;googleapis.com&quot;
21331 # &quot;metadata&quot;: {
21332 # &quot;resource&quot;: &quot;projects/123&quot;,
21333 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
21334 # }
21335 # }
21336 #
21337 # This response indicates that the pubsub.googleapis.com API is not enabled.
21338 #
21339 # Example of an error that is returned when attempting to create a Spanner
21340 # instance in a region that is out of stock:
21341 #
21342 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
21343 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
21344 # &quot;metadata&quot;: {
21345 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
21346 # }
21347 # }
21348 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
21349 # is typically the registered service name of the tool or product that
21350 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
21351 # generated by some common infrastructure, the error domain must be a
21352 # globally unique value that identifies the infrastructure. For Google API
21353 # infrastructure, the error domain is &quot;googleapis.com&quot;.
21354 &quot;metadatas&quot;: { # Additional structured details about this error.
21355 #
21356 # Keys must match a regular expression of `a-z+` but should
21357 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
21358 # length. When identifying the current value of an exceeded limit, the units
21359 # should be contained in the key, not the value. For example, rather than
21360 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
21361 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
21362 # instances that can be created in a single (batch) request.
21363 &quot;a_key&quot;: &quot;A String&quot;,
21364 },
21365 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
21366 # proximate cause of the error. Error reasons are unique within a particular
21367 # domain of errors. This should be at most 63 characters and match a
21368 # regular expression of `A-Z+[A-Z0-9]`, which represents
21369 # UPPER_SNAKE_CASE.
21370 },
21371 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
21372 #
21373 # For example, if a quota check failed with an error indicating the calling
21374 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
21375 # directly to the right place in the developer console to flip the bit.
21376 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
21377 { # Describes a URL link.
21378 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
21379 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
21380 },
21381 ],
21382 },
21383 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
21384 # which can be attached to an RPC error.
21385 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
21386 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
21387 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
21388 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
21389 },
21390 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
21391 &quot;dimensions&quot;: { # The map holding related quota dimensions.
21392 &quot;a_key&quot;: &quot;A String&quot;,
21393 },
21394 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
21395 # type or metric.
21396 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
21397 # or metric.
21398 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
21399 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
21400 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
21401 },
21402 },
21403 ],
21404 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
21405 # This property is optional.
21406 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
21407 },
21408 ],
21409 },
21410 &quot;getVersionOperationMetadata&quot;: {
21411 &quot;inlineSbomInfo&quot;: {
21412 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
21413 # appropriate identifiers.
21414 &quot;a_key&quot;: &quot;A String&quot;,
21415 },
21416 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
21417 # identifiers.
21418 &quot;a_key&quot;: &quot;A String&quot;,
21419 },
21420 },
21421 },
21422 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
21423 # message that was returned, such as `NOT FOUND`.
21424 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
21425 # status code that was returned. For example, a `404` means the
21426 # resource was not found.
21427 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
21428 # defined by the server.
21429 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
21430 # This value is inRFC3339
21431 # text format.
21432 &quot;instancesBulkInsertOperationMetadata&quot;: {
21433 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
21434 # Example key: zones/us-central1-a
21435 &quot;a_key&quot;: {
21436 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
21437 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
21438 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
21439 # error.
21440 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
21441 # if the flow is rolling forward or rolling back.
21442 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
21443 },
21444 },
21445 },
21446 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
21447 # Operation resources.
21448 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
21449 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
21450 # group of operations results from a `bulkInsert` API request.
21451 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
21452 # `update`, or `delete`, and so on.
21453 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
21454 # There is no requirement that this be linear or support any granularity of
21455 # operations. This should not be used to guess when the operation will be
21456 # complete. This number should monotonically increase as the operation
21457 # progresses.
21458 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
21459 # applicable when performing regional operations.
21460 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
21461 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
21462 # this field will contain information on all underlying zonal actions and
21463 # their state.
21464 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
21465 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
21466 # Example key: zones/us-central1-a
21467 &quot;a_key&quot;: {
21468 &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
21469 # populated.
21470 # different programming environments, including REST APIs and RPC APIs. It is
21471 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
21472 # three pieces of data: error code, error message, and error details.
21473 #
21474 # You can find out more about this error model and how to work with it in the
21475 # [API Design Guide](https://cloud.google.com/apis/design/errors).
21476 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
21477 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
21478 # message types for APIs to use.
21479 {
21480 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
21481 },
21482 ],
21483 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
21484 # user-facing error message should be localized and sent in the
21485 # google.rpc.Status.details field, or localized by the client.
21486 },
21487 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
21488 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
21489 },
21490 },
21491 },
21492 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
21493 # This value is inRFC3339
21494 # text format.
21495 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
21496 # following:
21497 # `PENDING`, `RUNNING`, or `DONE`.
21498 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
21499 # operation.
21500 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
21501 # of the target resource.
21502 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
21503 # operations related to creating a snapshot, this points to the disk
21504 # that the snapshot was created from.
21505 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
21506 # `[email protected]` or
21507 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
21508 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
21509 # operation, this field will be populated.
21510 {
21511 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
21512 # Engine returns NO_RESULTS_ON_PAGE if there
21513 # are no results in the response.
21514 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
21515 # value format. For example:
21516 #
21517 # &quot;data&quot;: [
21518 # {
21519 # &quot;key&quot;: &quot;scope&quot;,
21520 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
21521 # }
21522 {
21523 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
21524 # returned. For example, for warnings where there are no results in a list
21525 # request for a particular zone, this key might be scope and
21526 # the key value might be the zone name. Other examples might be a key
21527 # indicating a deprecated resource and a suggested replacement, or a
21528 # warning about invalid network settings (for example, if an instance
21529 # attempts to perform IP forwarding but is not enabled for IP forwarding).
21530 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
21531 },
21532 ],
21533 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
21534 },
21535 ],
21536 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
21537 # applicable when performing per-zone operations.
21538 }</pre>
21539 </div>
21540
21541 <div class="method">
21542 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
21543 <pre>Returns permissions that a caller has on the specified resource.
21544
21545 Args:
21546 project: string, Project ID for this request. (required)
21547 zone: string, The name of the zone for this request. (required)
21548 resource: string, Name or id of the resource for this request. (required)
21549 body: object, The request body.
21550 The object takes the form of:
21551
21552 {
21553 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
21554 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
21555 &quot;A String&quot;,
21556 ],
21557 }
21558
21559 x__xgafv: string, V1 error format.
21560 Allowed values
21561 1 - v1 error format
21562 2 - v2 error format
21563
21564 Returns:
21565 An object of the form:
21566
21567 {
21568 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
21569 # allowed.
21570 &quot;A String&quot;,
21571 ],
21572 }</pre>
21573 </div>
21574
21575 <div class="method">
21576 <code class="details" id="update">update(project, zone, instance, body=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</code>
21577 <pre>Updates an instance only if the necessary resources are available. This
21578 method can update only a specific set of instance properties. See
21579 Updating a running instance for a list of updatable instance
21580 properties.
21581
21582 Args:
21583 project: string, Project ID for this request. (required)
21584 zone: string, The name of the zone for this request. (required)
21585 instance: string, Name of the instance resource to update. (required)
21586 body: object, The request body.
21587 The object takes the form of:
21588
21589 { # Represents an Instance resource.
21590 #
21591 # An instance is a virtual machine that is hosted on Google Cloud Platform.
21592 # For more information, readVirtual Machine Instances.
21593 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
21594 # Options that would traditionally be configured in a BIOS belong
21595 # here. Features that require operating system support may have
21596 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
21597 # disabled).
21598 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
21599 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
21600 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
21601 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
21602 # multithreading (SMT) set this to 1. If unset, the maximum number
21603 # of threads supported per core by the underlying processor is
21604 # assumed.
21605 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
21606 # Supported modes include:
21607 # * ALL_CORE_MAX
21608 #
21609 # Using empty string or not setting this field will use the platform-specific
21610 # default turbo mode.
21611 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
21612 # the number of threads per core to compute the total number of virtual
21613 # CPUs to expose to the instance. If unset, the number of cores is
21614 # inferred from the instance&#x27;s nominal CPU count and the underlying
21615 # platform&#x27;s SMT width.
21616 },
21617 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
21618 # destination or source IPs. This is required if you plan to use this
21619 # instance to forward routes. For more information, seeEnabling IP Forwarding.
21620 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
21621 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
21622 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
21623 },
21624 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
21625 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
21626 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
21627 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
21628 # create the resource.
21629 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
21630 # created before you can assign them.
21631 { # An instance-attached disk resource.
21632 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
21633 # or X86_64.
21634 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
21635 # deleted (but not when the disk is detached from the instance).
21636 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
21637 # partition of the disk for its root filesystem.
21638 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
21639 # running within the instance. This name can be used to reference the device
21640 # for mounting, resizing, and so on, from within the instance.
21641 #
21642 # If not specified, the server chooses a default device name to apply to this
21643 # disk, in the form persistent-disk-x, where x is a number
21644 # assigned by Google Compute Engine. This field is only applicable for
21645 # persistent disks.
21646 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
21647 # encryption key.
21648 #
21649 # If you are creating a new disk, this field encrypts the new disk using
21650 # an encryption key that you provide. If you are attaching an existing
21651 # disk that is already encrypted, this field decrypts the disk using
21652 # the customer-supplied encryption key.
21653 #
21654 # If you encrypt a disk using a customer-supplied key, you must provide the
21655 # same key again when you attempt to use this resource at a later time. For
21656 # example, you must provide the key when you create a snapshot or an image
21657 # from the disk or when you attach the disk to a virtual machine instance.
21658 #
21659 # If you do not provide an encryption key, then the disk will be encrypted
21660 # using an automatically generated key and you do not need to provide a key
21661 # to use the disk later.
21662 #
21663 # Note:
21664 #
21665 # Instance templates do not storecustomer-supplied
21666 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
21667 #
21668 # You cannot create VMs that have disks with customer-supplied keys using
21669 # the bulk
21670 # insert method.
21671 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
21672 # For example:
21673 #
21674 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21675 # key_region/cryptoKeys/key
21676 #
21677 # The fully-qualifed key name may be returned for resource GET requests. For
21678 # example:
21679 #
21680 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21681 # key_region/cryptoKeys/key
21682 # /cryptoKeyVersions/1
21683 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
21684 # key. If absent, the Compute Engine default service account is used.
21685 # For example:
21686 #
21687 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
21688 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
21689 # encryption key, encoded in RFC
21690 # 4648 base64 to either encrypt or decrypt this resource. You can
21691 # provide either the rawKey or thersaEncryptedKey.
21692 # For example:
21693 #
21694 # &quot;rawKey&quot;:
21695 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
21696 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
21697 # customer-supplied encryption key to either encrypt or decrypt this
21698 # resource. You can provide either the rawKey or thersaEncryptedKey.
21699 # For example:
21700 #
21701 # &quot;rsaEncryptedKey&quot;:
21702 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
21703 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
21704 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
21705 #
21706 # The key must meet the following requirements before you can provide it to
21707 # Compute Engine:
21708 #
21709 # 1. The key is wrapped using a RSA public key certificate provided by
21710 # Google.
21711 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
21712 # encoding.
21713 #
21714 # Gets the RSA public key certificate provided by Google at:
21715 #
21716 #
21717 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
21718 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
21719 # 4648 base64 encoded SHA-256 hash of the customer-supplied
21720 # encryption key that protects this resource.
21721 },
21722 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
21723 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
21724 # currently attached to another instance. If you try to force attach a zonal
21725 # disk to an instance, you will receive an error.
21726 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
21727 # only for bootable images. Read
21728 # Enabling guest operating system features to see a list of available
21729 # options.
21730 { # Guest OS features.
21731 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
21732 # separate values. Set to one or more of the following values:
21733 #
21734 # - VIRTIO_SCSI_MULTIQUEUE
21735 # - WINDOWS
21736 # - MULTI_IP_SUBNET
21737 # - UEFI_COMPATIBLE
21738 # - GVNIC
21739 # - SEV_CAPABLE
21740 # - SUSPEND_RESUME_COMPATIBLE
21741 # - SEV_LIVE_MIGRATABLE_V2
21742 # - SEV_SNP_CAPABLE
21743 # - TDX_CAPABLE
21744 # - IDPF
21745 # - SNP_SVSM_CAPABLE
21746 # - CCA_CAPABLE
21747 #
21748 #
21749 # For more information, see
21750 # Enabling guest operating system features.
21751 },
21752 ],
21753 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
21754 # boot disk. If you have many disks attached to an instance, each
21755 # disk would have a unique index number.
21756 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
21757 # alongside the new instance. Use initialization parameters to create boot
21758 # disks or local SSDs attached to the new instance.
21759 #
21760 # This property is mutually exclusive with the source property;
21761 # you can only define one or the other, but not both.
21762 # alongside the new instance. Use initialization parameters to create boot
21763 # disks or local SSDs attached to the new instance.
21764 #
21765 # This field is persisted and returned for instanceTemplate and not returned
21766 # in the context of instance.
21767 #
21768 # This property is mutually exclusive with the source property;
21769 # you can only define one or the other, but not both.
21770 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
21771 # arm64 or x86_64.
21772 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
21773 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
21774 # of the instance. If a disk with the same name already exists in the given
21775 # region, the existing disk is attached to the new instance and the
21776 # new disk is not created.
21777 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
21778 # 10 GB. If you specify a sourceImage, which is required for
21779 # boot disks, the default size is the size of the sourceImage.
21780 # If you do not specify a sourceImage, the default disk size
21781 # is 500 GB.
21782 &quot;diskType&quot;: &quot;A String&quot;,
21783 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
21784 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
21785 # only for bootable images. Read
21786 # Enabling guest operating system features to see a list of available
21787 # options.
21788 #
21789 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
21790 { # Guest OS features.
21791 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
21792 # separate values. Set to one or more of the following values:
21793 #
21794 # - VIRTIO_SCSI_MULTIQUEUE
21795 # - WINDOWS
21796 # - MULTI_IP_SUBNET
21797 # - UEFI_COMPATIBLE
21798 # - GVNIC
21799 # - SEV_CAPABLE
21800 # - SUSPEND_RESUME_COMPATIBLE
21801 # - SEV_LIVE_MIGRATABLE_V2
21802 # - SEV_SNP_CAPABLE
21803 # - TDX_CAPABLE
21804 # - IDPF
21805 # - SNP_SVSM_CAPABLE
21806 # - CCA_CAPABLE
21807 #
21808 #
21809 # For more information, see
21810 # Enabling guest operating system features.
21811 },
21812 ],
21813 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
21814 # persistent disks.
21815 &quot;a_key&quot;: &quot;A String&quot;,
21816 },
21817 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
21818 &quot;A String&quot;,
21819 ],
21820 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
21821 # more than one instance.
21822 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
21823 # is to use the existing disk.
21824 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
21825 # of I/O operations per second that the disk can handle. Values must be
21826 # between 10,000 and 120,000. For more details, see theExtreme persistent
21827 # disk documentation.
21828 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
21829 # number of throughput mb per second that the disk can handle. Values must
21830 # greater than or equal to 1.
21831 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
21832 # the URLs of the zones where the disk should be replicated to.
21833 # You must provide exactly two replica zones, and one zone must be the same
21834 # as the instance zone.
21835 &quot;A String&quot;,
21836 ],
21837 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
21838 # have the same definition as resource
21839 # manager tags. Keys and values can be either in numeric format,
21840 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
21841 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
21842 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
21843 # empty.
21844 &quot;a_key&quot;: &quot;A String&quot;,
21845 },
21846 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
21847 # Specified using the full or partial URL. For instance template, specify
21848 # only the resource policy name.
21849 &quot;A String&quot;,
21850 ],
21851 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
21852 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
21853 # is required.
21854 #
21855 # To create a disk with one of the public operating system
21856 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
21857 #
21858 # projects/debian-cloud/global/images/family/debian-9
21859 #
21860 #
21861 # Alternatively, use a specific version of a public operating system image:
21862 #
21863 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
21864 #
21865 #
21866 # To create a disk with a custom image that you created, specify the
21867 # image name in the following format:
21868 #
21869 # global/images/my-custom-image
21870 #
21871 #
21872 # You can also specify a custom image by its image family, which returns
21873 # the latest version of the image in that family. Replace the image name
21874 # with family/family-name:
21875 #
21876 # global/images/family/my-image-family
21877 #
21878 #
21879 # If the source image is deleted later, this field will not be set.
21880 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
21881 # encryption key of the source image. Required if the source image is
21882 # protected by a customer-supplied encryption key.
21883 #
21884 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
21885 # encryption keys, so you cannot create disks for instances in a managed instance group if the
21886 # source images are encrypted with your own keys.
21887 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
21888 # For example:
21889 #
21890 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21891 # key_region/cryptoKeys/key
21892 #
21893 # The fully-qualifed key name may be returned for resource GET requests. For
21894 # example:
21895 #
21896 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21897 # key_region/cryptoKeys/key
21898 # /cryptoKeyVersions/1
21899 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
21900 # key. If absent, the Compute Engine default service account is used.
21901 # For example:
21902 #
21903 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
21904 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
21905 # encryption key, encoded in RFC
21906 # 4648 base64 to either encrypt or decrypt this resource. You can
21907 # provide either the rawKey or thersaEncryptedKey.
21908 # For example:
21909 #
21910 # &quot;rawKey&quot;:
21911 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
21912 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
21913 # customer-supplied encryption key to either encrypt or decrypt this
21914 # resource. You can provide either the rawKey or thersaEncryptedKey.
21915 # For example:
21916 #
21917 # &quot;rsaEncryptedKey&quot;:
21918 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
21919 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
21920 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
21921 #
21922 # The key must meet the following requirements before you can provide it to
21923 # Compute Engine:
21924 #
21925 # 1. The key is wrapped using a RSA public key certificate provided by
21926 # Google.
21927 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
21928 # encoding.
21929 #
21930 # Gets the RSA public key certificate provided by Google at:
21931 #
21932 #
21933 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
21934 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
21935 # 4648 base64 encoded SHA-256 hash of the customer-supplied
21936 # encryption key that protects this resource.
21937 },
21938 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
21939 # instance boot disk, one of initializeParams.sourceSnapshot
21940 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
21941 # is required.
21942 #
21943 # To create a disk with a snapshot that you created, specify the
21944 # snapshot name in the following format:
21945 #
21946 # us-central1-a/instantSnapshots/my-backup
21947 #
21948 #
21949 # If the source instant-snapshot is deleted later, this field will not be
21950 # set.
21951 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
21952 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
21953 # is required.
21954 #
21955 # To create a disk with a snapshot that you created, specify the
21956 # snapshot name in the following format:
21957 #
21958 # global/snapshots/my-backup
21959 #
21960 #
21961 # If the source snapshot is deleted later, this field will not be set.
21962 #
21963 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
21964 # an image instead when you create VMs using
21965 # the bulk
21966 # insert method.
21967 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
21968 # encryption key of the source snapshot.
21969 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
21970 # For example:
21971 #
21972 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21973 # key_region/cryptoKeys/key
21974 #
21975 # The fully-qualifed key name may be returned for resource GET requests. For
21976 # example:
21977 #
21978 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21979 # key_region/cryptoKeys/key
21980 # /cryptoKeyVersions/1
21981 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
21982 # key. If absent, the Compute Engine default service account is used.
21983 # For example:
21984 #
21985 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
21986 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
21987 # encryption key, encoded in RFC
21988 # 4648 base64 to either encrypt or decrypt this resource. You can
21989 # provide either the rawKey or thersaEncryptedKey.
21990 # For example:
21991 #
21992 # &quot;rawKey&quot;:
21993 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
21994 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
21995 # customer-supplied encryption key to either encrypt or decrypt this
21996 # resource. You can provide either the rawKey or thersaEncryptedKey.
21997 # For example:
21998 #
21999 # &quot;rsaEncryptedKey&quot;:
22000 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
22001 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
22002 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
22003 #
22004 # The key must meet the following requirements before you can provide it to
22005 # Compute Engine:
22006 #
22007 # 1. The key is wrapped using a RSA public key certificate provided by
22008 # Google.
22009 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
22010 # encoding.
22011 #
22012 # Gets the RSA public key certificate provided by Google at:
22013 #
22014 #
22015 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
22016 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
22017 # 4648 base64 encoded SHA-256 hash of the customer-supplied
22018 # encryption key that protects this resource.
22019 },
22020 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
22021 # this as a partial or full URL to the resource. For example, the following
22022 # are valid values:
22023 #
22024 #
22025 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
22026 # - projects/project/zones/zone/storagePools/storagePool
22027 # - zones/zone/storagePools/storagePool
22028 },
22029 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
22030 # either SCSI or NVME. For most machine types, the
22031 # default is SCSI. Local SSDs can use either NVME or SCSI.
22032 # In certain configurations, persistent disks can use NVMe. For more
22033 # information, seeAbout
22034 # persistent disks.
22035 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
22036 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
22037 &quot;A String&quot;,
22038 ],
22039 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
22040 # disk is not allowed to be detached from the instance, or to be used as the
22041 # source of the snapshot creation, and the image creation. The instance with
22042 # at least one locked attached disk is not allow to be used as source of
22043 # machine image creation, instant snapshot creation, and not allowed to be
22044 # deleted with --keep-disk parameter set to true for locked disks.
22045 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
22046 # in READ_WRITE mode.
22047 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
22048 # field is set to PRESERVED if the LocalSSD data has been saved
22049 # to a persistent location by customer request. (see the
22050 # discard_local_ssd option on Stop/Suspend).
22051 # Read-only in the api.
22052 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
22053 # these are public keys which are safe to store in public
22054 &quot;dbs&quot;: [ # The Key Database (db).
22055 {
22056 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
22057 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
22058 },
22059 ],
22060 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
22061 {
22062 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
22063 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
22064 },
22065 ],
22066 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
22067 {
22068 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
22069 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
22070 },
22071 ],
22072 &quot;pk&quot;: { # The Platform Key (PK).
22073 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
22074 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
22075 },
22076 },
22077 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
22078 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
22079 # is required.
22080 #
22081 # If desired, you can also attach existing non-root persistent disks using
22082 # this property. This field is only applicable for persistent disks.
22083 #
22084 # Note that for InstanceTemplate, specify the disk name for zonal disk,
22085 # and the URL for regional disk.
22086 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
22087 },
22088 ],
22089 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
22090 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
22091 },
22092 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
22093 # machine image should erase Windows specific VSS signature.
22094 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
22095 # the instance&#x27;s contents and used for optimistic locking. The
22096 # fingerprint is initially generated by Compute Engine and changes after
22097 # every request to modify or update the instance. You must always provide an
22098 # up-to-date fingerprint hash in order to update the instance.
22099 #
22100 # To see the latest fingerprint, make get() request to the
22101 # instance.
22102 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
22103 { # A specification of the type and number of accelerator cards attached to the
22104 # instance.
22105 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
22106 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
22107 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
22108 # If you are creating an instance template, specify only the
22109 # accelerator name.
22110 # See GPUs on Compute Engine
22111 # for a full list of accelerator types.
22112 },
22113 ],
22114 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
22115 # RFC1035 compliant. If hostname is not specified, the default hostname is
22116 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
22117 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
22118 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
22119 # defined by the server.
22120 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
22121 # encryption key.
22122 #
22123 # If you are creating a new instance, this field will encrypt the local SSD
22124 # and in-memory contents of the instance during the suspend operation.
22125 #
22126 # If you do not provide an encryption key when creating the instance, then
22127 # the local SSD and in-memory contents will be encrypted using
22128 # an automatically generated key during the suspend operation.
22129 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
22130 # For example:
22131 #
22132 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
22133 # key_region/cryptoKeys/key
22134 #
22135 # The fully-qualifed key name may be returned for resource GET requests. For
22136 # example:
22137 #
22138 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
22139 # key_region/cryptoKeys/key
22140 # /cryptoKeyVersions/1
22141 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
22142 # key. If absent, the Compute Engine default service account is used.
22143 # For example:
22144 #
22145 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
22146 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
22147 # encryption key, encoded in RFC
22148 # 4648 base64 to either encrypt or decrypt this resource. You can
22149 # provide either the rawKey or thersaEncryptedKey.
22150 # For example:
22151 #
22152 # &quot;rawKey&quot;:
22153 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
22154 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
22155 # customer-supplied encryption key to either encrypt or decrypt this
22156 # resource. You can provide either the rawKey or thersaEncryptedKey.
22157 # For example:
22158 #
22159 # &quot;rsaEncryptedKey&quot;:
22160 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
22161 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
22162 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
22163 #
22164 # The key must meet the following requirements before you can provide it to
22165 # Compute Engine:
22166 #
22167 # 1. The key is wrapped using a RSA public key certificate provided by
22168 # Google.
22169 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
22170 # encoding.
22171 #
22172 # Gets the RSA public key certificate provided by Google at:
22173 #
22174 #
22175 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
22176 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
22177 # 4648 base64 encoded SHA-256 hash of the customer-supplied
22178 # encryption key that protects this resource.
22179 },
22180 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
22181 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
22182 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
22183 # for instances.
22184 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
22185 # the label&#x27;s contents and used for optimistic locking. The
22186 # fingerprint is initially generated by Compute Engine and changes after
22187 # every request to modify or update labels. You must always provide an
22188 # up-to-date fingerprint hash in order to update or change labels.
22189 #
22190 # To see the latest fingerprint, make get() request to the
22191 # instance.
22192 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
22193 # the setLabels method.
22194 &quot;a_key&quot;: &quot;A String&quot;,
22195 },
22196 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
22197 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
22198 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
22199 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
22200 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
22201 # when the instance is created. For example, the following is a valid partial
22202 # url to a predefined
22203 # machine type:
22204 #
22205 # zones/us-central1-f/machineTypes/n1-standard-1
22206 #
22207 #
22208 # To create acustom
22209 # machine type, provide a URL to a machine type in the following format,
22210 # where CPUS is 1 or an even number up to 32 (2,
22211 # 4, 6, ... 24, etc), and MEMORY is the total
22212 # memory for this instance. Memory must be a multiple of 256 MB and must
22213 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
22214 #
22215 # zones/zone/machineTypes/custom-CPUS-MEMORY
22216 #
22217 #
22218 # For example: zones/us-central1-f/machineTypes/custom-4-5120
22219 # For a full list of restrictions, read theSpecifications
22220 # for custom machine types.
22221 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
22222 # to this instance. This includes metadata keys that were explicitly defined
22223 # for the instance.
22224 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
22225 # the metadata&#x27;s contents and used for optimistic locking. The
22226 # fingerprint is initially generated by Compute Engine and changes after
22227 # every request to modify or update metadata. You must always provide an
22228 # up-to-date fingerprint hash in order to update or change metadata,
22229 # otherwise the request will fail with error412 conditionNotMet.
22230 #
22231 # To see the latest fingerprint, make a get() request to
22232 # retrieve the resource.
22233 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
22234 # less than 512 KB.
22235 { # Metadata
22236 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
22237 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
22238 # This is reflected as part of a URL in the metadata server. Additionally, to
22239 # avoid ambiguity, keys must not conflict with any other metadata keys
22240 # for the project.
22241 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
22242 # have meaning as interpreted by the image running in the instance. The
22243 # only restriction placed on values is that their size must be less than
22244 # or equal to 262144 bytes (256 KiB).
22245 },
22246 ],
22247 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
22248 # for metadata.
22249 },
22250 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
22251 # platform for the VM instance. Applicable values are the friendly names
22252 # of CPU platforms, such as minCpuPlatform: &quot;Intel
22253 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
22254 # Bridge&quot;.
22255 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
22256 # the resource. The resource name must be 1-63 characters long, and comply
22257 # withRFC1035.
22258 # Specifically, the name must be 1-63 characters long and match the regular
22259 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
22260 # character must be a lowercase letter, and all following characters must be
22261 # a dash, lowercase letter, or digit, except the last character, which cannot
22262 # be a dash.
22263 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
22264 # interfaces are configured to interact with other network services, such as
22265 # connecting to the internet. Multiple interfaces are supported
22266 # per instance.
22267 { # A network interface resource attached to an instance.
22268 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
22269 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
22270 # no external internet access.
22271 { # An access configuration attached to an instance&#x27;s network interface.
22272 # Only one access config per instance is supported.
22273 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
22274 # The first IPv6 address of the external IPv6 range associated
22275 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
22276 # use a static external IP address, it must be unused and in the same region
22277 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
22278 # assign an external IPv6 address from the instance&#x27;s subnetwork.
22279 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
22280 # external IPv6 range.
22281 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
22282 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
22283 # (IPv4), the default and recommended name is External NAT, but
22284 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
22285 # recommend name is External IPv6.
22286 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
22287 # address associated with this instance. Specify an unused static
22288 # external IP address available to the project or leave this field undefined
22289 # to use an IP from a shared ephemeral IP address pool. If you specify a
22290 # static external IP address, it must live in the same region as the zone of
22291 # the instance.
22292 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
22293 # configuration and can only take the following values: PREMIUM,STANDARD.
22294 #
22295 # If an AccessConfig is specified without a valid external IP address, an
22296 # ephemeral IP will be created with this networkTier.
22297 #
22298 # If an AccessConfig with a valid external IP address is specified, it must
22299 # match that of the networkTier associated with the Address resource owning
22300 # that IP.
22301 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
22302 #
22303 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
22304 # first IP in associated external IPv6 range.
22305 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
22306 # config.
22307 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
22308 # external IP address of the instance to a DNS domain name.
22309 #
22310 # This field is not used in ipv6AccessConfig. A default PTR
22311 # record will be created if the VM has external IPv6 range associated.
22312 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
22313 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
22314 },
22315 ],
22316 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
22317 # You can only specify this field for network interfaces in VPC networks.
22318 { # An alias IP range attached to an instance&#x27;s network interface.
22319 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
22320 # must belong to the specified subnetwork and cannot contain IP addresses
22321 # reserved by system or used by other network interfaces. This range may be
22322 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
22323 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
22324 # alias range. If not specified, the primary range of the subnetwork is used.
22325 },
22326 ],
22327 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
22328 # You can only specify this field for network interfaces in VPC networks.
22329 { # An alias IP range attached to an instance&#x27;s network interface.
22330 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
22331 # must belong to the specified subnetwork and cannot contain IP addresses
22332 # reserved by system or used by other network interfaces. This range may be
22333 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
22334 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
22335 # alias range. If not specified, the primary range of the subnetwork is used.
22336 },
22337 ],
22338 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
22339 # with network_attachment.
22340 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
22341 # This field will be ignored when inserting an Instance or
22342 # adding a NetworkInterface. An up-to-date
22343 # fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
22344 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
22345 # or not. If enabled, also indicates the version of IGMP supported.
22346 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
22347 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
22348 # one IPv6 access config, DIRECT_IPV6, is supported. If there
22349 # is no ipv6AccessConfig specified, then this instance will
22350 # have no external IPv6 Internet access.
22351 { # An access configuration attached to an instance&#x27;s network interface.
22352 # Only one access config per instance is supported.
22353 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
22354 # The first IPv6 address of the external IPv6 range associated
22355 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
22356 # use a static external IP address, it must be unused and in the same region
22357 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
22358 # assign an external IPv6 address from the instance&#x27;s subnetwork.
22359 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
22360 # external IPv6 range.
22361 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
22362 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
22363 # (IPv4), the default and recommended name is External NAT, but
22364 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
22365 # recommend name is External IPv6.
22366 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
22367 # address associated with this instance. Specify an unused static
22368 # external IP address available to the project or leave this field undefined
22369 # to use an IP from a shared ephemeral IP address pool. If you specify a
22370 # static external IP address, it must live in the same region as the zone of
22371 # the instance.
22372 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
22373 # configuration and can only take the following values: PREMIUM,STANDARD.
22374 #
22375 # If an AccessConfig is specified without a valid external IP address, an
22376 # ephemeral IP will be created with this networkTier.
22377 #
22378 # If an AccessConfig with a valid external IP address is specified, it must
22379 # match that of the networkTier associated with the Address resource owning
22380 # that IP.
22381 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
22382 #
22383 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
22384 # first IP in associated external IPv6 range.
22385 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
22386 # config.
22387 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
22388 # external IP address of the instance to a DNS domain name.
22389 #
22390 # This field is not used in ipv6AccessConfig. A default PTR
22391 # record will be created if the VM has external IPv6 range associated.
22392 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
22393 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
22394 },
22395 ],
22396 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
22397 # accessed from the Internet. This field is always inherited from its
22398 # subnetwork.
22399 #
22400 # Valid only if stackType is IPV4_IPV6.
22401 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
22402 # use a static internal IP address, it must be unused and in the same region
22403 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
22404 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
22405 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
22406 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
22407 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
22408 # server. For a VM, the network interface uses the nicN naming
22409 # format. Where N is a value between 0 and7. The default interface value is nic0.
22410 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
22411 # instance, if neither the network nor the subnetwork is specified, the
22412 # default network global/networks/default is used. If the
22413 # selected project doesn&#x27;t have the default network, you must specify a
22414 # network or subnet. If the network is not specified but the subnetwork is
22415 # specified, the network is inferred.
22416 #
22417 # If you specify this property, you can specify the network as
22418 # a full or partial URL. For example, the following are all valid URLs:
22419 #
22420 #
22421 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
22422 # - projects/project/global/networks/network
22423 # - global/networks/default
22424 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
22425 # to in the following format:
22426 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
22427 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
22428 # interface. If not specified by the user, an unused internal IP is
22429 # assigned by the system.
22430 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
22431 # VirtioNet.
22432 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
22433 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
22434 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
22435 # if not specified by the users.
22436 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
22437 # interface. Can only be used with network_attachment. It is not possible to
22438 # use on its own however, network_attachment can be used without
22439 # service_class_id.
22440 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
22441 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
22442 #
22443 # This field can be both set at instance creation and update network
22444 # interface operations.
22445 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
22446 # resource is inlegacy
22447 # mode, do not specify this field. If the network is in auto subnet
22448 # mode, specifying the subnetwork is optional. If the network is in custom
22449 # subnet mode, specifying the subnetwork is required. If you specify this
22450 # field, you can specify the subnetwork as a full or partial URL. For
22451 # example, the following are all valid URLs:
22452 #
22453 #
22454 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
22455 # - regions/region/subnetworks/subnetwork
22456 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
22457 # from 2 to 255 inclusively.
22458 },
22459 ],
22460 &quot;networkPerformanceConfig&quot;: {
22461 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
22462 },
22463 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
22464 # as part of resource payload.
22465 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
22466 # Instances.Insert API.
22467 # as a count of seconds and fractions of seconds at nanosecond
22468 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
22469 # or &quot;month&quot;. Range is approximately 10,000 years.
22470 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
22471 # Durations less than one second are represented with a 0
22472 # `seconds` field and a positive `nanos` field. Must be from 0
22473 # to 999,999,999 inclusive.
22474 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
22475 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
22476 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
22477 },
22478 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
22479 # have the same definition as resource
22480 # manager tags. Keys and values can be either in numeric format,
22481 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
22482 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
22483 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
22484 # PATCH) when empty.
22485 &quot;a_key&quot;: &quot;A String&quot;,
22486 },
22487 },
22488 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
22489 # (namespace) to entries map.
22490 &quot;a_key&quot;: {
22491 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
22492 # It accepts any value including google.protobuf.Struct.
22493 &quot;a_key&quot;: &quot;&quot;,
22494 },
22495 },
22496 },
22497 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
22498 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
22499 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
22500 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
22501 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
22502 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
22503 # Consuming reserved instances for examples.
22504 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
22505 # the name of your reservation as its value.
22506 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
22507 # either a name to a reservation in the same project or
22508 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
22509 # shared reservation in the same zone but in a different project.
22510 &quot;A String&quot;,
22511 ],
22512 },
22513 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
22514 &quot;A String&quot;,
22515 ],
22516 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
22517 # compared to the values requested by user in the corresponding input only
22518 # field.
22519 # Use this sub-message for actual values set on Instance attributes as compared
22520 # to the value requested by the user (intent) in their instance CRUD calls.
22521 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
22522 # zonal instance settings, and instance-level predefined metadata keys to
22523 # provide the overridden value for those metadata keys at the instance level.
22524 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
22525 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
22526 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
22527 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
22528 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
22529 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
22530 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
22531 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
22532 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
22533 },
22534 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
22535 # center, including the block, sub-block, and host. The field is formatted as
22536 # follows: blockId/subBlockId/hostId.
22537 &quot;physicalHostTopology&quot;: { # Represents the physical host topology of the host on which the VM is # Output only. [Output Only] A series of fields containing the global name of the Compute
22538 # Engine cluster, as well as the ID of the block, sub-block, and host on
22539 # which the running instance is located.
22540 # running.
22541 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
22542 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
22543 # example
22544 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
22545 # the location ID of the topologies.
22546 &quot;a_key&quot;: &quot;A String&quot;,
22547 },
22548 },
22549 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
22550 # located. Instances within the same block experience low network latency.
22551 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
22552 # running instance is located.
22553 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
22554 # Instances on the same host experience the lowest possible network
22555 # latency.
22556 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
22557 # located. Instances in the same sub-block experience lower network latency
22558 # than instances in the same block.
22559 },
22560 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
22561 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
22562 # instance is consuming from.
22563 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
22564 # instance is consuming from.
22565 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
22566 # this instance is consuming from.
22567 },
22568 &quot;scheduling&quot;: {
22569 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
22570 # must be a number between 1 and the number of availability domains
22571 # specified in the spread placement policy attached to the instance.
22572 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
22573 },
22574 &quot;shutdownDetails&quot;: { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state.
22575 # programmed stop scheduled.
22576 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
22577 # `stop_state=PENDING_STOP`.
22578 # as a count of seconds and fractions of seconds at nanosecond
22579 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
22580 # or &quot;month&quot;. Range is approximately 10,000 years.
22581 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
22582 # Durations less than one second are represented with a 0
22583 # `seconds` field and a positive `nanos` field. Must be from 0
22584 # to 999,999,999 inclusive.
22585 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
22586 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
22587 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
22588 },
22589 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
22590 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
22591 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
22592 },
22593 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
22594 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
22595 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
22596 # This timestamp value is in RFC3339 text format.
22597 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
22598 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
22599 &quot;A String&quot;,
22600 ],
22601 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
22602 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
22603 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
22604 # This timestamp value is in RFC3339 text format.
22605 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
22606 # This timestamp value is in RFC3339 text format.
22607 },
22608 },
22609 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
22610 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
22611 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
22612 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
22613 # terminated by Compute Engine (not terminated by a user). You can only set
22614 # the automatic restart option for standard instances.Preemptible instances
22615 # cannot be automatically restarted.
22616 #
22617 # By default, this is set to true so an instance is
22618 # automatically restarted if it is terminated by Compute Engine.
22619 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
22620 # must be a number between 1 and the number of availability domains
22621 # specified in the spread placement policy attached to the instance.
22622 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
22623 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
22624 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the
22625 # graceful shutdown isn&#x27;t complete after this time, then the instance
22626 # transitions to the STOPPING state.
22627 # as a count of seconds and fractions of seconds at nanosecond
22628 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
22629 # or &quot;month&quot;. Range is approximately 10,000 years.
22630 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
22631 # Durations less than one second are represented with a 0
22632 # `seconds` field and a positive `nanos` field. Must be from 0
22633 # to 999,999,999 inclusive.
22634 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
22635 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
22636 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
22637 },
22638 },
22639 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
22640 # within the range of [90, 330] with the increment of 30, if unset, the
22641 # default behavior of host error recovery will be used.
22642 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
22643 &quot;localSsdRecoveryTimeout&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
22644 # recovery of the Local Ssd state is attempted. Its value should be in
22645 # between 0 and 168 hours with hour granularity and the default value being 1
22646 # hour.
22647 # as a count of seconds and fractions of seconds at nanosecond
22648 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
22649 # or &quot;month&quot;. Range is approximately 10,000 years.
22650 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
22651 # Durations less than one second are represented with a 0
22652 # `seconds` field and a positive `nanos` field. Must be from 0
22653 # to 999,999,999 inclusive.
22654 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
22655 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
22656 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
22657 },
22658 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
22659 # resources.
22660 # This field is for use by internal tools that use the public API.
22661 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
22662 # be scheduled for maintenance.
22663 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
22664 # are: `PERIODIC`.
22665 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
22666 # the instance termination action will be performed at the end of the run
22667 # duration.
22668 # as a count of seconds and fractions of seconds at nanosecond
22669 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
22670 # or &quot;month&quot;. Range is approximately 10,000 years.
22671 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
22672 # Durations less than one second are represented with a 0
22673 # `seconds` field and a positive `nanos` field. Must be from 0
22674 # to 999,999,999 inclusive.
22675 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
22676 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
22677 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
22678 },
22679 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
22680 # on a sole-tenant node.
22681 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
22682 # affinity for more information.
22683 # Overrides reservationAffinity.
22684 { # Node Affinity: the configuration of desired nodes onto which this Instance
22685 # could be scheduled.
22686 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
22687 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
22688 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
22689 &quot;A String&quot;,
22690 ],
22691 },
22692 ],
22693 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
22694 # the default behavior is MIGRATE. Forpreemptible instances,
22695 # the default and only possible behavior is TERMINATE. For more
22696 # information, see
22697 # Set
22698 # VM host maintenance policy.
22699 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
22700 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
22701 # else, the Local SSD data will be preserved when the instance is stopped
22702 # at the end of the run duration/termination time.
22703 },
22704 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
22705 # instance creation or while the instance isstopped and
22706 # therefore, in a `TERMINATED` state. SeeInstance Life
22707 # Cycle for more information on the possible instance states.
22708 &quot;preemptionNoticeDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
22709 # Off signal is triggered for Spot
22710 # VMs only. If not specified, there will be no wait before the G2 Soft
22711 # Off signal is triggered.
22712 # as a count of seconds and fractions of seconds at nanosecond
22713 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
22714 # or &quot;month&quot;. Range is approximately 10,000 years.
22715 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
22716 # Durations less than one second are represented with a 0
22717 # `seconds` field and a positive `nanos` field. Must be from 0
22718 # to 999,999,999 inclusive.
22719 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
22720 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
22721 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
22722 },
22723 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
22724 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
22725 # Off and ACPI G3 Mechanical
22726 # Off for Standard VMs and 30 seconds for Spot VMs.
22727 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
22728 # termination action will be performed at the termination time.
22729 },
22730 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
22731 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
22732 # this instance. Only one service account per VM instance is supported.
22733 #
22734 # Service accounts generate access tokens that can be accessed
22735 # through the metadata server and used to authenticate applications on the
22736 # instance. SeeService Accounts
22737 # for more information.
22738 { # A service account.
22739 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
22740 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
22741 &quot;A String&quot;,
22742 ],
22743 },
22744 ],
22745 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
22746 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
22747 # default.
22748 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
22749 # default.
22750 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
22751 # default.
22752 },
22753 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
22754 # Instance boot integrity is measured.
22755 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
22756 # measurements from the VM instance&#x27;s most recent boot.
22757 },
22758 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
22759 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
22760 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
22761 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
22762 },
22763 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
22764 # VM instance boot integrity is measured.
22765 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
22766 # measurements from the VM instance&#x27;s most recent boot.
22767 },
22768 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
22769 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
22770 # machine image.
22771 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
22772 # For example:
22773 #
22774 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
22775 # key_region/cryptoKeys/key
22776 #
22777 # The fully-qualifed key name may be returned for resource GET requests. For
22778 # example:
22779 #
22780 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
22781 # key_region/cryptoKeys/key
22782 # /cryptoKeyVersions/1
22783 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
22784 # key. If absent, the Compute Engine default service account is used.
22785 # For example:
22786 #
22787 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
22788 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
22789 # encryption key, encoded in RFC
22790 # 4648 base64 to either encrypt or decrypt this resource. You can
22791 # provide either the rawKey or thersaEncryptedKey.
22792 # For example:
22793 #
22794 # &quot;rawKey&quot;:
22795 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
22796 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
22797 # customer-supplied encryption key to either encrypt or decrypt this
22798 # resource. You can provide either the rawKey or thersaEncryptedKey.
22799 # For example:
22800 #
22801 # &quot;rsaEncryptedKey&quot;:
22802 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
22803 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
22804 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
22805 #
22806 # The key must meet the following requirements before you can provide it to
22807 # Compute Engine:
22808 #
22809 # 1. The key is wrapped using a RSA public key certificate provided by
22810 # Google.
22811 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
22812 # encoding.
22813 #
22814 # Gets the RSA public key certificate provided by Google at:
22815 #
22816 #
22817 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
22818 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
22819 # 4648 base64 encoded SHA-256 hash of the customer-supplied
22820 # encryption key that protects this resource.
22821 },
22822 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
22823 # Engine has detected suspicious activity.
22824 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
22825 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
22826 # instance, see
22827 # Instance life cycle.
22828 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
22829 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
22830 # sources or targets for network firewalls and are specified by the client
22831 # during instance creation. The tags can be later modified by the setTags
22832 # method. Each tag within the list must comply withRFC1035.
22833 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
22834 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
22835 # the tags&#x27; contents and used for optimistic locking. The
22836 # fingerprint is initially generated by Compute Engine and changes after
22837 # every request to modify or update tags. You must always provide an
22838 # up-to-date fingerprint hash in order to update or change tags.
22839 #
22840 # To see the latest fingerprint, make get() request to the
22841 # instance.
22842 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
22843 # with RFC1035.
22844 &quot;A String&quot;,
22845 ],
22846 },
22847 &quot;workloadIdentityConfig&quot;: {
22848 &quot;identity&quot;: &quot;A String&quot;,
22849 &quot;identityCertificateEnabled&quot;: True or False,
22850 },
22851 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
22852 # You must specify this field as part of the HTTP request URL. It is
22853 # not settable as a field in the request body.
22854 }
22855
22856 discardLocalSsd: boolean, Whether to discard local SSDs from the instance during restart
22857 default value is false.
22858 minimalAction: string, Specifies the action to take when updating an instance even if the
22859 updated properties do not require it. If not specified, then
22860 Compute Engine acts based on the minimum action that the updated
22861 properties require.
22862 Allowed values
22863 INVALID -
22864 NO_EFFECT - No changes can be made to the instance.
22865 REFRESH - The instance will not restart.
22866 RESTART - The instance will restart, potentially on a different host.
22867 mostDisruptiveAllowedAction: string, Specifies the most disruptive action that can be taken on the instance
22868 as part of the update. Compute Engine returns an error if the
22869 instance properties require a more disruptive action as part of the
22870 instance update. Valid options from lowest to highest are
22871 NO_EFFECT, REFRESH, and RESTART.
22872 Allowed values
22873 INVALID -
22874 NO_EFFECT - No changes can be made to the instance.
22875 REFRESH - The instance will not restart.
22876 RESTART - The instance will restart, potentially on a different host.
22877 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
22878 that if you must retry your request, the server will know to ignore the
22879 request if it has already been completed.
22880
22881 For example, consider a situation where you make an initial request and
22882 the request times out. If you make the request again with the same
22883 request ID, the server can check if original operation with the same
22884 request ID was received, and if so, will ignore the second request. This
22885 prevents clients from accidentally creating duplicate commitments.
22886
22887 The request ID must be
22888 a valid UUID with the exception that zero UUID is not supported
22889 (00000000-0000-0000-0000-000000000000).
22890 x__xgafv: string, V1 error format.
22891 Allowed values
22892 1 - v1 error format
22893 2 - v2 error format
22894
22895 Returns:
22896 An object of the form:
22897
22898 { # Represents an Operation resource.
22899 #
22900 # Google Compute Engine has three Operation resources:
22901 #
22902 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
22903 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
22904 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
22905 #
22906 # You can use an operation resource to manage asynchronous API requests.
22907 # For more information, readHandling
22908 # API responses.
22909 #
22910 # Operations can be global, regional or zonal.
22911 #
22912 # - For global operations, use the `globalOperations`
22913 # resource.
22914 # - For regional operations, use the
22915 # `regionOperations` resource.
22916 # - For zonal operations, use
22917 # the `zoneOperations` resource.
22918 #
22919 #
22920 #
22921 # For more information, read
22922 # Global, Regional, and Zonal Resources.
22923 #
22924 # Note that completed Operation resources have a limited
22925 # retention period.
22926 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
22927 # Not present otherwise.
22928 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
22929 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
22930 # set when the operation is created.
22931 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
22932 # text format.
22933 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
22934 # this field will be populated.
22935 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
22936 # operation.
22937 {
22938 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
22939 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
22940 # details. There is a set of defined message types to use for providing
22941 # details.The syntax depends on the error code. For example,
22942 # QuotaExceededInfo will have details when the error code is
22943 # QUOTA_EXCEEDED.
22944 {
22945 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
22946 #
22947 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
22948 # is not enabled:
22949 #
22950 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
22951 # &quot;domain&quot;: &quot;googleapis.com&quot;
22952 # &quot;metadata&quot;: {
22953 # &quot;resource&quot;: &quot;projects/123&quot;,
22954 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
22955 # }
22956 # }
22957 #
22958 # This response indicates that the pubsub.googleapis.com API is not enabled.
22959 #
22960 # Example of an error that is returned when attempting to create a Spanner
22961 # instance in a region that is out of stock:
22962 #
22963 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
22964 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
22965 # &quot;metadata&quot;: {
22966 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
22967 # }
22968 # }
22969 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
22970 # is typically the registered service name of the tool or product that
22971 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
22972 # generated by some common infrastructure, the error domain must be a
22973 # globally unique value that identifies the infrastructure. For Google API
22974 # infrastructure, the error domain is &quot;googleapis.com&quot;.
22975 &quot;metadatas&quot;: { # Additional structured details about this error.
22976 #
22977 # Keys must match a regular expression of `a-z+` but should
22978 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
22979 # length. When identifying the current value of an exceeded limit, the units
22980 # should be contained in the key, not the value. For example, rather than
22981 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
22982 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
22983 # instances that can be created in a single (batch) request.
22984 &quot;a_key&quot;: &quot;A String&quot;,
22985 },
22986 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
22987 # proximate cause of the error. Error reasons are unique within a particular
22988 # domain of errors. This should be at most 63 characters and match a
22989 # regular expression of `A-Z+[A-Z0-9]`, which represents
22990 # UPPER_SNAKE_CASE.
22991 },
22992 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
22993 #
22994 # For example, if a quota check failed with an error indicating the calling
22995 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
22996 # directly to the right place in the developer console to flip the bit.
22997 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
22998 { # Describes a URL link.
22999 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
23000 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
23001 },
23002 ],
23003 },
23004 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
23005 # which can be attached to an RPC error.
23006 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
23007 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
23008 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
23009 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
23010 },
23011 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
23012 &quot;dimensions&quot;: { # The map holding related quota dimensions.
23013 &quot;a_key&quot;: &quot;A String&quot;,
23014 },
23015 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
23016 # type or metric.
23017 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
23018 # or metric.
23019 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
23020 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
23021 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
23022 },
23023 },
23024 ],
23025 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
23026 # This property is optional.
23027 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
23028 },
23029 ],
23030 },
23031 &quot;getVersionOperationMetadata&quot;: {
23032 &quot;inlineSbomInfo&quot;: {
23033 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
23034 # appropriate identifiers.
23035 &quot;a_key&quot;: &quot;A String&quot;,
23036 },
23037 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
23038 # identifiers.
23039 &quot;a_key&quot;: &quot;A String&quot;,
23040 },
23041 },
23042 },
23043 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
23044 # message that was returned, such as `NOT FOUND`.
23045 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
23046 # status code that was returned. For example, a `404` means the
23047 # resource was not found.
23048 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
23049 # defined by the server.
23050 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
23051 # This value is inRFC3339
23052 # text format.
23053 &quot;instancesBulkInsertOperationMetadata&quot;: {
23054 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
23055 # Example key: zones/us-central1-a
23056 &quot;a_key&quot;: {
23057 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
23058 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
23059 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
23060 # error.
23061 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
23062 # if the flow is rolling forward or rolling back.
23063 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
23064 },
23065 },
23066 },
23067 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
23068 # Operation resources.
23069 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
23070 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
23071 # group of operations results from a `bulkInsert` API request.
23072 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
23073 # `update`, or `delete`, and so on.
23074 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
23075 # There is no requirement that this be linear or support any granularity of
23076 # operations. This should not be used to guess when the operation will be
23077 # complete. This number should monotonically increase as the operation
23078 # progresses.
23079 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
23080 # applicable when performing regional operations.
23081 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
23082 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
23083 # this field will contain information on all underlying zonal actions and
23084 # their state.
23085 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
23086 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
23087 # Example key: zones/us-central1-a
23088 &quot;a_key&quot;: {
23089 &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
23090 # populated.
23091 # different programming environments, including REST APIs and RPC APIs. It is
23092 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
23093 # three pieces of data: error code, error message, and error details.
23094 #
23095 # You can find out more about this error model and how to work with it in the
23096 # [API Design Guide](https://cloud.google.com/apis/design/errors).
23097 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
23098 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
23099 # message types for APIs to use.
23100 {
23101 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
23102 },
23103 ],
23104 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
23105 # user-facing error message should be localized and sent in the
23106 # google.rpc.Status.details field, or localized by the client.
23107 },
23108 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
23109 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
23110 },
23111 },
23112 },
23113 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
23114 # This value is inRFC3339
23115 # text format.
23116 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
23117 # following:
23118 # `PENDING`, `RUNNING`, or `DONE`.
23119 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
23120 # operation.
23121 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
23122 # of the target resource.
23123 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
23124 # operations related to creating a snapshot, this points to the disk
23125 # that the snapshot was created from.
23126 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
23127 # `[email protected]` or
23128 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
23129 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
23130 # operation, this field will be populated.
23131 {
23132 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
23133 # Engine returns NO_RESULTS_ON_PAGE if there
23134 # are no results in the response.
23135 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
23136 # value format. For example:
23137 #
23138 # &quot;data&quot;: [
23139 # {
23140 # &quot;key&quot;: &quot;scope&quot;,
23141 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
23142 # }
23143 {
23144 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
23145 # returned. For example, for warnings where there are no results in a list
23146 # request for a particular zone, this key might be scope and
23147 # the key value might be the zone name. Other examples might be a key
23148 # indicating a deprecated resource and a suggested replacement, or a
23149 # warning about invalid network settings (for example, if an instance
23150 # attempts to perform IP forwarding but is not enabled for IP forwarding).
23151 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
23152 },
23153 ],
23154 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
23155 },
23156 ],
23157 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
23158 # applicable when performing per-zone operations.
23159 }</pre>
23160 </div>
23161
23162 <div class="method">
23163 <code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>
23164 <pre>Updates the specified access config from an instance&#x27;s network interface
23165 with the data included in the request. This method supportsPATCH
23166 semantics and uses theJSON merge
23167 patch format and processing rules.
23168
23169 Args:
23170 project: string, Project ID for this request. (required)
23171 zone: string, The name of the zone for this request. (required)
23172 instance: string, The instance name for this request. (required)
23173 networkInterface: string, The name of the network interface where the access config is attached. (required)
23174 body: object, The request body.
23175 The object takes the form of:
23176
23177 { # An access configuration attached to an instance&#x27;s network interface.
23178 # Only one access config per instance is supported.
23179 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
23180 # The first IPv6 address of the external IPv6 range associated
23181 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
23182 # use a static external IP address, it must be unused and in the same region
23183 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
23184 # assign an external IPv6 address from the instance&#x27;s subnetwork.
23185 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
23186 # external IPv6 range.
23187 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
23188 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
23189 # (IPv4), the default and recommended name is External NAT, but
23190 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
23191 # recommend name is External IPv6.
23192 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
23193 # address associated with this instance. Specify an unused static
23194 # external IP address available to the project or leave this field undefined
23195 # to use an IP from a shared ephemeral IP address pool. If you specify a
23196 # static external IP address, it must live in the same region as the zone of
23197 # the instance.
23198 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
23199 # configuration and can only take the following values: PREMIUM,STANDARD.
23200 #
23201 # If an AccessConfig is specified without a valid external IP address, an
23202 # ephemeral IP will be created with this networkTier.
23203 #
23204 # If an AccessConfig with a valid external IP address is specified, it must
23205 # match that of the networkTier associated with the Address resource owning
23206 # that IP.
23207 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
23208 #
23209 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
23210 # first IP in associated external IPv6 range.
23211 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
23212 # config.
23213 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
23214 # external IP address of the instance to a DNS domain name.
23215 #
23216 # This field is not used in ipv6AccessConfig. A default PTR
23217 # record will be created if the VM has external IPv6 range associated.
23218 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
23219 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
23220 }
23221
23222 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
23223 that if you must retry your request, the server will know to ignore the
23224 request if it has already been completed.
23225
23226 For example, consider a situation where you make an initial request and
23227 the request times out. If you make the request again with the same
23228 request ID, the server can check if original operation with the same
23229 request ID was received, and if so, will ignore the second request. This
23230 prevents clients from accidentally creating duplicate commitments.
23231
23232 The request ID must be
23233 a valid UUID with the exception that zero UUID is not supported
23234 (00000000-0000-0000-0000-000000000000).
23235 x__xgafv: string, V1 error format.
23236 Allowed values
23237 1 - v1 error format
23238 2 - v2 error format
23239
23240 Returns:
23241 An object of the form:
23242
23243 { # Represents an Operation resource.
23244 #
23245 # Google Compute Engine has three Operation resources:
23246 #
23247 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
23248 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
23249 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
23250 #
23251 # You can use an operation resource to manage asynchronous API requests.
23252 # For more information, readHandling
23253 # API responses.
23254 #
23255 # Operations can be global, regional or zonal.
23256 #
23257 # - For global operations, use the `globalOperations`
23258 # resource.
23259 # - For regional operations, use the
23260 # `regionOperations` resource.
23261 # - For zonal operations, use
23262 # the `zoneOperations` resource.
23263 #
23264 #
23265 #
23266 # For more information, read
23267 # Global, Regional, and Zonal Resources.
23268 #
23269 # Note that completed Operation resources have a limited
23270 # retention period.
23271 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
23272 # Not present otherwise.
23273 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
23274 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
23275 # set when the operation is created.
23276 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
23277 # text format.
23278 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
23279 # this field will be populated.
23280 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
23281 # operation.
23282 {
23283 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
23284 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
23285 # details. There is a set of defined message types to use for providing
23286 # details.The syntax depends on the error code. For example,
23287 # QuotaExceededInfo will have details when the error code is
23288 # QUOTA_EXCEEDED.
23289 {
23290 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
23291 #
23292 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
23293 # is not enabled:
23294 #
23295 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
23296 # &quot;domain&quot;: &quot;googleapis.com&quot;
23297 # &quot;metadata&quot;: {
23298 # &quot;resource&quot;: &quot;projects/123&quot;,
23299 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
23300 # }
23301 # }
23302 #
23303 # This response indicates that the pubsub.googleapis.com API is not enabled.
23304 #
23305 # Example of an error that is returned when attempting to create a Spanner
23306 # instance in a region that is out of stock:
23307 #
23308 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
23309 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
23310 # &quot;metadata&quot;: {
23311 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
23312 # }
23313 # }
23314 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
23315 # is typically the registered service name of the tool or product that
23316 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
23317 # generated by some common infrastructure, the error domain must be a
23318 # globally unique value that identifies the infrastructure. For Google API
23319 # infrastructure, the error domain is &quot;googleapis.com&quot;.
23320 &quot;metadatas&quot;: { # Additional structured details about this error.
23321 #
23322 # Keys must match a regular expression of `a-z+` but should
23323 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
23324 # length. When identifying the current value of an exceeded limit, the units
23325 # should be contained in the key, not the value. For example, rather than
23326 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
23327 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
23328 # instances that can be created in a single (batch) request.
23329 &quot;a_key&quot;: &quot;A String&quot;,
23330 },
23331 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
23332 # proximate cause of the error. Error reasons are unique within a particular
23333 # domain of errors. This should be at most 63 characters and match a
23334 # regular expression of `A-Z+[A-Z0-9]`, which represents
23335 # UPPER_SNAKE_CASE.
23336 },
23337 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
23338 #
23339 # For example, if a quota check failed with an error indicating the calling
23340 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
23341 # directly to the right place in the developer console to flip the bit.
23342 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
23343 { # Describes a URL link.
23344 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
23345 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
23346 },
23347 ],
23348 },
23349 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
23350 # which can be attached to an RPC error.
23351 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
23352 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
23353 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
23354 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
23355 },
23356 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
23357 &quot;dimensions&quot;: { # The map holding related quota dimensions.
23358 &quot;a_key&quot;: &quot;A String&quot;,
23359 },
23360 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
23361 # type or metric.
23362 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
23363 # or metric.
23364 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
23365 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
23366 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
23367 },
23368 },
23369 ],
23370 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
23371 # This property is optional.
23372 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
23373 },
23374 ],
23375 },
23376 &quot;getVersionOperationMetadata&quot;: {
23377 &quot;inlineSbomInfo&quot;: {
23378 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
23379 # appropriate identifiers.
23380 &quot;a_key&quot;: &quot;A String&quot;,
23381 },
23382 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
23383 # identifiers.
23384 &quot;a_key&quot;: &quot;A String&quot;,
23385 },
23386 },
23387 },
23388 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
23389 # message that was returned, such as `NOT FOUND`.
23390 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
23391 # status code that was returned. For example, a `404` means the
23392 # resource was not found.
23393 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
23394 # defined by the server.
23395 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
23396 # This value is inRFC3339
23397 # text format.
23398 &quot;instancesBulkInsertOperationMetadata&quot;: {
23399 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
23400 # Example key: zones/us-central1-a
23401 &quot;a_key&quot;: {
23402 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
23403 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
23404 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
23405 # error.
23406 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
23407 # if the flow is rolling forward or rolling back.
23408 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
23409 },
23410 },
23411 },
23412 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
23413 # Operation resources.
23414 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
23415 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
23416 # group of operations results from a `bulkInsert` API request.
23417 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
23418 # `update`, or `delete`, and so on.
23419 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
23420 # There is no requirement that this be linear or support any granularity of
23421 # operations. This should not be used to guess when the operation will be
23422 # complete. This number should monotonically increase as the operation
23423 # progresses.
23424 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
23425 # applicable when performing regional operations.
23426 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
23427 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
23428 # this field will contain information on all underlying zonal actions and
23429 # their state.
23430 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
23431 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
23432 # Example key: zones/us-central1-a
23433 &quot;a_key&quot;: {
23434 &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
23435 # populated.
23436 # different programming environments, including REST APIs and RPC APIs. It is
23437 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
23438 # three pieces of data: error code, error message, and error details.
23439 #
23440 # You can find out more about this error model and how to work with it in the
23441 # [API Design Guide](https://cloud.google.com/apis/design/errors).
23442 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
23443 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
23444 # message types for APIs to use.
23445 {
23446 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
23447 },
23448 ],
23449 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
23450 # user-facing error message should be localized and sent in the
23451 # google.rpc.Status.details field, or localized by the client.
23452 },
23453 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
23454 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
23455 },
23456 },
23457 },
23458 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
23459 # This value is inRFC3339
23460 # text format.
23461 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
23462 # following:
23463 # `PENDING`, `RUNNING`, or `DONE`.
23464 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
23465 # operation.
23466 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
23467 # of the target resource.
23468 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
23469 # operations related to creating a snapshot, this points to the disk
23470 # that the snapshot was created from.
23471 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
23472 # `[email protected]` or
23473 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
23474 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
23475 # operation, this field will be populated.
23476 {
23477 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
23478 # Engine returns NO_RESULTS_ON_PAGE if there
23479 # are no results in the response.
23480 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
23481 # value format. For example:
23482 #
23483 # &quot;data&quot;: [
23484 # {
23485 # &quot;key&quot;: &quot;scope&quot;,
23486 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
23487 # }
23488 {
23489 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
23490 # returned. For example, for warnings where there are no results in a list
23491 # request for a particular zone, this key might be scope and
23492 # the key value might be the zone name. Other examples might be a key
23493 # indicating a deprecated resource and a suggested replacement, or a
23494 # warning about invalid network settings (for example, if an instance
23495 # attempts to perform IP forwarding but is not enabled for IP forwarding).
23496 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
23497 },
23498 ],
23499 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
23500 },
23501 ],
23502 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
23503 # applicable when performing per-zone operations.
23504 }</pre>
23505 </div>
23506
23507 <div class="method">
23508 <code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
23509 <pre>Updates the Display config for a VM instance. You can
23510 only use this method on a stopped VM instance. This method supportsPATCH
23511 semantics and uses theJSON merge
23512 patch format and processing rules.
23513
23514 Args:
23515 project: string, Project ID for this request. (required)
23516 zone: string, The name of the zone for this request. (required)
23517 instance: string, Name of the instance scoping this request. (required)
23518 body: object, The request body.
23519 The object takes the form of:
23520
23521 { # A set of Display Device options
23522 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
23523 }
23524
23525 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
23526 that if you must retry your request, the server will know to ignore the
23527 request if it has already been completed.
23528
23529 For example, consider a situation where you make an initial request and
23530 the request times out. If you make the request again with the same
23531 request ID, the server can check if original operation with the same
23532 request ID was received, and if so, will ignore the second request. This
23533 prevents clients from accidentally creating duplicate commitments.
23534
23535 The request ID must be
23536 a valid UUID with the exception that zero UUID is not supported
23537 (00000000-0000-0000-0000-000000000000).
23538 x__xgafv: string, V1 error format.
23539 Allowed values
23540 1 - v1 error format
23541 2 - v2 error format
23542
23543 Returns:
23544 An object of the form:
23545
23546 { # Represents an Operation resource.
23547 #
23548 # Google Compute Engine has three Operation resources:
23549 #
23550 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
23551 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
23552 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
23553 #
23554 # You can use an operation resource to manage asynchronous API requests.
23555 # For more information, readHandling
23556 # API responses.
23557 #
23558 # Operations can be global, regional or zonal.
23559 #
23560 # - For global operations, use the `globalOperations`
23561 # resource.
23562 # - For regional operations, use the
23563 # `regionOperations` resource.
23564 # - For zonal operations, use
23565 # the `zoneOperations` resource.
23566 #
23567 #
23568 #
23569 # For more information, read
23570 # Global, Regional, and Zonal Resources.
23571 #
23572 # Note that completed Operation resources have a limited
23573 # retention period.
23574 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
23575 # Not present otherwise.
23576 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
23577 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
23578 # set when the operation is created.
23579 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
23580 # text format.
23581 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
23582 # this field will be populated.
23583 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
23584 # operation.
23585 {
23586 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
23587 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
23588 # details. There is a set of defined message types to use for providing
23589 # details.The syntax depends on the error code. For example,
23590 # QuotaExceededInfo will have details when the error code is
23591 # QUOTA_EXCEEDED.
23592 {
23593 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
23594 #
23595 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
23596 # is not enabled:
23597 #
23598 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
23599 # &quot;domain&quot;: &quot;googleapis.com&quot;
23600 # &quot;metadata&quot;: {
23601 # &quot;resource&quot;: &quot;projects/123&quot;,
23602 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
23603 # }
23604 # }
23605 #
23606 # This response indicates that the pubsub.googleapis.com API is not enabled.
23607 #
23608 # Example of an error that is returned when attempting to create a Spanner
23609 # instance in a region that is out of stock:
23610 #
23611 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
23612 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
23613 # &quot;metadata&quot;: {
23614 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
23615 # }
23616 # }
23617 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
23618 # is typically the registered service name of the tool or product that
23619 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
23620 # generated by some common infrastructure, the error domain must be a
23621 # globally unique value that identifies the infrastructure. For Google API
23622 # infrastructure, the error domain is &quot;googleapis.com&quot;.
23623 &quot;metadatas&quot;: { # Additional structured details about this error.
23624 #
23625 # Keys must match a regular expression of `a-z+` but should
23626 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
23627 # length. When identifying the current value of an exceeded limit, the units
23628 # should be contained in the key, not the value. For example, rather than
23629 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
23630 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
23631 # instances that can be created in a single (batch) request.
23632 &quot;a_key&quot;: &quot;A String&quot;,
23633 },
23634 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
23635 # proximate cause of the error. Error reasons are unique within a particular
23636 # domain of errors. This should be at most 63 characters and match a
23637 # regular expression of `A-Z+[A-Z0-9]`, which represents
23638 # UPPER_SNAKE_CASE.
23639 },
23640 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
23641 #
23642 # For example, if a quota check failed with an error indicating the calling
23643 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
23644 # directly to the right place in the developer console to flip the bit.
23645 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
23646 { # Describes a URL link.
23647 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
23648 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
23649 },
23650 ],
23651 },
23652 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
23653 # which can be attached to an RPC error.
23654 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
23655 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
23656 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
23657 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
23658 },
23659 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
23660 &quot;dimensions&quot;: { # The map holding related quota dimensions.
23661 &quot;a_key&quot;: &quot;A String&quot;,
23662 },
23663 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
23664 # type or metric.
23665 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
23666 # or metric.
23667 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
23668 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
23669 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
23670 },
23671 },
23672 ],
23673 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
23674 # This property is optional.
23675 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
23676 },
23677 ],
23678 },
23679 &quot;getVersionOperationMetadata&quot;: {
23680 &quot;inlineSbomInfo&quot;: {
23681 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
23682 # appropriate identifiers.
23683 &quot;a_key&quot;: &quot;A String&quot;,
23684 },
23685 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
23686 # identifiers.
23687 &quot;a_key&quot;: &quot;A String&quot;,
23688 },
23689 },
23690 },
23691 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
23692 # message that was returned, such as `NOT FOUND`.
23693 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
23694 # status code that was returned. For example, a `404` means the
23695 # resource was not found.
23696 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
23697 # defined by the server.
23698 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
23699 # This value is inRFC3339
23700 # text format.
23701 &quot;instancesBulkInsertOperationMetadata&quot;: {
23702 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
23703 # Example key: zones/us-central1-a
23704 &quot;a_key&quot;: {
23705 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
23706 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
23707 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
23708 # error.
23709 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
23710 # if the flow is rolling forward or rolling back.
23711 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
23712 },
23713 },
23714 },
23715 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
23716 # Operation resources.
23717 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
23718 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
23719 # group of operations results from a `bulkInsert` API request.
23720 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
23721 # `update`, or `delete`, and so on.
23722 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
23723 # There is no requirement that this be linear or support any granularity of
23724 # operations. This should not be used to guess when the operation will be
23725 # complete. This number should monotonically increase as the operation
23726 # progresses.
23727 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
23728 # applicable when performing regional operations.
23729 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
23730 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
23731 # this field will contain information on all underlying zonal actions and
23732 # their state.
23733 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
23734 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
23735 # Example key: zones/us-central1-a
23736 &quot;a_key&quot;: {
23737 &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
23738 # populated.
23739 # different programming environments, including REST APIs and RPC APIs. It is
23740 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
23741 # three pieces of data: error code, error message, and error details.
23742 #
23743 # You can find out more about this error model and how to work with it in the
23744 # [API Design Guide](https://cloud.google.com/apis/design/errors).
23745 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
23746 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
23747 # message types for APIs to use.
23748 {
23749 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
23750 },
23751 ],
23752 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
23753 # user-facing error message should be localized and sent in the
23754 # google.rpc.Status.details field, or localized by the client.
23755 },
23756 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
23757 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
23758 },
23759 },
23760 },
23761 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
23762 # This value is inRFC3339
23763 # text format.
23764 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
23765 # following:
23766 # `PENDING`, `RUNNING`, or `DONE`.
23767 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
23768 # operation.
23769 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
23770 # of the target resource.
23771 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
23772 # operations related to creating a snapshot, this points to the disk
23773 # that the snapshot was created from.
23774 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
23775 # `[email protected]` or
23776 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
23777 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
23778 # operation, this field will be populated.
23779 {
23780 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
23781 # Engine returns NO_RESULTS_ON_PAGE if there
23782 # are no results in the response.
23783 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
23784 # value format. For example:
23785 #
23786 # &quot;data&quot;: [
23787 # {
23788 # &quot;key&quot;: &quot;scope&quot;,
23789 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
23790 # }
23791 {
23792 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
23793 # returned. For example, for warnings where there are no results in a list
23794 # request for a particular zone, this key might be scope and
23795 # the key value might be the zone name. Other examples might be a key
23796 # indicating a deprecated resource and a suggested replacement, or a
23797 # warning about invalid network settings (for example, if an instance
23798 # attempts to perform IP forwarding but is not enabled for IP forwarding).
23799 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
23800 },
23801 ],
23802 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
23803 },
23804 ],
23805 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
23806 # applicable when performing per-zone operations.
23807 }</pre>
23808 </div>
23809
23810 <div class="method">
23811 <code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>
23812 <pre>Updates an instance&#x27;s network interface. This method can only update an
23813 interface&#x27;s alias IP range and attached network. See Modifying
23814 alias IP ranges for an existing instance for instructions on
23815 changing alias IP ranges. See Migrating
23816 a VM between networks for instructions on migrating an interface.
23817 This method follows PATCH semantics.
23818
23819 Args:
23820 project: string, Project ID for this request. (required)
23821 zone: string, The name of the zone for this request. (required)
23822 instance: string, The instance name for this request. (required)
23823 networkInterface: string, The name of the network interface to update. (required)
23824 body: object, The request body.
23825 The object takes the form of:
23826
23827 { # A network interface resource attached to an instance.
23828 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
23829 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
23830 # no external internet access.
23831 { # An access configuration attached to an instance&#x27;s network interface.
23832 # Only one access config per instance is supported.
23833 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
23834 # The first IPv6 address of the external IPv6 range associated
23835 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
23836 # use a static external IP address, it must be unused and in the same region
23837 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
23838 # assign an external IPv6 address from the instance&#x27;s subnetwork.
23839 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
23840 # external IPv6 range.
23841 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
23842 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
23843 # (IPv4), the default and recommended name is External NAT, but
23844 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
23845 # recommend name is External IPv6.
23846 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
23847 # address associated with this instance. Specify an unused static
23848 # external IP address available to the project or leave this field undefined
23849 # to use an IP from a shared ephemeral IP address pool. If you specify a
23850 # static external IP address, it must live in the same region as the zone of
23851 # the instance.
23852 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
23853 # configuration and can only take the following values: PREMIUM,STANDARD.
23854 #
23855 # If an AccessConfig is specified without a valid external IP address, an
23856 # ephemeral IP will be created with this networkTier.
23857 #
23858 # If an AccessConfig with a valid external IP address is specified, it must
23859 # match that of the networkTier associated with the Address resource owning
23860 # that IP.
23861 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
23862 #
23863 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
23864 # first IP in associated external IPv6 range.
23865 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
23866 # config.
23867 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
23868 # external IP address of the instance to a DNS domain name.
23869 #
23870 # This field is not used in ipv6AccessConfig. A default PTR
23871 # record will be created if the VM has external IPv6 range associated.
23872 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
23873 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
23874 },
23875 ],
23876 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
23877 # You can only specify this field for network interfaces in VPC networks.
23878 { # An alias IP range attached to an instance&#x27;s network interface.
23879 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
23880 # must belong to the specified subnetwork and cannot contain IP addresses
23881 # reserved by system or used by other network interfaces. This range may be
23882 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
23883 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
23884 # alias range. If not specified, the primary range of the subnetwork is used.
23885 },
23886 ],
23887 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
23888 # You can only specify this field for network interfaces in VPC networks.
23889 { # An alias IP range attached to an instance&#x27;s network interface.
23890 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
23891 # must belong to the specified subnetwork and cannot contain IP addresses
23892 # reserved by system or used by other network interfaces. This range may be
23893 # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).
23894 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
23895 # alias range. If not specified, the primary range of the subnetwork is used.
23896 },
23897 ],
23898 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
23899 # with network_attachment.
23900 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
23901 # This field will be ignored when inserting an Instance or
23902 # adding a NetworkInterface. An up-to-date
23903 # fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
23904 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
23905 # or not. If enabled, also indicates the version of IGMP supported.
23906 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
23907 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
23908 # one IPv6 access config, DIRECT_IPV6, is supported. If there
23909 # is no ipv6AccessConfig specified, then this instance will
23910 # have no external IPv6 Internet access.
23911 { # An access configuration attached to an instance&#x27;s network interface.
23912 # Only one access config per instance is supported.
23913 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
23914 # The first IPv6 address of the external IPv6 range associated
23915 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
23916 # use a static external IP address, it must be unused and in the same region
23917 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
23918 # assign an external IPv6 address from the instance&#x27;s subnetwork.
23919 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
23920 # external IPv6 range.
23921 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
23922 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
23923 # (IPv4), the default and recommended name is External NAT, but
23924 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
23925 # recommend name is External IPv6.
23926 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
23927 # address associated with this instance. Specify an unused static
23928 # external IP address available to the project or leave this field undefined
23929 # to use an IP from a shared ephemeral IP address pool. If you specify a
23930 # static external IP address, it must live in the same region as the zone of
23931 # the instance.
23932 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
23933 # configuration and can only take the following values: PREMIUM,STANDARD.
23934 #
23935 # If an AccessConfig is specified without a valid external IP address, an
23936 # ephemeral IP will be created with this networkTier.
23937 #
23938 # If an AccessConfig with a valid external IP address is specified, it must
23939 # match that of the networkTier associated with the Address resource owning
23940 # that IP.
23941 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
23942 #
23943 # You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
23944 # first IP in associated external IPv6 range.
23945 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
23946 # config.
23947 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
23948 # external IP address of the instance to a DNS domain name.
23949 #
23950 # This field is not used in ipv6AccessConfig. A default PTR
23951 # record will be created if the VM has external IPv6 range associated.
23952 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
23953 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
23954 },
23955 ],
23956 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
23957 # accessed from the Internet. This field is always inherited from its
23958 # subnetwork.
23959 #
23960 # Valid only if stackType is IPV4_IPV6.
23961 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
23962 # use a static internal IP address, it must be unused and in the same region
23963 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
23964 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
23965 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
23966 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
23967 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
23968 # server. For a VM, the network interface uses the nicN naming
23969 # format. Where N is a value between 0 and7. The default interface value is nic0.
23970 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
23971 # instance, if neither the network nor the subnetwork is specified, the
23972 # default network global/networks/default is used. If the
23973 # selected project doesn&#x27;t have the default network, you must specify a
23974 # network or subnet. If the network is not specified but the subnetwork is
23975 # specified, the network is inferred.
23976 #
23977 # If you specify this property, you can specify the network as
23978 # a full or partial URL. For example, the following are all valid URLs:
23979 #
23980 #
23981 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
23982 # - projects/project/global/networks/network
23983 # - global/networks/default
23984 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
23985 # to in the following format:
23986 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
23987 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
23988 # interface. If not specified by the user, an unused internal IP is
23989 # assigned by the system.
23990 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
23991 # VirtioNet.
23992 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
23993 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
23994 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
23995 # if not specified by the users.
23996 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
23997 # interface. Can only be used with network_attachment. It is not possible to
23998 # use on its own however, network_attachment can be used without
23999 # service_class_id.
24000 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
24001 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
24002 #
24003 # This field can be both set at instance creation and update network
24004 # interface operations.
24005 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
24006 # resource is inlegacy
24007 # mode, do not specify this field. If the network is in auto subnet
24008 # mode, specifying the subnetwork is optional. If the network is in custom
24009 # subnet mode, specifying the subnetwork is required. If you specify this
24010 # field, you can specify the subnetwork as a full or partial URL. For
24011 # example, the following are all valid URLs:
24012 #
24013 #
24014 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
24015 # - regions/region/subnetworks/subnetwork
24016 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
24017 # from 2 to 255 inclusively.
24018 }
24019
24020 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
24021 that if you must retry your request, the server will know to ignore the
24022 request if it has already been completed.
24023
24024 For example, consider a situation where you make an initial request and
24025 the request times out. If you make the request again with the same
24026 request ID, the server can check if original operation with the same
24027 request ID was received, and if so, will ignore the second request. This
24028 prevents clients from accidentally creating duplicate commitments.
24029
24030 The request ID must be
24031 a valid UUID with the exception that zero UUID is not supported
24032 (00000000-0000-0000-0000-000000000000).
24033 x__xgafv: string, V1 error format.
24034 Allowed values
24035 1 - v1 error format
24036 2 - v2 error format
24037
24038 Returns:
24039 An object of the form:
24040
24041 { # Represents an Operation resource.
24042 #
24043 # Google Compute Engine has three Operation resources:
24044 #
24045 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
24046 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
24047 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
24048 #
24049 # You can use an operation resource to manage asynchronous API requests.
24050 # For more information, readHandling
24051 # API responses.
24052 #
24053 # Operations can be global, regional or zonal.
24054 #
24055 # - For global operations, use the `globalOperations`
24056 # resource.
24057 # - For regional operations, use the
24058 # `regionOperations` resource.
24059 # - For zonal operations, use
24060 # the `zoneOperations` resource.
24061 #
24062 #
24063 #
24064 # For more information, read
24065 # Global, Regional, and Zonal Resources.
24066 #
24067 # Note that completed Operation resources have a limited
24068 # retention period.
24069 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
24070 # Not present otherwise.
24071 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
24072 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
24073 # set when the operation is created.
24074 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
24075 # text format.
24076 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
24077 # this field will be populated.
24078 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
24079 # operation.
24080 {
24081 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
24082 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
24083 # details. There is a set of defined message types to use for providing
24084 # details.The syntax depends on the error code. For example,
24085 # QuotaExceededInfo will have details when the error code is
24086 # QUOTA_EXCEEDED.
24087 {
24088 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
24089 #
24090 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
24091 # is not enabled:
24092 #
24093 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
24094 # &quot;domain&quot;: &quot;googleapis.com&quot;
24095 # &quot;metadata&quot;: {
24096 # &quot;resource&quot;: &quot;projects/123&quot;,
24097 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
24098 # }
24099 # }
24100 #
24101 # This response indicates that the pubsub.googleapis.com API is not enabled.
24102 #
24103 # Example of an error that is returned when attempting to create a Spanner
24104 # instance in a region that is out of stock:
24105 #
24106 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
24107 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
24108 # &quot;metadata&quot;: {
24109 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
24110 # }
24111 # }
24112 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
24113 # is typically the registered service name of the tool or product that
24114 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
24115 # generated by some common infrastructure, the error domain must be a
24116 # globally unique value that identifies the infrastructure. For Google API
24117 # infrastructure, the error domain is &quot;googleapis.com&quot;.
24118 &quot;metadatas&quot;: { # Additional structured details about this error.
24119 #
24120 # Keys must match a regular expression of `a-z+` but should
24121 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
24122 # length. When identifying the current value of an exceeded limit, the units
24123 # should be contained in the key, not the value. For example, rather than
24124 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
24125 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
24126 # instances that can be created in a single (batch) request.
24127 &quot;a_key&quot;: &quot;A String&quot;,
24128 },
24129 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
24130 # proximate cause of the error. Error reasons are unique within a particular
24131 # domain of errors. This should be at most 63 characters and match a
24132 # regular expression of `A-Z+[A-Z0-9]`, which represents
24133 # UPPER_SNAKE_CASE.
24134 },
24135 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
24136 #
24137 # For example, if a quota check failed with an error indicating the calling
24138 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
24139 # directly to the right place in the developer console to flip the bit.
24140 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
24141 { # Describes a URL link.
24142 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
24143 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
24144 },
24145 ],
24146 },
24147 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
24148 # which can be attached to an RPC error.
24149 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
24150 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
24151 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
24152 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
24153 },
24154 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
24155 &quot;dimensions&quot;: { # The map holding related quota dimensions.
24156 &quot;a_key&quot;: &quot;A String&quot;,
24157 },
24158 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
24159 # type or metric.
24160 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
24161 # or metric.
24162 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
24163 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
24164 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
24165 },
24166 },
24167 ],
24168 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
24169 # This property is optional.
24170 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
24171 },
24172 ],
24173 },
24174 &quot;getVersionOperationMetadata&quot;: {
24175 &quot;inlineSbomInfo&quot;: {
24176 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
24177 # appropriate identifiers.
24178 &quot;a_key&quot;: &quot;A String&quot;,
24179 },
24180 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
24181 # identifiers.
24182 &quot;a_key&quot;: &quot;A String&quot;,
24183 },
24184 },
24185 },
24186 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
24187 # message that was returned, such as `NOT FOUND`.
24188 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
24189 # status code that was returned. For example, a `404` means the
24190 # resource was not found.
24191 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
24192 # defined by the server.
24193 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
24194 # This value is inRFC3339
24195 # text format.
24196 &quot;instancesBulkInsertOperationMetadata&quot;: {
24197 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
24198 # Example key: zones/us-central1-a
24199 &quot;a_key&quot;: {
24200 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
24201 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
24202 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
24203 # error.
24204 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
24205 # if the flow is rolling forward or rolling back.
24206 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
24207 },
24208 },
24209 },
24210 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
24211 # Operation resources.
24212 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
24213 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
24214 # group of operations results from a `bulkInsert` API request.
24215 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
24216 # `update`, or `delete`, and so on.
24217 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
24218 # There is no requirement that this be linear or support any granularity of
24219 # operations. This should not be used to guess when the operation will be
24220 # complete. This number should monotonically increase as the operation
24221 # progresses.
24222 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
24223 # applicable when performing regional operations.
24224 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
24225 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
24226 # this field will contain information on all underlying zonal actions and
24227 # their state.
24228 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
24229 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
24230 # Example key: zones/us-central1-a
24231 &quot;a_key&quot;: {
24232 &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
24233 # populated.
24234 # different programming environments, including REST APIs and RPC APIs. It is
24235 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
24236 # three pieces of data: error code, error message, and error details.
24237 #
24238 # You can find out more about this error model and how to work with it in the
24239 # [API Design Guide](https://cloud.google.com/apis/design/errors).
24240 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
24241 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
24242 # message types for APIs to use.
24243 {
24244 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
24245 },
24246 ],
24247 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
24248 # user-facing error message should be localized and sent in the
24249 # google.rpc.Status.details field, or localized by the client.
24250 },
24251 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
24252 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
24253 },
24254 },
24255 },
24256 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
24257 # This value is inRFC3339
24258 # text format.
24259 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
24260 # following:
24261 # `PENDING`, `RUNNING`, or `DONE`.
24262 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
24263 # operation.
24264 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
24265 # of the target resource.
24266 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
24267 # operations related to creating a snapshot, this points to the disk
24268 # that the snapshot was created from.
24269 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
24270 # `[email protected]` or
24271 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
24272 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
24273 # operation, this field will be populated.
24274 {
24275 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
24276 # Engine returns NO_RESULTS_ON_PAGE if there
24277 # are no results in the response.
24278 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
24279 # value format. For example:
24280 #
24281 # &quot;data&quot;: [
24282 # {
24283 # &quot;key&quot;: &quot;scope&quot;,
24284 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
24285 # }
24286 {
24287 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
24288 # returned. For example, for warnings where there are no results in a list
24289 # request for a particular zone, this key might be scope and
24290 # the key value might be the zone name. Other examples might be a key
24291 # indicating a deprecated resource and a suggested replacement, or a
24292 # warning about invalid network settings (for example, if an instance
24293 # attempts to perform IP forwarding but is not enabled for IP forwarding).
24294 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
24295 },
24296 ],
24297 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
24298 },
24299 ],
24300 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
24301 # applicable when performing per-zone operations.
24302 }</pre>
24303 </div>
24304
24305 <div class="method">
24306 <code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
24307 <pre>Updates the Shielded Instance config for an instance. You can
24308 only use this method on a stopped instance. This method supportsPATCH
24309 semantics and uses theJSON merge
24310 patch format and processing rules.
24311
24312 Args:
24313 project: string, Project ID for this request. (required)
24314 zone: string, The name of the zone for this request. (required)
24315 instance: string, Name or id of the instance scoping this request. (required)
24316 body: object, The request body.
24317 The object takes the form of:
24318
24319 { # A set of Shielded Instance options.
24320 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
24321 # default.
24322 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
24323 # default.
24324 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
24325 # default.
24326 }
24327
24328 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
24329 that if you must retry your request, the server will know to ignore the
24330 request if it has already been completed.
24331
24332 For example, consider a situation where you make an initial request and
24333 the request times out. If you make the request again with the same
24334 request ID, the server can check if original operation with the same
24335 request ID was received, and if so, will ignore the second request. This
24336 prevents clients from accidentally creating duplicate commitments.
24337
24338 The request ID must be
24339 a valid UUID with the exception that zero UUID is not supported
24340 (00000000-0000-0000-0000-000000000000).
24341 x__xgafv: string, V1 error format.
24342 Allowed values
24343 1 - v1 error format
24344 2 - v2 error format
24345
24346 Returns:
24347 An object of the form:
24348
24349 { # Represents an Operation resource.
24350 #
24351 # Google Compute Engine has three Operation resources:
24352 #
24353 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
24354 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
24355 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
24356 #
24357 # You can use an operation resource to manage asynchronous API requests.
24358 # For more information, readHandling
24359 # API responses.
24360 #
24361 # Operations can be global, regional or zonal.
24362 #
24363 # - For global operations, use the `globalOperations`
24364 # resource.
24365 # - For regional operations, use the
24366 # `regionOperations` resource.
24367 # - For zonal operations, use
24368 # the `zoneOperations` resource.
24369 #
24370 #
24371 #
24372 # For more information, read
24373 # Global, Regional, and Zonal Resources.
24374 #
24375 # Note that completed Operation resources have a limited
24376 # retention period.
24377 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
24378 # Not present otherwise.
24379 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
24380 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
24381 # set when the operation is created.
24382 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
24383 # text format.
24384 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
24385 # this field will be populated.
24386 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
24387 # operation.
24388 {
24389 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
24390 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
24391 # details. There is a set of defined message types to use for providing
24392 # details.The syntax depends on the error code. For example,
24393 # QuotaExceededInfo will have details when the error code is
24394 # QUOTA_EXCEEDED.
24395 {
24396 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
24397 #
24398 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
24399 # is not enabled:
24400 #
24401 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
24402 # &quot;domain&quot;: &quot;googleapis.com&quot;
24403 # &quot;metadata&quot;: {
24404 # &quot;resource&quot;: &quot;projects/123&quot;,
24405 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
24406 # }
24407 # }
24408 #
24409 # This response indicates that the pubsub.googleapis.com API is not enabled.
24410 #
24411 # Example of an error that is returned when attempting to create a Spanner
24412 # instance in a region that is out of stock:
24413 #
24414 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
24415 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
24416 # &quot;metadata&quot;: {
24417 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
24418 # }
24419 # }
24420 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
24421 # is typically the registered service name of the tool or product that
24422 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
24423 # generated by some common infrastructure, the error domain must be a
24424 # globally unique value that identifies the infrastructure. For Google API
24425 # infrastructure, the error domain is &quot;googleapis.com&quot;.
24426 &quot;metadatas&quot;: { # Additional structured details about this error.
24427 #
24428 # Keys must match a regular expression of `a-z+` but should
24429 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
24430 # length. When identifying the current value of an exceeded limit, the units
24431 # should be contained in the key, not the value. For example, rather than
24432 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
24433 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
24434 # instances that can be created in a single (batch) request.
24435 &quot;a_key&quot;: &quot;A String&quot;,
24436 },
24437 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
24438 # proximate cause of the error. Error reasons are unique within a particular
24439 # domain of errors. This should be at most 63 characters and match a
24440 # regular expression of `A-Z+[A-Z0-9]`, which represents
24441 # UPPER_SNAKE_CASE.
24442 },
24443 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
24444 #
24445 # For example, if a quota check failed with an error indicating the calling
24446 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
24447 # directly to the right place in the developer console to flip the bit.
24448 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
24449 { # Describes a URL link.
24450 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
24451 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
24452 },
24453 ],
24454 },
24455 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
24456 # which can be attached to an RPC error.
24457 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
24458 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
24459 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
24460 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
24461 },
24462 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
24463 &quot;dimensions&quot;: { # The map holding related quota dimensions.
24464 &quot;a_key&quot;: &quot;A String&quot;,
24465 },
24466 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
24467 # type or metric.
24468 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
24469 # or metric.
24470 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
24471 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
24472 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
24473 },
24474 },
24475 ],
24476 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
24477 # This property is optional.
24478 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
24479 },
24480 ],
24481 },
24482 &quot;getVersionOperationMetadata&quot;: {
24483 &quot;inlineSbomInfo&quot;: {
24484 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
24485 # appropriate identifiers.
24486 &quot;a_key&quot;: &quot;A String&quot;,
24487 },
24488 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
24489 # identifiers.
24490 &quot;a_key&quot;: &quot;A String&quot;,
24491 },
24492 },
24493 },
24494 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
24495 # message that was returned, such as `NOT FOUND`.
24496 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
24497 # status code that was returned. For example, a `404` means the
24498 # resource was not found.
24499 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
24500 # defined by the server.
24501 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
24502 # This value is inRFC3339
24503 # text format.
24504 &quot;instancesBulkInsertOperationMetadata&quot;: {
24505 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
24506 # Example key: zones/us-central1-a
24507 &quot;a_key&quot;: {
24508 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
24509 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
24510 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
24511 # error.
24512 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
24513 # if the flow is rolling forward or rolling back.
24514 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
24515 },
24516 },
24517 },
24518 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
24519 # Operation resources.
24520 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
24521 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
24522 # group of operations results from a `bulkInsert` API request.
24523 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
24524 # `update`, or `delete`, and so on.
24525 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
24526 # There is no requirement that this be linear or support any granularity of
24527 # operations. This should not be used to guess when the operation will be
24528 # complete. This number should monotonically increase as the operation
24529 # progresses.
24530 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
24531 # applicable when performing regional operations.
24532 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
24533 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
24534 # this field will contain information on all underlying zonal actions and
24535 # their state.
24536 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
24537 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
24538 # Example key: zones/us-central1-a
24539 &quot;a_key&quot;: {
24540 &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
24541 # populated.
24542 # different programming environments, including REST APIs and RPC APIs. It is
24543 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
24544 # three pieces of data: error code, error message, and error details.
24545 #
24546 # You can find out more about this error model and how to work with it in the
24547 # [API Design Guide](https://cloud.google.com/apis/design/errors).
24548 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
24549 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
24550 # message types for APIs to use.
24551 {
24552 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
24553 },
24554 ],
24555 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
24556 # user-facing error message should be localized and sent in the
24557 # google.rpc.Status.details field, or localized by the client.
24558 },
24559 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
24560 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
24561 },
24562 },
24563 },
24564 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
24565 # This value is inRFC3339
24566 # text format.
24567 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
24568 # following:
24569 # `PENDING`, `RUNNING`, or `DONE`.
24570 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
24571 # operation.
24572 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
24573 # of the target resource.
24574 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
24575 # operations related to creating a snapshot, this points to the disk
24576 # that the snapshot was created from.
24577 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
24578 # `[email protected]` or
24579 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
24580 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
24581 # operation, this field will be populated.
24582 {
24583 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
24584 # Engine returns NO_RESULTS_ON_PAGE if there
24585 # are no results in the response.
24586 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
24587 # value format. For example:
24588 #
24589 # &quot;data&quot;: [
24590 # {
24591 # &quot;key&quot;: &quot;scope&quot;,
24592 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
24593 # }
24594 {
24595 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
24596 # returned. For example, for warnings where there are no results in a list
24597 # request for a particular zone, this key might be scope and
24598 # the key value might be the zone name. Other examples might be a key
24599 # indicating a deprecated resource and a suggested replacement, or a
24600 # warning about invalid network settings (for example, if an instance
24601 # attempts to perform IP forwarding but is not enabled for IP forwarding).
24602 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
24603 },
24604 ],
24605 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
24606 },
24607 ],
24608 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
24609 # applicable when performing per-zone operations.
24610 }</pre>
24611 </div>
24612
24613 <div class="method">
24614 <code class="details" id="updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
24615 <pre>Updates the Shielded VM config for a VM instance. You can
24616 only use this method on a stopped VM instance. This method supportsPATCH
24617 semantics and uses theJSON merge
24618 patch format and processing rules.
24619
24620 Args:
24621 project: string, Project ID for this request. (required)
24622 zone: string, The name of the zone for this request. (required)
24623 instance: string, Name of the instance scoping this request. (required)
24624 body: object, The request body.
24625 The object takes the form of:
24626
24627 { # A set of Shielded VM options.
24628 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
24629 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
24630 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
24631 }
24632
24633 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
24634 that if you must retry your request, the server will know to ignore the
24635 request if it has already been completed.
24636
24637 For example, consider a situation where you make an initial request and
24638 the request times out. If you make the request again with the same
24639 request ID, the server can check if original operation with the same
24640 request ID was received, and if so, will ignore the second request. This
24641 prevents clients from accidentally creating duplicate commitments.
24642
24643 The request ID must be
24644 a valid UUID with the exception that zero UUID is not supported
24645 (00000000-0000-0000-0000-000000000000).
24646 x__xgafv: string, V1 error format.
24647 Allowed values
24648 1 - v1 error format
24649 2 - v2 error format
24650
24651 Returns:
24652 An object of the form:
24653
24654 { # Represents an Operation resource.
24655 #
24656 # Google Compute Engine has three Operation resources:
24657 #
24658 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
24659 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
24660 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
24661 #
24662 # You can use an operation resource to manage asynchronous API requests.
24663 # For more information, readHandling
24664 # API responses.
24665 #
24666 # Operations can be global, regional or zonal.
24667 #
24668 # - For global operations, use the `globalOperations`
24669 # resource.
24670 # - For regional operations, use the
24671 # `regionOperations` resource.
24672 # - For zonal operations, use
24673 # the `zoneOperations` resource.
24674 #
24675 #
24676 #
24677 # For more information, read
24678 # Global, Regional, and Zonal Resources.
24679 #
24680 # Note that completed Operation resources have a limited
24681 # retention period.
24682 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
24683 # Not present otherwise.
24684 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
24685 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
24686 # set when the operation is created.
24687 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
24688 # text format.
24689 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
24690 # this field will be populated.
24691 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
24692 # operation.
24693 {
24694 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
24695 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
24696 # details. There is a set of defined message types to use for providing
24697 # details.The syntax depends on the error code. For example,
24698 # QuotaExceededInfo will have details when the error code is
24699 # QUOTA_EXCEEDED.
24700 {
24701 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
24702 #
24703 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
24704 # is not enabled:
24705 #
24706 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
24707 # &quot;domain&quot;: &quot;googleapis.com&quot;
24708 # &quot;metadata&quot;: {
24709 # &quot;resource&quot;: &quot;projects/123&quot;,
24710 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
24711 # }
24712 # }
24713 #
24714 # This response indicates that the pubsub.googleapis.com API is not enabled.
24715 #
24716 # Example of an error that is returned when attempting to create a Spanner
24717 # instance in a region that is out of stock:
24718 #
24719 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
24720 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
24721 # &quot;metadata&quot;: {
24722 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
24723 # }
24724 # }
24725 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
24726 # is typically the registered service name of the tool or product that
24727 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
24728 # generated by some common infrastructure, the error domain must be a
24729 # globally unique value that identifies the infrastructure. For Google API
24730 # infrastructure, the error domain is &quot;googleapis.com&quot;.
24731 &quot;metadatas&quot;: { # Additional structured details about this error.
24732 #
24733 # Keys must match a regular expression of `a-z+` but should
24734 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
24735 # length. When identifying the current value of an exceeded limit, the units
24736 # should be contained in the key, not the value. For example, rather than
24737 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
24738 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
24739 # instances that can be created in a single (batch) request.
24740 &quot;a_key&quot;: &quot;A String&quot;,
24741 },
24742 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
24743 # proximate cause of the error. Error reasons are unique within a particular
24744 # domain of errors. This should be at most 63 characters and match a
24745 # regular expression of `A-Z+[A-Z0-9]`, which represents
24746 # UPPER_SNAKE_CASE.
24747 },
24748 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
24749 #
24750 # For example, if a quota check failed with an error indicating the calling
24751 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
24752 # directly to the right place in the developer console to flip the bit.
24753 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
24754 { # Describes a URL link.
24755 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
24756 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
24757 },
24758 ],
24759 },
24760 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
24761 # which can be attached to an RPC error.
24762 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
24763 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
24764 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
24765 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
24766 },
24767 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
24768 &quot;dimensions&quot;: { # The map holding related quota dimensions.
24769 &quot;a_key&quot;: &quot;A String&quot;,
24770 },
24771 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
24772 # type or metric.
24773 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
24774 # or metric.
24775 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
24776 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
24777 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
24778 },
24779 },
24780 ],
24781 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
24782 # This property is optional.
24783 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
24784 },
24785 ],
24786 },
24787 &quot;getVersionOperationMetadata&quot;: {
24788 &quot;inlineSbomInfo&quot;: {
24789 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
24790 # appropriate identifiers.
24791 &quot;a_key&quot;: &quot;A String&quot;,
24792 },
24793 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
24794 # identifiers.
24795 &quot;a_key&quot;: &quot;A String&quot;,
24796 },
24797 },
24798 },
24799 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
24800 # message that was returned, such as `NOT FOUND`.
24801 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
24802 # status code that was returned. For example, a `404` means the
24803 # resource was not found.
24804 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
24805 # defined by the server.
24806 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
24807 # This value is inRFC3339
24808 # text format.
24809 &quot;instancesBulkInsertOperationMetadata&quot;: {
24810 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
24811 # Example key: zones/us-central1-a
24812 &quot;a_key&quot;: {
24813 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
24814 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
24815 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
24816 # error.
24817 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
24818 # if the flow is rolling forward or rolling back.
24819 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
24820 },
24821 },
24822 },
24823 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
24824 # Operation resources.
24825 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
24826 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
24827 # group of operations results from a `bulkInsert` API request.
24828 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
24829 # `update`, or `delete`, and so on.
24830 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
24831 # There is no requirement that this be linear or support any granularity of
24832 # operations. This should not be used to guess when the operation will be
24833 # complete. This number should monotonically increase as the operation
24834 # progresses.
24835 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
24836 # applicable when performing regional operations.
24837 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
24838 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
24839 # this field will contain information on all underlying zonal actions and
24840 # their state.
24841 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
24842 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
24843 # Example key: zones/us-central1-a
24844 &quot;a_key&quot;: {
24845 &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
24846 # populated.
24847 # different programming environments, including REST APIs and RPC APIs. It is
24848 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
24849 # three pieces of data: error code, error message, and error details.
24850 #
24851 # You can find out more about this error model and how to work with it in the
24852 # [API Design Guide](https://cloud.google.com/apis/design/errors).
24853 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
24854 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
24855 # message types for APIs to use.
24856 {
24857 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
24858 },
24859 ],
24860 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
24861 # user-facing error message should be localized and sent in the
24862 # google.rpc.Status.details field, or localized by the client.
24863 },
24864 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
24865 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
24866 },
24867 },
24868 },
24869 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
24870 # This value is inRFC3339
24871 # text format.
24872 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
24873 # following:
24874 # `PENDING`, `RUNNING`, or `DONE`.
24875 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
24876 # operation.
24877 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
24878 # of the target resource.
24879 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
24880 # operations related to creating a snapshot, this points to the disk
24881 # that the snapshot was created from.
24882 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
24883 # `[email protected]` or
24884 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
24885 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
24886 # operation, this field will be populated.
24887 {
24888 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
24889 # Engine returns NO_RESULTS_ON_PAGE if there
24890 # are no results in the response.
24891 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
24892 # value format. For example:
24893 #
24894 # &quot;data&quot;: [
24895 # {
24896 # &quot;key&quot;: &quot;scope&quot;,
24897 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
24898 # }
24899 {
24900 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
24901 # returned. For example, for warnings where there are no results in a list
24902 # request for a particular zone, this key might be scope and
24903 # the key value might be the zone name. Other examples might be a key
24904 # indicating a deprecated resource and a suggested replacement, or a
24905 # warning about invalid network settings (for example, if an instance
24906 # attempts to perform IP forwarding but is not enabled for IP forwarding).
24907 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
24908 },
24909 ],
24910 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
24911 },
24912 ],
24913 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
24914 # applicable when performing per-zone operations.
24915 }</pre>
24916 </div>
24917
24918 </body></html>