Debian Codegraph @

docs/dyn/compute_alpha.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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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="#getVmExtensionState">getVmExtensionState(project, zone, instance, extensionName, x__xgafv=None)</a></code></p>
142 <p class="firstline">Retrieves details of a specific VM extension state.</p>
143 <p class="toc_element">
144 <code><a href="#insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Creates an instance resource in the specified project using the data</p>
146 <p class="toc_element">
147 <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>
148 <p class="firstline">Retrieves the list of instances contained within</p>
149 <p class="toc_element">
150 <code><a href="#listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
151 <p class="firstline">Retrieves a list of resources that refer to the VM instance specified in</p>
152 <p class="toc_element">
153 <code><a href="#listReferrers_next">listReferrers_next()</a></code></p>
154 <p class="firstline">Retrieves the next page of results.</p>
155 <p class="toc_element">
156 <code><a href="#listVmExtensionStates">listVmExtensionStates(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
157 <p class="firstline">Lists all VM extensions states for a specific instance.</p>
158 <p class="toc_element">
159 <code><a href="#listVmExtensionStates_next">listVmExtensionStates_next()</a></code></p>
160 <p class="firstline">Retrieves the next page of results.</p>
161 <p class="toc_element">
162 <code><a href="#list_next">list_next()</a></code></p>
163 <p class="firstline">Retrieves the next page of results.</p>
164 <p class="toc_element">
165 <code><a href="#patchPartnerMetadata">patchPartnerMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
166 <p class="firstline">Patches partner metadata of the specified instance.</p>
167 <p class="toc_element">
168 <code><a href="#performMaintenance">performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
169 <p class="firstline">Perform a manual maintenance on the instance.</p>
170 <p class="toc_element">
171 <code><a href="#removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
172 <p class="firstline">Removes resource policies from an instance.</p>
173 <p class="toc_element">
174 <code><a href="#reportHostAsFaulty">reportHostAsFaulty(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
175 <p class="firstline">Mark the host as faulty and try to restart the instance on a new host.</p>
176 <p class="toc_element">
177 <code><a href="#reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
178 <p class="firstline">Performs a reset on the instance. This is a hard reset. The VM</p>
179 <p class="toc_element">
180 <code><a href="#resume">resume(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
181 <p class="firstline">Resumes an instance that was suspended using theinstances().suspend</p>
182 <p class="toc_element">
183 <code><a href="#sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</a></code></p>
184 <p class="firstline">Sends diagnostic interrupt to the instance.</p>
185 <p class="toc_element">
186 <code><a href="#setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</a></code></p>
187 <p class="firstline">Sets deletion protection on the instance.</p>
188 <p class="toc_element">
189 <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</a></code></p>
190 <p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
191 <p class="toc_element">
192 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
193 <p class="firstline">Sets the access control policy on the specified resource.</p>
194 <p class="toc_element">
195 <code><a href="#setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
196 <p class="firstline">Sets labels on an instance. To learn more about labels, read theLabeling</p>
197 <p class="toc_element">
198 <code><a href="#setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
199 <p class="firstline">Changes the number and/or type of accelerator for a stopped instance to the</p>
200 <p class="toc_element">
201 <code><a href="#setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
202 <p class="firstline">Changes the machine type for a stopped instance to the machine</p>
203 <p class="toc_element">
204 <code><a href="#setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
205 <p class="firstline">Sets metadata for the specified instance to the data included</p>
206 <p class="toc_element">
207 <code><a href="#setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
208 <p class="firstline">Changes the minimum CPU platform that this instance should use.</p>
209 <p class="toc_element">
210 <code><a href="#setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
211 <p class="firstline">Sets name of an instance.</p>
212 <p class="toc_element">
213 <code><a href="#setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
214 <p class="firstline">Sets an instance's scheduling options. You can only call this method on astopped instance,</p>
215 <p class="toc_element">
216 <code><a href="#setSecurityPolicy">setSecurityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
217 <p class="firstline">Sets the Google Cloud Armor security policy for the specified instance.</p>
218 <p class="toc_element">
219 <code><a href="#setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
220 <p class="firstline">Sets the service account on the instance. For more information,</p>
221 <p class="toc_element">
222 <code><a href="#setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
223 <p class="firstline">Sets the Shielded Instance integrity policy for an instance. You can</p>
224 <p class="toc_element">
225 <code><a href="#setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
226 <p class="firstline">Sets the Shielded VM integrity policy for a VM instance. You can</p>
227 <p class="toc_element">
228 <code><a href="#setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
229 <p class="firstline">Sets network tags</p>
230 <p class="toc_element">
231 <code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, requestId=None, withExtendedNotifications=None, x__xgafv=None)</a></code></p>
232 <p class="firstline">Simulates a host maintenance event on a VM. For more information, see</p>
233 <p class="toc_element">
234 <code><a href="#start">start(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
235 <p class="firstline">Starts an instance that was stopped using theinstances().stop</p>
236 <p class="toc_element">
237 <code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
238 <p class="firstline">Starts an instance that was stopped using theinstances().stop</p>
239 <p class="toc_element">
240 <code><a href="#stop">stop(project, zone, instance, discardLocalSsd=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)</a></code></p>
241 <p class="firstline">Stops a running instance, shutting it down cleanly, and allows</p>
242 <p class="toc_element">
243 <code><a href="#suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</a></code></p>
244 <p class="firstline">This method suspends a running instance, saving its state to persistent</p>
245 <p class="toc_element">
246 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
247 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
248 <p class="toc_element">
249 <code><a href="#update">update(project, zone, instance, body=None, clearSecureTag=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</a></code></p>
250 <p class="firstline">Updates an instance only if the necessary resources are available. This</p>
251 <p class="toc_element">
252 <code><a href="#updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p>
253 <p class="firstline">Updates the specified access config from an instance's network interface</p>
254 <p class="toc_element">
255 <code><a href="#updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
256 <p class="firstline">Updates the Display config for a VM instance. You can</p>
257 <p class="toc_element">
258 <code><a href="#updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p>
259 <p class="firstline">Updates an instance's network interface. This method can only update an</p>
260 <p class="toc_element">
261 <code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
262 <p class="firstline">Updates the Shielded Instance config for an instance. You can</p>
263 <p class="toc_element">
264 <code><a href="#updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
265 <p class="firstline">Updates the Shielded VM config for a VM instance. You can</p>
266 <h3>Method Details</h3>
267 <div class="method">
268 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>
269 <pre>Adds an access config to an instance&#x27;s network interface.
270
271 Args:
272 project: string, Project ID for this request. (required)
273 zone: string, The name of the zone for this request. (required)
274 instance: string, The instance name for this request. (required)
275 networkInterface: string, The name of the network interface to add to this instance. (required)
276 body: object, The request body.
277 The object takes the form of:
278
279 { # An access configuration attached to an instance&#x27;s network interface.
280 # Only one access config per instance is supported.
281 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
282 # The first IPv6 address of the external IPv6 range associated
283 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
284 # use a static external IP address, it must be unused and in the same region
285 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
286 # assign an external IPv6 address from the instance&#x27;s subnetwork.
287 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
288 # external IPv6 range.
289 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
290 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
291 # (IPv4), the default and recommended name is External NAT, but
292 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
293 # recommend name is External IPv6.
294 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
295 # address associated with this instance. Specify an unused static
296 # external IP address available to the project or leave this field undefined
297 # to use an IP from a shared ephemeral IP address pool. If you specify a
298 # static external IP address, it must live in the same region as the zone of
299 # the instance.
300 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
301 # configuration and can only take the following values: PREMIUM,STANDARD.
302 #
303 # If an AccessConfig is specified without a valid external IP address, an
304 # ephemeral IP will be created with this networkTier.
305 #
306 # If an AccessConfig with a valid external IP address is specified, it must
307 # match that of the networkTier associated with the Address resource owning
308 # that IP.
309 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
310 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
311 #
312 # 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
313 # first IP in associated external IPv6 range.
314 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
315 # config.
316 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
317 # external IP address of this access configuration.
318 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
319 # external IP address of the instance to a DNS domain name.
320 #
321 # This field is not used in ipv6AccessConfig. A default PTR
322 # record will be created if the VM has external IPv6 range associated.
323 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
324 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
325 }
326
327 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
328 that if you must retry your request, the server will know to ignore the
329 request if it has already been completed.
330
331 For example, consider a situation where you make an initial request and
332 the request times out. If you make the request again with the same
333 request ID, the server can check if original operation with the same
334 request ID was received, and if so, will ignore the second request. This
335 prevents clients from accidentally creating duplicate commitments.
336
337 The request ID must be
338 a valid UUID with the exception that zero UUID is not supported
339 (00000000-0000-0000-0000-000000000000).
340 x__xgafv: string, V1 error format.
341 Allowed values
342 1 - v1 error format
343 2 - v2 error format
344
345 Returns:
346 An object of the form:
347
348 { # Represents an Operation resource.
349 #
350 # Google Compute Engine has three Operation resources:
351 #
352 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
353 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
354 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
355 #
356 # You can use an operation resource to manage asynchronous API requests.
357 # For more information, readHandling
358 # API responses.
359 #
360 # Operations can be global, regional or zonal.
361 #
362 # - For global operations, use the `globalOperations`
363 # resource.
364 # - For regional operations, use the
365 # `regionOperations` resource.
366 # - For zonal operations, use
367 # the `zoneOperations` resource.
368 #
369 #
370 #
371 # For more information, read
372 # Global, Regional, and Zonal Resources.
373 #
374 # Note that completed Operation resources have a limited
375 # retention period.
376 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
377 # Not present otherwise.
378 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
379 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
380 # set when the operation is created.
381 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
382 # text format.
383 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
384 # this field will be populated.
385 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
386 # operation.
387 {
388 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
389 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
390 # details. There is a set of defined message types to use for providing
391 # details.The syntax depends on the error code. For example,
392 # QuotaExceededInfo will have details when the error code is
393 # QUOTA_EXCEEDED.
394 {
395 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
396 #
397 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
398 # is not enabled:
399 #
400 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
401 # &quot;domain&quot;: &quot;googleapis.com&quot;
402 # &quot;metadata&quot;: {
403 # &quot;resource&quot;: &quot;projects/123&quot;,
404 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
405 # }
406 # }
407 #
408 # This response indicates that the pubsub.googleapis.com API is not enabled.
409 #
410 # Example of an error that is returned when attempting to create a Spanner
411 # instance in a region that is out of stock:
412 #
413 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
414 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
415 # &quot;metadata&quot;: {
416 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
417 # }
418 # }
419 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
420 # is typically the registered service name of the tool or product that
421 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
422 # generated by some common infrastructure, the error domain must be a
423 # globally unique value that identifies the infrastructure. For Google API
424 # infrastructure, the error domain is &quot;googleapis.com&quot;.
425 &quot;metadatas&quot;: { # Additional structured details about this error.
426 #
427 # Keys must match a regular expression of `a-z+` but should
428 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
429 # length. When identifying the current value of an exceeded limit, the units
430 # should be contained in the key, not the value. For example, rather than
431 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
432 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
433 # instances that can be created in a single (batch) request.
434 &quot;a_key&quot;: &quot;A String&quot;,
435 },
436 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
437 # proximate cause of the error. Error reasons are unique within a particular
438 # domain of errors. This should be at most 63 characters and match a
439 # regular expression of `A-Z+[A-Z0-9]`, which represents
440 # UPPER_SNAKE_CASE.
441 },
442 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
443 #
444 # For example, if a quota check failed with an error indicating the calling
445 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
446 # directly to the right place in the developer console to flip the bit.
447 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
448 { # Describes a URL link.
449 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
450 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
451 },
452 ],
453 },
454 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
455 # which can be attached to an RPC error.
456 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
457 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
458 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
459 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
460 },
461 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
462 &quot;dimensions&quot;: { # The map holding related quota dimensions.
463 &quot;a_key&quot;: &quot;A String&quot;,
464 },
465 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
466 # type or metric.
467 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
468 # or metric.
469 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
470 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
471 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
472 },
473 },
474 ],
475 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
476 # This property is optional.
477 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
478 },
479 ],
480 },
481 &quot;getVersionOperationMetadata&quot;: {
482 &quot;inlineSbomInfo&quot;: {
483 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
484 # appropriate identifiers.
485 &quot;a_key&quot;: &quot;A String&quot;,
486 },
487 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
488 # identifiers.
489 &quot;a_key&quot;: &quot;A String&quot;,
490 },
491 },
492 },
493 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
494 # message that was returned, such as `NOT FOUND`.
495 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
496 # status code that was returned. For example, a `404` means the
497 # resource was not found.
498 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
499 # defined by the server.
500 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
501 # This value is inRFC3339
502 # text format.
503 &quot;instancesBulkInsertOperationMetadata&quot;: {
504 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
505 # Example key: zones/us-central1-a
506 &quot;a_key&quot;: {
507 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
508 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
509 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
510 # error.
511 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
512 # if the flow is rolling forward or rolling back.
513 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
514 },
515 },
516 },
517 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
518 # Operation resources.
519 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
520 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
521 # group of operations results from a `bulkInsert` API request.
522 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
523 # `update`, or `delete`, and so on.
524 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
525 # There is no requirement that this be linear or support any granularity of
526 # operations. This should not be used to guess when the operation will be
527 # complete. This number should monotonically increase as the operation
528 # progresses.
529 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
530 # applicable when performing regional operations.
531 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
532 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
533 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
534 # this field will contain information on all underlying zonal actions and
535 # their state.
536 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
537 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
538 # Example key: zones/us-central1-a
539 &quot;a_key&quot;: {
540 &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
541 # populated.
542 # different programming environments, including REST APIs and RPC APIs. It is
543 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
544 # three pieces of data: error code, error message, and error details.
545 #
546 # You can find out more about this error model and how to work with it in the
547 # [API Design Guide](https://cloud.google.com/apis/design/errors).
548 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
549 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
550 # message types for APIs to use.
551 {
552 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
553 },
554 ],
555 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
556 # user-facing error message should be localized and sent in the
557 # google.rpc.Status.details field, or localized by the client.
558 },
559 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
560 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
561 },
562 },
563 },
564 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
565 # This value is inRFC3339
566 # text format.
567 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
568 # following:
569 # `PENDING`, `RUNNING`, or `DONE`.
570 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
571 # operation.
572 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
573 # of the target resource.
574 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
575 # operations related to creating a snapshot, this points to the disk
576 # that the snapshot was created from.
577 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
578 # `[email protected]` or
579 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
580 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
581 # operation, this field will be populated.
582 {
583 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
584 # Engine returns NO_RESULTS_ON_PAGE if there
585 # are no results in the response.
586 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
587 # value format. For example:
588 #
589 # &quot;data&quot;: [
590 # {
591 # &quot;key&quot;: &quot;scope&quot;,
592 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
593 # }
594 {
595 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
596 # returned. For example, for warnings where there are no results in a list
597 # request for a particular zone, this key might be scope and
598 # the key value might be the zone name. Other examples might be a key
599 # indicating a deprecated resource and a suggested replacement, or a
600 # warning about invalid network settings (for example, if an instance
601 # attempts to perform IP forwarding but is not enabled for IP forwarding).
602 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
603 },
604 ],
605 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
606 },
607 ],
608 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
609 # applicable when performing per-zone operations.
610 }</pre>
611 </div>
612
613 <div class="method">
614 <code class="details" id="addNetworkInterface">addNetworkInterface(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
615 <pre>Adds one dynamic network interface to an active instance.
616
617 Args:
618 project: string, Project ID for this request. (required)
619 zone: string, The name of the zone for this request. (required)
620 instance: string, The instance name for this request stored as resource_id.
621 Name should conform to RFC1035 or be an unsigned long integer. (required)
622 body: object, The request body.
623 The object takes the form of:
624
625 { # A network interface resource attached to an instance.
626 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
627 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
628 # no external internet access.
629 { # An access configuration attached to an instance&#x27;s network interface.
630 # Only one access config per instance is supported.
631 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
632 # The first IPv6 address of the external IPv6 range associated
633 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
634 # use a static external IP address, it must be unused and in the same region
635 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
636 # assign an external IPv6 address from the instance&#x27;s subnetwork.
637 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
638 # external IPv6 range.
639 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
640 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
641 # (IPv4), the default and recommended name is External NAT, but
642 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
643 # recommend name is External IPv6.
644 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
645 # address associated with this instance. Specify an unused static
646 # external IP address available to the project or leave this field undefined
647 # to use an IP from a shared ephemeral IP address pool. If you specify a
648 # static external IP address, it must live in the same region as the zone of
649 # the instance.
650 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
651 # configuration and can only take the following values: PREMIUM,STANDARD.
652 #
653 # If an AccessConfig is specified without a valid external IP address, an
654 # ephemeral IP will be created with this networkTier.
655 #
656 # If an AccessConfig with a valid external IP address is specified, it must
657 # match that of the networkTier associated with the Address resource owning
658 # that IP.
659 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
660 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
661 #
662 # 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
663 # first IP in associated external IPv6 range.
664 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
665 # config.
666 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
667 # external IP address of this access configuration.
668 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
669 # external IP address of the instance to a DNS domain name.
670 #
671 # This field is not used in ipv6AccessConfig. A default PTR
672 # record will be created if the VM has external IPv6 range associated.
673 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
674 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
675 },
676 ],
677 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
678 # You can only specify this field for network interfaces in VPC networks.
679 { # An alias IP range attached to an instance&#x27;s network interface.
680 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
681 # must belong to the specified subnetwork and cannot contain IP addresses
682 # reserved by system or used by other network interfaces. This range may be
683 # 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).
684 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
685 # alias range. If not specified, the primary range of the subnetwork is used.
686 },
687 ],
688 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
689 # You can only specify this field for network interfaces in VPC networks.
690 { # An alias IP range attached to an instance&#x27;s network interface.
691 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
692 # must belong to the specified subnetwork and cannot contain IP addresses
693 # reserved by system or used by other network interfaces. This range may be
694 # 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).
695 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
696 # alias range. If not specified, the primary range of the subnetwork is used.
697 },
698 ],
699 &quot;dns64Eligible&quot;: True or False, # If true, this network interface is eligible for DNS64.
700 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
701 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
702 # with network_attachment.
703 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
704 # This field will be ignored when inserting an Instance or
705 # adding a NetworkInterface. An up-to-date
706 # 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.
707 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
708 # or not. If enabled, also indicates the version of IGMP supported.
709 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
710 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
711 # one IPv6 access config, DIRECT_IPV6, is supported. If there
712 # is no ipv6AccessConfig specified, then this instance will
713 # have no external IPv6 Internet access.
714 { # An access configuration attached to an instance&#x27;s network interface.
715 # Only one access config per instance is supported.
716 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
717 # The first IPv6 address of the external IPv6 range associated
718 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
719 # use a static external IP address, it must be unused and in the same region
720 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
721 # assign an external IPv6 address from the instance&#x27;s subnetwork.
722 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
723 # external IPv6 range.
724 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
725 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
726 # (IPv4), the default and recommended name is External NAT, but
727 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
728 # recommend name is External IPv6.
729 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
730 # address associated with this instance. Specify an unused static
731 # external IP address available to the project or leave this field undefined
732 # to use an IP from a shared ephemeral IP address pool. If you specify a
733 # static external IP address, it must live in the same region as the zone of
734 # the instance.
735 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
736 # configuration and can only take the following values: PREMIUM,STANDARD.
737 #
738 # If an AccessConfig is specified without a valid external IP address, an
739 # ephemeral IP will be created with this networkTier.
740 #
741 # If an AccessConfig with a valid external IP address is specified, it must
742 # match that of the networkTier associated with the Address resource owning
743 # that IP.
744 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
745 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
746 #
747 # 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
748 # first IP in associated external IPv6 range.
749 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
750 # config.
751 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
752 # external IP address of this access configuration.
753 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
754 # external IP address of the instance to a DNS domain name.
755 #
756 # This field is not used in ipv6AccessConfig. A default PTR
757 # record will be created if the VM has external IPv6 range associated.
758 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
759 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
760 },
761 ],
762 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
763 # accessed from the Internet. This field is always inherited from its
764 # subnetwork.
765 #
766 # Valid only if stackType is IPV4_IPV6.
767 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
768 # use a static internal IP address, it must be unused and in the same region
769 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
770 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
771 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
772 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
773 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
774 # server. For a VM, the network interface uses the nicN naming
775 # format. Where N is a value between 0 and7. The default interface value is nic0.
776 &quot;nat64Eligible&quot;: True or False, # If true, this network interface is eligible for NAT64.
777 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
778 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
779 # instance, if neither the network nor the subnetwork is specified, the
780 # default network global/networks/default is used. If the
781 # selected project doesn&#x27;t have the default network, you must specify a
782 # network or subnet. If the network is not specified but the subnetwork is
783 # specified, the network is inferred.
784 #
785 # If you specify this property, you can specify the network as
786 # a full or partial URL. For example, the following are all valid URLs:
787 #
788 #
789 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
790 # - projects/project/global/networks/network
791 # - global/networks/default
792 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
793 # to in the following format:
794 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
795 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
796 # interface. If not specified by the user, an unused internal IP is
797 # assigned by the system.
798 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
799 # VirtioNet.
800 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
801 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
802 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
803 # if not specified by the users.
804 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
805 # interface. Can only be used with network_attachment. It is not possible to
806 # use on its own however, network_attachment can be used without
807 # service_class_id.
808 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
809 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
810 #
811 # This field can be both set at instance creation and update network
812 # interface operations.
813 &quot;subinterfaces&quot;: [ # SubInterfaces help enable L2 communication for the instance over
814 # subnetworks that support L2. Every network interface will get a default
815 # untagged (vlan not specified) subinterface. Users can specify additional
816 # tagged subinterfaces which are sub-fields to the Network Interface.
817 {
818 &quot;ipAddress&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this
819 # subinterface. If specified, ip_allocation_mode should be set to
820 # ALLOCATE_IP.
821 &quot;ipAllocationMode&quot;: &quot;A String&quot;,
822 &quot;subnetwork&quot;: &quot;A String&quot;, # If specified, this subnetwork must belong to the same network
823 # as that of the network interface.
824 # If not specified the subnet of network interface will be used.
825 # If you specify this property, you can specify the subnetwork as a full
826 # or partial URL. For example, the following are all valid URLs:
827 #
828 #
829 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
830 # - regions/region/subnetworks/subnetwork
831 &quot;vlan&quot;: 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which
832 # this subinterface is connecting.
833 },
834 ],
835 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
836 # resource is inlegacy
837 # mode, do not specify this field. If the network is in auto subnet
838 # mode, specifying the subnetwork is optional. If the network is in custom
839 # subnet mode, specifying the subnetwork is required. If you specify this
840 # field, you can specify the subnetwork as a full or partial URL. For
841 # example, the following are all valid URLs:
842 #
843 #
844 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
845 # - regions/region/subnetworks/subnetwork
846 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
847 # from 2 to 255 inclusively.
848 }
849
850 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
851 that if you must retry your request, the server will know to ignore the
852 request if it has already been completed.
853
854 For example, consider a situation where you make an initial request and
855 the request times out. If you make the request again with the same
856 request ID, the server can check if original operation with the same
857 request ID was received, and if so, will ignore the second request. This
858 prevents clients from accidentally creating duplicate commitments.
859
860 The request ID must be
861 a valid UUID with the exception that zero UUID is not supported
862 (00000000-0000-0000-0000-000000000000).
863 x__xgafv: string, V1 error format.
864 Allowed values
865 1 - v1 error format
866 2 - v2 error format
867
868 Returns:
869 An object of the form:
870
871 { # Represents an Operation resource.
872 #
873 # Google Compute Engine has three Operation resources:
874 #
875 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
876 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
877 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
878 #
879 # You can use an operation resource to manage asynchronous API requests.
880 # For more information, readHandling
881 # API responses.
882 #
883 # Operations can be global, regional or zonal.
884 #
885 # - For global operations, use the `globalOperations`
886 # resource.
887 # - For regional operations, use the
888 # `regionOperations` resource.
889 # - For zonal operations, use
890 # the `zoneOperations` resource.
891 #
892 #
893 #
894 # For more information, read
895 # Global, Regional, and Zonal Resources.
896 #
897 # Note that completed Operation resources have a limited
898 # retention period.
899 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
900 # Not present otherwise.
901 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
902 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
903 # set when the operation is created.
904 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
905 # text format.
906 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
907 # this field will be populated.
908 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
909 # operation.
910 {
911 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
912 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
913 # details. There is a set of defined message types to use for providing
914 # details.The syntax depends on the error code. For example,
915 # QuotaExceededInfo will have details when the error code is
916 # QUOTA_EXCEEDED.
917 {
918 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
919 #
920 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
921 # is not enabled:
922 #
923 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
924 # &quot;domain&quot;: &quot;googleapis.com&quot;
925 # &quot;metadata&quot;: {
926 # &quot;resource&quot;: &quot;projects/123&quot;,
927 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
928 # }
929 # }
930 #
931 # This response indicates that the pubsub.googleapis.com API is not enabled.
932 #
933 # Example of an error that is returned when attempting to create a Spanner
934 # instance in a region that is out of stock:
935 #
936 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
937 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
938 # &quot;metadata&quot;: {
939 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
940 # }
941 # }
942 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
943 # is typically the registered service name of the tool or product that
944 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
945 # generated by some common infrastructure, the error domain must be a
946 # globally unique value that identifies the infrastructure. For Google API
947 # infrastructure, the error domain is &quot;googleapis.com&quot;.
948 &quot;metadatas&quot;: { # Additional structured details about this error.
949 #
950 # Keys must match a regular expression of `a-z+` but should
951 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
952 # length. When identifying the current value of an exceeded limit, the units
953 # should be contained in the key, not the value. For example, rather than
954 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
955 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
956 # instances that can be created in a single (batch) request.
957 &quot;a_key&quot;: &quot;A String&quot;,
958 },
959 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
960 # proximate cause of the error. Error reasons are unique within a particular
961 # domain of errors. This should be at most 63 characters and match a
962 # regular expression of `A-Z+[A-Z0-9]`, which represents
963 # UPPER_SNAKE_CASE.
964 },
965 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
966 #
967 # For example, if a quota check failed with an error indicating the calling
968 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
969 # directly to the right place in the developer console to flip the bit.
970 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
971 { # Describes a URL link.
972 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
973 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
974 },
975 ],
976 },
977 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
978 # which can be attached to an RPC error.
979 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
980 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
981 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
982 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
983 },
984 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
985 &quot;dimensions&quot;: { # The map holding related quota dimensions.
986 &quot;a_key&quot;: &quot;A String&quot;,
987 },
988 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
989 # type or metric.
990 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
991 # or metric.
992 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
993 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
994 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
995 },
996 },
997 ],
998 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
999 # This property is optional.
1000 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1001 },
1002 ],
1003 },
1004 &quot;getVersionOperationMetadata&quot;: {
1005 &quot;inlineSbomInfo&quot;: {
1006 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1007 # appropriate identifiers.
1008 &quot;a_key&quot;: &quot;A String&quot;,
1009 },
1010 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1011 # identifiers.
1012 &quot;a_key&quot;: &quot;A String&quot;,
1013 },
1014 },
1015 },
1016 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1017 # message that was returned, such as `NOT FOUND`.
1018 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1019 # status code that was returned. For example, a `404` means the
1020 # resource was not found.
1021 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1022 # defined by the server.
1023 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1024 # This value is inRFC3339
1025 # text format.
1026 &quot;instancesBulkInsertOperationMetadata&quot;: {
1027 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1028 # Example key: zones/us-central1-a
1029 &quot;a_key&quot;: {
1030 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1031 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1032 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1033 # error.
1034 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1035 # if the flow is rolling forward or rolling back.
1036 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1037 },
1038 },
1039 },
1040 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1041 # Operation resources.
1042 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1043 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1044 # group of operations results from a `bulkInsert` API request.
1045 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1046 # `update`, or `delete`, and so on.
1047 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1048 # There is no requirement that this be linear or support any granularity of
1049 # operations. This should not be used to guess when the operation will be
1050 # complete. This number should monotonically increase as the operation
1051 # progresses.
1052 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1053 # applicable when performing regional operations.
1054 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1055 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1056 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1057 # this field will contain information on all underlying zonal actions and
1058 # their state.
1059 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1060 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1061 # Example key: zones/us-central1-a
1062 &quot;a_key&quot;: {
1063 &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
1064 # populated.
1065 # different programming environments, including REST APIs and RPC APIs. It is
1066 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1067 # three pieces of data: error code, error message, and error details.
1068 #
1069 # You can find out more about this error model and how to work with it in the
1070 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1071 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1072 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1073 # message types for APIs to use.
1074 {
1075 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1076 },
1077 ],
1078 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1079 # user-facing error message should be localized and sent in the
1080 # google.rpc.Status.details field, or localized by the client.
1081 },
1082 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1083 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1084 },
1085 },
1086 },
1087 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1088 # This value is inRFC3339
1089 # text format.
1090 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1091 # following:
1092 # `PENDING`, `RUNNING`, or `DONE`.
1093 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1094 # operation.
1095 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1096 # of the target resource.
1097 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1098 # operations related to creating a snapshot, this points to the disk
1099 # that the snapshot was created from.
1100 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1101 # `[email protected]` or
1102 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1103 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1104 # operation, this field will be populated.
1105 {
1106 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1107 # Engine returns NO_RESULTS_ON_PAGE if there
1108 # are no results in the response.
1109 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1110 # value format. For example:
1111 #
1112 # &quot;data&quot;: [
1113 # {
1114 # &quot;key&quot;: &quot;scope&quot;,
1115 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1116 # }
1117 {
1118 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1119 # returned. For example, for warnings where there are no results in a list
1120 # request for a particular zone, this key might be scope and
1121 # the key value might be the zone name. Other examples might be a key
1122 # indicating a deprecated resource and a suggested replacement, or a
1123 # warning about invalid network settings (for example, if an instance
1124 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1125 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1126 },
1127 ],
1128 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1129 },
1130 ],
1131 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1132 # applicable when performing per-zone operations.
1133 }</pre>
1134 </div>
1135
1136 <div class="method">
1137 <code class="details" id="addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
1138 <pre>Adds existing resource policies to an instance. You can only add one
1139 policy right now which will be applied to this instance for scheduling live
1140 migrations.
1141
1142 Args:
1143 project: string, Project ID for this request. (required)
1144 zone: string, The name of the zone for this request. (required)
1145 instance: string, The instance name for this request. (required)
1146 body: object, The request body.
1147 The object takes the form of:
1148
1149 {
1150 &quot;resourcePolicies&quot;: [ # Resource policies to be added to this instance.
1151 &quot;A String&quot;,
1152 ],
1153 }
1154
1155 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1156 that if you must retry your request, the server will know to ignore the
1157 request if it has already been completed.
1158
1159 For example, consider a situation where you make an initial request and
1160 the request times out. If you make the request again with the same
1161 request ID, the server can check if original operation with the same
1162 request ID was received, and if so, will ignore the second request. This
1163 prevents clients from accidentally creating duplicate commitments.
1164
1165 The request ID must be
1166 a valid UUID with the exception that zero UUID is not supported
1167 (00000000-0000-0000-0000-000000000000).
1168 x__xgafv: string, V1 error format.
1169 Allowed values
1170 1 - v1 error format
1171 2 - v2 error format
1172
1173 Returns:
1174 An object of the form:
1175
1176 { # Represents an Operation resource.
1177 #
1178 # Google Compute Engine has three Operation resources:
1179 #
1180 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1181 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1182 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1183 #
1184 # You can use an operation resource to manage asynchronous API requests.
1185 # For more information, readHandling
1186 # API responses.
1187 #
1188 # Operations can be global, regional or zonal.
1189 #
1190 # - For global operations, use the `globalOperations`
1191 # resource.
1192 # - For regional operations, use the
1193 # `regionOperations` resource.
1194 # - For zonal operations, use
1195 # the `zoneOperations` resource.
1196 #
1197 #
1198 #
1199 # For more information, read
1200 # Global, Regional, and Zonal Resources.
1201 #
1202 # Note that completed Operation resources have a limited
1203 # retention period.
1204 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1205 # Not present otherwise.
1206 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1207 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1208 # set when the operation is created.
1209 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1210 # text format.
1211 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1212 # this field will be populated.
1213 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1214 # operation.
1215 {
1216 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1217 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1218 # details. There is a set of defined message types to use for providing
1219 # details.The syntax depends on the error code. For example,
1220 # QuotaExceededInfo will have details when the error code is
1221 # QUOTA_EXCEEDED.
1222 {
1223 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1224 #
1225 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1226 # is not enabled:
1227 #
1228 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1229 # &quot;domain&quot;: &quot;googleapis.com&quot;
1230 # &quot;metadata&quot;: {
1231 # &quot;resource&quot;: &quot;projects/123&quot;,
1232 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1233 # }
1234 # }
1235 #
1236 # This response indicates that the pubsub.googleapis.com API is not enabled.
1237 #
1238 # Example of an error that is returned when attempting to create a Spanner
1239 # instance in a region that is out of stock:
1240 #
1241 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1242 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1243 # &quot;metadata&quot;: {
1244 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1245 # }
1246 # }
1247 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1248 # is typically the registered service name of the tool or product that
1249 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1250 # generated by some common infrastructure, the error domain must be a
1251 # globally unique value that identifies the infrastructure. For Google API
1252 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1253 &quot;metadatas&quot;: { # Additional structured details about this error.
1254 #
1255 # Keys must match a regular expression of `a-z+` but should
1256 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1257 # length. When identifying the current value of an exceeded limit, the units
1258 # should be contained in the key, not the value. For example, rather than
1259 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1260 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1261 # instances that can be created in a single (batch) request.
1262 &quot;a_key&quot;: &quot;A String&quot;,
1263 },
1264 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1265 # proximate cause of the error. Error reasons are unique within a particular
1266 # domain of errors. This should be at most 63 characters and match a
1267 # regular expression of `A-Z+[A-Z0-9]`, which represents
1268 # UPPER_SNAKE_CASE.
1269 },
1270 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1271 #
1272 # For example, if a quota check failed with an error indicating the calling
1273 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1274 # directly to the right place in the developer console to flip the bit.
1275 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1276 { # Describes a URL link.
1277 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1278 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1279 },
1280 ],
1281 },
1282 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1283 # which can be attached to an RPC error.
1284 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1285 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1286 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1287 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1288 },
1289 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1290 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1291 &quot;a_key&quot;: &quot;A String&quot;,
1292 },
1293 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1294 # type or metric.
1295 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1296 # or metric.
1297 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1298 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1299 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1300 },
1301 },
1302 ],
1303 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1304 # This property is optional.
1305 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1306 },
1307 ],
1308 },
1309 &quot;getVersionOperationMetadata&quot;: {
1310 &quot;inlineSbomInfo&quot;: {
1311 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1312 # appropriate identifiers.
1313 &quot;a_key&quot;: &quot;A String&quot;,
1314 },
1315 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1316 # identifiers.
1317 &quot;a_key&quot;: &quot;A String&quot;,
1318 },
1319 },
1320 },
1321 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1322 # message that was returned, such as `NOT FOUND`.
1323 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1324 # status code that was returned. For example, a `404` means the
1325 # resource was not found.
1326 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1327 # defined by the server.
1328 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1329 # This value is inRFC3339
1330 # text format.
1331 &quot;instancesBulkInsertOperationMetadata&quot;: {
1332 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1333 # Example key: zones/us-central1-a
1334 &quot;a_key&quot;: {
1335 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1336 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1337 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1338 # error.
1339 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1340 # if the flow is rolling forward or rolling back.
1341 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1342 },
1343 },
1344 },
1345 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1346 # Operation resources.
1347 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1348 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1349 # group of operations results from a `bulkInsert` API request.
1350 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1351 # `update`, or `delete`, and so on.
1352 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1353 # There is no requirement that this be linear or support any granularity of
1354 # operations. This should not be used to guess when the operation will be
1355 # complete. This number should monotonically increase as the operation
1356 # progresses.
1357 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1358 # applicable when performing regional operations.
1359 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1360 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1361 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1362 # this field will contain information on all underlying zonal actions and
1363 # their state.
1364 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1365 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1366 # Example key: zones/us-central1-a
1367 &quot;a_key&quot;: {
1368 &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
1369 # populated.
1370 # different programming environments, including REST APIs and RPC APIs. It is
1371 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1372 # three pieces of data: error code, error message, and error details.
1373 #
1374 # You can find out more about this error model and how to work with it in the
1375 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1376 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1377 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1378 # message types for APIs to use.
1379 {
1380 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1381 },
1382 ],
1383 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1384 # user-facing error message should be localized and sent in the
1385 # google.rpc.Status.details field, or localized by the client.
1386 },
1387 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1388 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1389 },
1390 },
1391 },
1392 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1393 # This value is inRFC3339
1394 # text format.
1395 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1396 # following:
1397 # `PENDING`, `RUNNING`, or `DONE`.
1398 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1399 # operation.
1400 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1401 # of the target resource.
1402 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1403 # operations related to creating a snapshot, this points to the disk
1404 # that the snapshot was created from.
1405 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1406 # `[email protected]` or
1407 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1408 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1409 # operation, this field will be populated.
1410 {
1411 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1412 # Engine returns NO_RESULTS_ON_PAGE if there
1413 # are no results in the response.
1414 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1415 # value format. For example:
1416 #
1417 # &quot;data&quot;: [
1418 # {
1419 # &quot;key&quot;: &quot;scope&quot;,
1420 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1421 # }
1422 {
1423 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1424 # returned. For example, for warnings where there are no results in a list
1425 # request for a particular zone, this key might be scope and
1426 # the key value might be the zone name. Other examples might be a key
1427 # indicating a deprecated resource and a suggested replacement, or a
1428 # warning about invalid network settings (for example, if an instance
1429 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1430 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1431 },
1432 ],
1433 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1434 },
1435 ],
1436 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1437 # applicable when performing per-zone operations.
1438 }</pre>
1439 </div>
1440
1441 <div class="method">
1442 <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>
1443 <pre>Retrieves an aggregated list of all of the instances in your project
1444 across all regions and zones.
1445
1446 The performance of this method degrades when a filter is specified on a
1447 project that has a very large number of instances.
1448
1449 To prevent failure, Google recommends that you set the
1450 `returnPartialSuccess` parameter to `true`.
1451
1452 Args:
1453 project: string, Project ID for this request. (required)
1454 filter: string, A filter expression that filters resources listed in the response. Most
1455 Compute resources support two types of filter expressions:
1456 expressions that support regular expressions and expressions that follow
1457 API improvement proposal AIP-160.
1458 These two types of filter expressions cannot be mixed in one request.
1459
1460 If you want to use AIP-160, your expression must specify the field name, an
1461 operator, and the value that you want to use for filtering. The value
1462 must be a string, a number, or a boolean. The operator
1463 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1464
1465 For example, if you are filtering Compute Engine instances, you can
1466 exclude instances named `example-instance` by specifying
1467 `name != example-instance`.
1468
1469 The `:*` comparison can be used to test whether a key has been defined.
1470 For example, to find all objects with `owner` label use:
1471 ```
1472 labels.owner:*
1473 ```
1474
1475 You can also filter nested fields. For example, you could specify
1476 `scheduling.automaticRestart = false` to include instances only
1477 if they are not scheduled for automatic restarts. You can use filtering
1478 on nested fields to filter based onresource labels.
1479
1480 To filter on multiple expressions, provide each separate expression within
1481 parentheses. For example:
1482 ```
1483 (scheduling.automaticRestart = true)
1484 (cpuPlatform = &quot;Intel Skylake&quot;)
1485 ```
1486 By default, each expression is an `AND` expression. However, you
1487 can include `AND` and `OR` expressions explicitly.
1488 For example:
1489 ```
1490 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1491 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1492 (scheduling.automaticRestart = true)
1493 ```
1494
1495 If you want to use a regular expression, use the `eq` (equal) or `ne`
1496 (not equal) operator against a single un-parenthesized expression with or
1497 without quotes or against multiple parenthesized expressions. Examples:
1498
1499 `fieldname eq unquoted literal`
1500 `fieldname eq &#x27;single quoted literal&#x27;`
1501 `fieldname eq &quot;double quoted literal&quot;`
1502 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1503
1504 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1505 The literal value must match the entire field.
1506
1507 For example, to filter for instances that do not end with name &quot;instance&quot;,
1508 you would use `name ne .*instance`.
1509
1510 You cannot combine constraints on multiple fields using regular
1511 expressions.
1512 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
1513 global) should be included in the response. For new resource types added
1514 after this field, the flag has no effect as new resource types will always
1515 include every visible scope for each scope type in response. For resource
1516 types which predate this field, if this flag is omitted or false, only
1517 scopes of the scope types where the resource type is expected to be found
1518 will be included.
1519 maxResults: integer, The maximum number of results per page that should be returned.
1520 If the number of available results is larger than `maxResults`,
1521 Compute Engine returns a `nextPageToken` that can be used to get
1522 the next page of results in subsequent list requests. Acceptable values are
1523 `0` to `500`, inclusive. (Default: `500`)
1524 orderBy: string, Sorts list results by a certain order. By default, results
1525 are returned in alphanumerical order based on the resource name.
1526
1527 You can also sort results in descending order based on the creation
1528 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1529 results based on the `creationTimestamp` field in
1530 reverse chronological order (newest result first). Use this to sort
1531 resources like operations so that the newest operation is returned first.
1532
1533 Currently, only sorting by `name` or
1534 `creationTimestamp desc` is supported.
1535 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1536 `nextPageToken` returned by a previous list request to get
1537 the next page of results.
1538 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1539 of failure. The default value is false.
1540
1541 For example, when partial success behavior is enabled, aggregatedList for a
1542 single zone scope either returns all resources in the zone or no resources,
1543 with an error code.
1544 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
1545 aggregated list request is invoked for subnetworks list-usable api.
1546 x__xgafv: string, V1 error format.
1547 Allowed values
1548 1 - v1 error format
1549 2 - v2 error format
1550
1551 Returns:
1552 An object of the form:
1553
1554 {
1555 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1556 &quot;items&quot;: { # An object that contains a list of instances scoped by zone.
1557 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of instances.
1558 &quot;instances&quot;: [ # [Output Only] A list of instances contained in this scope.
1559 { # Represents an Instance resource.
1560 #
1561 # An instance is a virtual machine that is hosted on Google Cloud Platform.
1562 # For more information, readVirtual Machine Instances.
1563 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
1564 # Options that would traditionally be configured in a BIOS belong
1565 # here. Features that require operating system support may have
1566 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
1567 # disabled).
1568 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
1569 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
1570 &quot;enableWatchdogTimer&quot;: True or False, # Whether to enable the watchdog timer.
1571 &quot;numaNodeCount&quot;: 42, # The number of vNUMA nodes.
1572 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
1573 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
1574 # multithreading (SMT) set this to 1. If unset, the maximum number
1575 # of threads supported per core by the underlying processor is
1576 # assumed.
1577 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
1578 # Supported modes include:
1579 # * ALL_CORE_MAX
1580 #
1581 # Using empty string or not setting this field will use the platform-specific
1582 # default turbo mode.
1583 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
1584 # the number of threads per core to compute the total number of virtual
1585 # CPUs to expose to the instance. If unset, the number of cores is
1586 # inferred from the instance&#x27;s nominal CPU count and the underlying
1587 # platform&#x27;s SMT width.
1588 },
1589 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
1590 # destination or source IPs. This is required if you plan to use this
1591 # instance to forward routes. For more information, seeEnabling IP Forwarding.
1592 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
1593 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
1594 &quot;confidentialParavisorConfig&quot;: { # A set of Confidential Paravisor (SVSM) options. # Defines a set of Confidential Paravisor (SVSM) options.
1595 &quot;confidentialTpmType&quot;: &quot;A String&quot;,
1596 &quot;sevSnpIrqMode&quot;: &quot;A String&quot;,
1597 },
1598 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
1599 },
1600 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
1601 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
1602 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
1603 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1604 # create the resource.
1605 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
1606 # created before you can assign them.
1607 { # An instance-attached disk resource.
1608 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
1609 # or X86_64.
1610 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
1611 # deleted (but not when the disk is detached from the instance).
1612 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
1613 # partition of the disk for its root filesystem.
1614 &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
1615 # running within the instance. This name can be used to reference the device
1616 # for mounting, resizing, and so on, from within the instance.
1617 #
1618 # If not specified, the server chooses a default device name to apply to this
1619 # disk, in the form persistent-disk-x, where x is a number
1620 # assigned by Google Compute Engine. This field is only applicable for
1621 # persistent disks.
1622 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
1623 # encryption key.
1624 #
1625 # If you are creating a new disk, this field encrypts the new disk using
1626 # an encryption key that you provide. If you are attaching an existing
1627 # disk that is already encrypted, this field decrypts the disk using
1628 # the customer-supplied encryption key.
1629 #
1630 # If you encrypt a disk using a customer-supplied key, you must provide the
1631 # same key again when you attempt to use this resource at a later time. For
1632 # example, you must provide the key when you create a snapshot or an image
1633 # from the disk or when you attach the disk to a virtual machine instance.
1634 #
1635 # If you do not provide an encryption key, then the disk will be encrypted
1636 # using an automatically generated key and you do not need to provide a key
1637 # to use the disk later.
1638 #
1639 # Note:
1640 #
1641 # Instance templates do not storecustomer-supplied
1642 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
1643 #
1644 # You cannot create VMs that have disks with customer-supplied keys using
1645 # the bulk
1646 # insert method.
1647 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1648 # For example:
1649 #
1650 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1651 # key_region/cryptoKeys/key
1652 #
1653 # The fully-qualifed key name may be returned for resource GET requests. For
1654 # example:
1655 #
1656 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1657 # key_region/cryptoKeys/key
1658 # /cryptoKeyVersions/1
1659 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1660 # key. If absent, the Compute Engine default service account is used.
1661 # For example:
1662 #
1663 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1664 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1665 # encryption key, encoded in RFC
1666 # 4648 base64 to either encrypt or decrypt this resource. You can
1667 # provide either the rawKey or thersaEncryptedKey.
1668 # For example:
1669 #
1670 # &quot;rawKey&quot;:
1671 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1672 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1673 # customer-supplied encryption key to either encrypt or decrypt this
1674 # resource. You can provide either the rawKey or thersaEncryptedKey.
1675 # For example:
1676 #
1677 # &quot;rsaEncryptedKey&quot;:
1678 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1679 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1680 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1681 #
1682 # The key must meet the following requirements before you can provide it to
1683 # Compute Engine:
1684 #
1685 # 1. The key is wrapped using a RSA public key certificate provided by
1686 # Google.
1687 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1688 # encoding.
1689 #
1690 # Gets the RSA public key certificate provided by Google at:
1691 #
1692 #
1693 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1694 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1695 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1696 # encryption key that protects this resource.
1697 },
1698 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
1699 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
1700 # currently attached to another instance. If you try to force attach a zonal
1701 # disk to an instance, you will receive an error.
1702 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
1703 # only for bootable images. Read
1704 # Enabling guest operating system features to see a list of available
1705 # options.
1706 { # Guest OS features.
1707 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1708 # separate values. Set to one or more of the following values:
1709 #
1710 # - VIRTIO_SCSI_MULTIQUEUE
1711 # - WINDOWS
1712 # - MULTI_IP_SUBNET
1713 # - UEFI_COMPATIBLE
1714 # - GVNIC
1715 # - SEV_CAPABLE
1716 # - SUSPEND_RESUME_COMPATIBLE
1717 # - SEV_LIVE_MIGRATABLE_V2
1718 # - SEV_SNP_CAPABLE
1719 # - TDX_CAPABLE
1720 # - IDPF
1721 # - SNP_SVSM_CAPABLE
1722 # - CCA_CAPABLE
1723 #
1724 #
1725 # For more information, see
1726 # Enabling guest operating system features.
1727 },
1728 ],
1729 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
1730 # boot disk. If you have many disks attached to an instance, each
1731 # disk would have a unique index number.
1732 &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
1733 # alongside the new instance. Use initialization parameters to create boot
1734 # disks or local SSDs attached to the new instance.
1735 #
1736 # This property is mutually exclusive with the source property;
1737 # you can only define one or the other, but not both.
1738 # alongside the new instance. Use initialization parameters to create boot
1739 # disks or local SSDs attached to the new instance.
1740 #
1741 # This field is persisted and returned for instanceTemplate and not returned
1742 # in the context of instance.
1743 #
1744 # This property is mutually exclusive with the source property;
1745 # you can only define one or the other, but not both.
1746 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
1747 # arm64 or x86_64.
1748 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
1749 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
1750 # of the instance. If a disk with the same name already exists in the given
1751 # region, the existing disk is attached to the new instance and the
1752 # new disk is not created.
1753 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
1754 # 10 GB. If you specify a sourceImage, which is required for
1755 # boot disks, the default size is the size of the sourceImage.
1756 # If you do not specify a sourceImage, the default disk size
1757 # is 500 GB.
1758 &quot;diskType&quot;: &quot;A String&quot;,
1759 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
1760 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
1761 # only for bootable images. Read
1762 # Enabling guest operating system features to see a list of available
1763 # options.
1764 #
1765 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
1766 { # Guest OS features.
1767 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1768 # separate values. Set to one or more of the following values:
1769 #
1770 # - VIRTIO_SCSI_MULTIQUEUE
1771 # - WINDOWS
1772 # - MULTI_IP_SUBNET
1773 # - UEFI_COMPATIBLE
1774 # - GVNIC
1775 # - SEV_CAPABLE
1776 # - SUSPEND_RESUME_COMPATIBLE
1777 # - SEV_LIVE_MIGRATABLE_V2
1778 # - SEV_SNP_CAPABLE
1779 # - TDX_CAPABLE
1780 # - IDPF
1781 # - SNP_SVSM_CAPABLE
1782 # - CCA_CAPABLE
1783 #
1784 #
1785 # For more information, see
1786 # Enabling guest operating system features.
1787 },
1788 ],
1789 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
1790 # which is either SCSI or NVME. The default isSCSI.
1791 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
1792 # persistent disks.
1793 &quot;a_key&quot;: &quot;A String&quot;,
1794 },
1795 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
1796 # disk.
1797 &quot;A String&quot;,
1798 ],
1799 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
1800 &quot;A String&quot;,
1801 ],
1802 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
1803 # more than one instance.
1804 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
1805 # is to use the existing disk.
1806 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
1807 # of I/O operations per second that the disk can handle. Values must be
1808 # between 10,000 and 120,000. For more details, see theExtreme persistent
1809 # disk documentation.
1810 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
1811 # number of throughput mb per second that the disk can handle. Values must
1812 # greater than or equal to 1.
1813 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
1814 # the URLs of the zones where the disk should be replicated to.
1815 # You must provide exactly two replica zones, and one zone must be the same
1816 # as the instance zone.
1817 &quot;A String&quot;,
1818 ],
1819 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
1820 # have the same definition as resource
1821 # manager tags. Keys and values can be either in numeric format,
1822 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1823 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1824 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
1825 # empty.
1826 &quot;a_key&quot;: &quot;A String&quot;,
1827 },
1828 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
1829 # Specified using the full or partial URL. For instance template, specify
1830 # only the resource policy name.
1831 &quot;A String&quot;,
1832 ],
1833 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
1834 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
1835 # is required.
1836 #
1837 # To create a disk with one of the public operating system
1838 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
1839 #
1840 # projects/debian-cloud/global/images/family/debian-9
1841 #
1842 #
1843 # Alternatively, use a specific version of a public operating system image:
1844 #
1845 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
1846 #
1847 #
1848 # To create a disk with a custom image that you created, specify the
1849 # image name in the following format:
1850 #
1851 # global/images/my-custom-image
1852 #
1853 #
1854 # You can also specify a custom image by its image family, which returns
1855 # the latest version of the image in that family. Replace the image name
1856 # with family/family-name:
1857 #
1858 # global/images/family/my-image-family
1859 #
1860 #
1861 # If the source image is deleted later, this field will not be set.
1862 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
1863 # encryption key of the source image. Required if the source image is
1864 # protected by a customer-supplied encryption key.
1865 #
1866 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
1867 # encryption keys, so you cannot create disks for instances in a managed instance group if the
1868 # source images are encrypted with your own keys.
1869 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1870 # For example:
1871 #
1872 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1873 # key_region/cryptoKeys/key
1874 #
1875 # The fully-qualifed key name may be returned for resource GET requests. For
1876 # example:
1877 #
1878 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1879 # key_region/cryptoKeys/key
1880 # /cryptoKeyVersions/1
1881 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1882 # key. If absent, the Compute Engine default service account is used.
1883 # For example:
1884 #
1885 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1886 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1887 # encryption key, encoded in RFC
1888 # 4648 base64 to either encrypt or decrypt this resource. You can
1889 # provide either the rawKey or thersaEncryptedKey.
1890 # For example:
1891 #
1892 # &quot;rawKey&quot;:
1893 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1894 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1895 # customer-supplied encryption key to either encrypt or decrypt this
1896 # resource. You can provide either the rawKey or thersaEncryptedKey.
1897 # For example:
1898 #
1899 # &quot;rsaEncryptedKey&quot;:
1900 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1901 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1902 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1903 #
1904 # The key must meet the following requirements before you can provide it to
1905 # Compute Engine:
1906 #
1907 # 1. The key is wrapped using a RSA public key certificate provided by
1908 # Google.
1909 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1910 # encoding.
1911 #
1912 # Gets the RSA public key certificate provided by Google at:
1913 #
1914 #
1915 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1916 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1917 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1918 # encryption key that protects this resource.
1919 },
1920 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
1921 # instance boot disk, one of initializeParams.sourceSnapshot
1922 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
1923 # is required.
1924 #
1925 # To create a disk with a snapshot that you created, specify the
1926 # snapshot name in the following format:
1927 #
1928 # us-central1-a/instantSnapshots/my-backup
1929 #
1930 #
1931 # If the source instant-snapshot is deleted later, this field will not be
1932 # set.
1933 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
1934 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
1935 # is required.
1936 #
1937 # To create a disk with a snapshot that you created, specify the
1938 # snapshot name in the following format:
1939 #
1940 # global/snapshots/my-backup
1941 #
1942 #
1943 # If the source snapshot is deleted later, this field will not be set.
1944 #
1945 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
1946 # an image instead when you create VMs using
1947 # the bulk
1948 # insert method.
1949 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
1950 # encryption key of the source snapshot.
1951 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1952 # For example:
1953 #
1954 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1955 # key_region/cryptoKeys/key
1956 #
1957 # The fully-qualifed key name may be returned for resource GET requests. For
1958 # example:
1959 #
1960 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1961 # key_region/cryptoKeys/key
1962 # /cryptoKeyVersions/1
1963 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1964 # key. If absent, the Compute Engine default service account is used.
1965 # For example:
1966 #
1967 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1968 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1969 # encryption key, encoded in RFC
1970 # 4648 base64 to either encrypt or decrypt this resource. You can
1971 # provide either the rawKey or thersaEncryptedKey.
1972 # For example:
1973 #
1974 # &quot;rawKey&quot;:
1975 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1976 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1977 # customer-supplied encryption key to either encrypt or decrypt this
1978 # resource. You can provide either the rawKey or thersaEncryptedKey.
1979 # For example:
1980 #
1981 # &quot;rsaEncryptedKey&quot;:
1982 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1983 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1984 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1985 #
1986 # The key must meet the following requirements before you can provide it to
1987 # Compute Engine:
1988 #
1989 # 1. The key is wrapped using a RSA public key certificate provided by
1990 # Google.
1991 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1992 # encoding.
1993 #
1994 # Gets the RSA public key certificate provided by Google at:
1995 #
1996 #
1997 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1998 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1999 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2000 # encryption key that protects this resource.
2001 },
2002 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
2003 # this as a partial or full URL to the resource. For example, the following
2004 # are valid values:
2005 #
2006 #
2007 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
2008 # - projects/project/zones/zone/storagePools/storagePool
2009 # - zones/zone/storagePools/storagePool
2010 },
2011 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
2012 # either SCSI or NVME. For most machine types, the
2013 # default is SCSI. Local SSDs can use either NVME or SCSI.
2014 # In certain configurations, persistent disks can use NVMe. For more
2015 # information, seeAbout
2016 # persistent disks.
2017 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
2018 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
2019 &quot;A String&quot;,
2020 ],
2021 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
2022 # disk is not allowed to be detached from the instance, or to be used as the
2023 # source of the snapshot creation, and the image creation. The instance with
2024 # at least one locked attached disk is not allow to be used as source of
2025 # machine image creation, instant snapshot creation, and not allowed to be
2026 # deleted with --keep-disk parameter set to true for locked disks.
2027 &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
2028 # in READ_WRITE mode.
2029 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
2030 # field is set to PRESERVED if the LocalSSD data has been saved
2031 # to a persistent location by customer request. (see the
2032 # discard_local_ssd option on Stop/Suspend).
2033 # Read-only in the api.
2034 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
2035 # these are public keys which are safe to store in public
2036 &quot;dbs&quot;: [ # The Key Database (db).
2037 {
2038 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2039 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2040 },
2041 ],
2042 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
2043 {
2044 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2045 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2046 },
2047 ],
2048 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
2049 {
2050 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2051 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2052 },
2053 ],
2054 &quot;pk&quot;: { # The Platform Key (PK).
2055 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2056 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2057 },
2058 },
2059 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
2060 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
2061 # is required.
2062 #
2063 # If desired, you can also attach existing non-root persistent disks using
2064 # this property. This field is only applicable for persistent disks.
2065 #
2066 # Note that for InstanceTemplate, specify the disk name for zonal disk,
2067 # and the URL for regional disk.
2068 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
2069 },
2070 ],
2071 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
2072 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
2073 },
2074 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
2075 # machine image should erase Windows specific VSS signature.
2076 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
2077 # the instance&#x27;s contents and used for optimistic locking. The
2078 # fingerprint is initially generated by Compute Engine and changes after
2079 # every request to modify or update the instance. You must always provide an
2080 # up-to-date fingerprint hash in order to update the instance.
2081 #
2082 # To see the latest fingerprint, make get() request to the
2083 # instance.
2084 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
2085 { # A specification of the type and number of accelerator cards attached to the
2086 # instance.
2087 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
2088 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
2089 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
2090 # If you are creating an instance template, specify only the
2091 # accelerator name.
2092 # See GPUs on Compute Engine
2093 # for a full list of accelerator types.
2094 },
2095 ],
2096 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
2097 # RFC1035 compliant. If hostname is not specified, the default hostname is
2098 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
2099 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
2100 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2101 # defined by the server.
2102 &quot;identity&quot;: &quot;A String&quot;,
2103 &quot;identityCertificate&quot;: True or False,
2104 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
2105 # encryption key.
2106 #
2107 # If you are creating a new instance, this field will encrypt the local SSD
2108 # and in-memory contents of the instance during the suspend operation.
2109 #
2110 # If you do not provide an encryption key when creating the instance, then
2111 # the local SSD and in-memory contents will be encrypted using
2112 # an automatically generated key during the suspend operation.
2113 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2114 # For example:
2115 #
2116 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2117 # key_region/cryptoKeys/key
2118 #
2119 # The fully-qualifed key name may be returned for resource GET requests. For
2120 # example:
2121 #
2122 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2123 # key_region/cryptoKeys/key
2124 # /cryptoKeyVersions/1
2125 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2126 # key. If absent, the Compute Engine default service account is used.
2127 # For example:
2128 #
2129 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2130 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2131 # encryption key, encoded in RFC
2132 # 4648 base64 to either encrypt or decrypt this resource. You can
2133 # provide either the rawKey or thersaEncryptedKey.
2134 # For example:
2135 #
2136 # &quot;rawKey&quot;:
2137 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2138 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2139 # customer-supplied encryption key to either encrypt or decrypt this
2140 # resource. You can provide either the rawKey or thersaEncryptedKey.
2141 # For example:
2142 #
2143 # &quot;rsaEncryptedKey&quot;:
2144 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2145 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2146 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2147 #
2148 # The key must meet the following requirements before you can provide it to
2149 # Compute Engine:
2150 #
2151 # 1. The key is wrapped using a RSA public key certificate provided by
2152 # Google.
2153 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2154 # encoding.
2155 #
2156 # Gets the RSA public key certificate provided by Google at:
2157 #
2158 #
2159 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2160 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2161 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2162 # encryption key that protects this resource.
2163 },
2164 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
2165 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
2166 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
2167 # for instances.
2168 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
2169 # the label&#x27;s contents and used for optimistic locking. The
2170 # fingerprint is initially generated by Compute Engine and changes after
2171 # every request to modify or update labels. You must always provide an
2172 # up-to-date fingerprint hash in order to update or change labels.
2173 #
2174 # To see the latest fingerprint, make get() request to the
2175 # instance.
2176 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
2177 # the setLabels method.
2178 &quot;a_key&quot;: &quot;A String&quot;,
2179 },
2180 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
2181 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
2182 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
2183 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
2184 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
2185 # when the instance is created. For example, the following is a valid partial
2186 # url to a predefined
2187 # machine type:
2188 #
2189 # zones/us-central1-f/machineTypes/n1-standard-1
2190 #
2191 #
2192 # To create acustom
2193 # machine type, provide a URL to a machine type in the following format,
2194 # where CPUS is 1 or an even number up to 32 (2,
2195 # 4, 6, ... 24, etc), and MEMORY is the total
2196 # memory for this instance. Memory must be a multiple of 256 MB and must
2197 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
2198 #
2199 # zones/zone/machineTypes/custom-CPUS-MEMORY
2200 #
2201 #
2202 # For example: zones/us-central1-f/machineTypes/custom-4-5120
2203 # For a full list of restrictions, read theSpecifications
2204 # for custom machine types.
2205 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
2206 # to this instance. This includes metadata keys that were explicitly defined
2207 # for the instance.
2208 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
2209 # the metadata&#x27;s contents and used for optimistic locking. The
2210 # fingerprint is initially generated by Compute Engine and changes after
2211 # every request to modify or update metadata. You must always provide an
2212 # up-to-date fingerprint hash in order to update or change metadata,
2213 # otherwise the request will fail with error412 conditionNotMet.
2214 #
2215 # To see the latest fingerprint, make a get() request to
2216 # retrieve the resource.
2217 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
2218 # less than 512 KB.
2219 { # Metadata
2220 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
2221 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
2222 # This is reflected as part of a URL in the metadata server. Additionally, to
2223 # avoid ambiguity, keys must not conflict with any other metadata keys
2224 # for the project.
2225 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
2226 # have meaning as interpreted by the image running in the instance. The
2227 # only restriction placed on values is that their size must be less than
2228 # or equal to 262144 bytes (256 KiB).
2229 },
2230 ],
2231 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
2232 # for metadata.
2233 },
2234 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
2235 # platform for the VM instance. Applicable values are the friendly names
2236 # of CPU platforms, such as minCpuPlatform: &quot;Intel
2237 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
2238 # Bridge&quot;.
2239 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
2240 # the resource. The resource name must be 1-63 characters long, and comply
2241 # withRFC1035.
2242 # Specifically, the name must be 1-63 characters long and match the regular
2243 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2244 # character must be a lowercase letter, and all following characters must be
2245 # a dash, lowercase letter, or digit, except the last character, which cannot
2246 # be a dash.
2247 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
2248 # interfaces are configured to interact with other network services, such as
2249 # connecting to the internet. Multiple interfaces are supported
2250 # per instance.
2251 { # A network interface resource attached to an instance.
2252 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
2253 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
2254 # no external internet access.
2255 { # An access configuration attached to an instance&#x27;s network interface.
2256 # Only one access config per instance is supported.
2257 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
2258 # The first IPv6 address of the external IPv6 range associated
2259 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
2260 # use a static external IP address, it must be unused and in the same region
2261 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2262 # assign an external IPv6 address from the instance&#x27;s subnetwork.
2263 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
2264 # external IPv6 range.
2265 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
2266 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
2267 # (IPv4), the default and recommended name is External NAT, but
2268 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
2269 # recommend name is External IPv6.
2270 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
2271 # address associated with this instance. Specify an unused static
2272 # external IP address available to the project or leave this field undefined
2273 # to use an IP from a shared ephemeral IP address pool. If you specify a
2274 # static external IP address, it must live in the same region as the zone of
2275 # the instance.
2276 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
2277 # configuration and can only take the following values: PREMIUM,STANDARD.
2278 #
2279 # If an AccessConfig is specified without a valid external IP address, an
2280 # ephemeral IP will be created with this networkTier.
2281 #
2282 # If an AccessConfig with a valid external IP address is specified, it must
2283 # match that of the networkTier associated with the Address resource owning
2284 # that IP.
2285 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
2286 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
2287 #
2288 # 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
2289 # first IP in associated external IPv6 range.
2290 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
2291 # config.
2292 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
2293 # external IP address of this access configuration.
2294 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
2295 # external IP address of the instance to a DNS domain name.
2296 #
2297 # This field is not used in ipv6AccessConfig. A default PTR
2298 # record will be created if the VM has external IPv6 range associated.
2299 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
2300 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
2301 },
2302 ],
2303 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
2304 # You can only specify this field for network interfaces in VPC networks.
2305 { # An alias IP range attached to an instance&#x27;s network interface.
2306 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
2307 # must belong to the specified subnetwork and cannot contain IP addresses
2308 # reserved by system or used by other network interfaces. This range may be
2309 # 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).
2310 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
2311 # alias range. If not specified, the primary range of the subnetwork is used.
2312 },
2313 ],
2314 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
2315 # You can only specify this field for network interfaces in VPC networks.
2316 { # An alias IP range attached to an instance&#x27;s network interface.
2317 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
2318 # must belong to the specified subnetwork and cannot contain IP addresses
2319 # reserved by system or used by other network interfaces. This range may be
2320 # 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).
2321 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
2322 # alias range. If not specified, the primary range of the subnetwork is used.
2323 },
2324 ],
2325 &quot;dns64Eligible&quot;: True or False, # If true, this network interface is eligible for DNS64.
2326 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
2327 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
2328 # with network_attachment.
2329 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
2330 # This field will be ignored when inserting an Instance or
2331 # adding a NetworkInterface. An up-to-date
2332 # 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.
2333 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
2334 # or not. If enabled, also indicates the version of IGMP supported.
2335 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
2336 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
2337 # one IPv6 access config, DIRECT_IPV6, is supported. If there
2338 # is no ipv6AccessConfig specified, then this instance will
2339 # have no external IPv6 Internet access.
2340 { # An access configuration attached to an instance&#x27;s network interface.
2341 # Only one access config per instance is supported.
2342 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
2343 # The first IPv6 address of the external IPv6 range associated
2344 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
2345 # use a static external IP address, it must be unused and in the same region
2346 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2347 # assign an external IPv6 address from the instance&#x27;s subnetwork.
2348 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
2349 # external IPv6 range.
2350 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
2351 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
2352 # (IPv4), the default and recommended name is External NAT, but
2353 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
2354 # recommend name is External IPv6.
2355 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
2356 # address associated with this instance. Specify an unused static
2357 # external IP address available to the project or leave this field undefined
2358 # to use an IP from a shared ephemeral IP address pool. If you specify a
2359 # static external IP address, it must live in the same region as the zone of
2360 # the instance.
2361 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
2362 # configuration and can only take the following values: PREMIUM,STANDARD.
2363 #
2364 # If an AccessConfig is specified without a valid external IP address, an
2365 # ephemeral IP will be created with this networkTier.
2366 #
2367 # If an AccessConfig with a valid external IP address is specified, it must
2368 # match that of the networkTier associated with the Address resource owning
2369 # that IP.
2370 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
2371 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
2372 #
2373 # 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
2374 # first IP in associated external IPv6 range.
2375 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
2376 # config.
2377 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
2378 # external IP address of this access configuration.
2379 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
2380 # external IP address of the instance to a DNS domain name.
2381 #
2382 # This field is not used in ipv6AccessConfig. A default PTR
2383 # record will be created if the VM has external IPv6 range associated.
2384 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
2385 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
2386 },
2387 ],
2388 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
2389 # accessed from the Internet. This field is always inherited from its
2390 # subnetwork.
2391 #
2392 # Valid only if stackType is IPV4_IPV6.
2393 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
2394 # use a static internal IP address, it must be unused and in the same region
2395 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2396 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
2397 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
2398 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
2399 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
2400 # server. For a VM, the network interface uses the nicN naming
2401 # format. Where N is a value between 0 and7. The default interface value is nic0.
2402 &quot;nat64Eligible&quot;: True or False, # If true, this network interface is eligible for NAT64.
2403 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
2404 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
2405 # instance, if neither the network nor the subnetwork is specified, the
2406 # default network global/networks/default is used. If the
2407 # selected project doesn&#x27;t have the default network, you must specify a
2408 # network or subnet. If the network is not specified but the subnetwork is
2409 # specified, the network is inferred.
2410 #
2411 # If you specify this property, you can specify the network as
2412 # a full or partial URL. For example, the following are all valid URLs:
2413 #
2414 #
2415 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
2416 # - projects/project/global/networks/network
2417 # - global/networks/default
2418 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
2419 # to in the following format:
2420 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
2421 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
2422 # interface. If not specified by the user, an unused internal IP is
2423 # assigned by the system.
2424 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
2425 # VirtioNet.
2426 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
2427 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
2428 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
2429 # if not specified by the users.
2430 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
2431 # interface. Can only be used with network_attachment. It is not possible to
2432 # use on its own however, network_attachment can be used without
2433 # service_class_id.
2434 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
2435 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
2436 #
2437 # This field can be both set at instance creation and update network
2438 # interface operations.
2439 &quot;subinterfaces&quot;: [ # SubInterfaces help enable L2 communication for the instance over
2440 # subnetworks that support L2. Every network interface will get a default
2441 # untagged (vlan not specified) subinterface. Users can specify additional
2442 # tagged subinterfaces which are sub-fields to the Network Interface.
2443 {
2444 &quot;ipAddress&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this
2445 # subinterface. If specified, ip_allocation_mode should be set to
2446 # ALLOCATE_IP.
2447 &quot;ipAllocationMode&quot;: &quot;A String&quot;,
2448 &quot;subnetwork&quot;: &quot;A String&quot;, # If specified, this subnetwork must belong to the same network
2449 # as that of the network interface.
2450 # If not specified the subnet of network interface will be used.
2451 # If you specify this property, you can specify the subnetwork as a full
2452 # or partial URL. For example, the following are all valid URLs:
2453 #
2454 #
2455 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
2456 # - regions/region/subnetworks/subnetwork
2457 &quot;vlan&quot;: 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which
2458 # this subinterface is connecting.
2459 },
2460 ],
2461 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
2462 # resource is inlegacy
2463 # mode, do not specify this field. If the network is in auto subnet
2464 # mode, specifying the subnetwork is optional. If the network is in custom
2465 # subnet mode, specifying the subnetwork is required. If you specify this
2466 # field, you can specify the subnetwork as a full or partial URL. For
2467 # example, the following are all valid URLs:
2468 #
2469 #
2470 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
2471 # - regions/region/subnetworks/subnetwork
2472 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
2473 # from 2 to 255 inclusively.
2474 },
2475 ],
2476 &quot;networkPerformanceConfig&quot;: {
2477 &quot;externalIpEgressBandwidthTier&quot;: &quot;A String&quot;,
2478 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
2479 },
2480 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
2481 # as part of resource payload.
2482 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
2483 # Instances.Insert API.
2484 # as a count of seconds and fractions of seconds at nanosecond
2485 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2486 # or &quot;month&quot;. Range is approximately 10,000 years.
2487 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2488 # Durations less than one second are represented with a 0
2489 # `seconds` field and a positive `nanos` field. Must be from 0
2490 # to 999,999,999 inclusive.
2491 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2492 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2493 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2494 },
2495 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
2496 # have the same definition as resource
2497 # manager tags. Keys and values can be either in numeric format,
2498 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2499 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2500 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2501 # PATCH) when empty.
2502 &quot;a_key&quot;: &quot;A String&quot;,
2503 },
2504 },
2505 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
2506 # (namespace) to entries map.
2507 &quot;a_key&quot;: {
2508 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
2509 # It accepts any value including google.protobuf.Struct.
2510 &quot;a_key&quot;: &quot;&quot;,
2511 },
2512 },
2513 },
2514 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
2515 &quot;preservedStateSizeGb&quot;: &quot;A String&quot;, # Output only. Total amount of preserved state for SUSPENDED instances.
2516 # Read-only in the api.
2517 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
2518 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
2519 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
2520 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
2521 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
2522 # Consuming reserved instances for examples.
2523 &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
2524 # the name of your reservation as its value.
2525 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
2526 # either a name to a reservation in the same project or
2527 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
2528 # shared reservation in the same zone but in a different project.
2529 &quot;A String&quot;,
2530 ],
2531 },
2532 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
2533 &quot;A String&quot;,
2534 ],
2535 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
2536 # compared to the values requested by user in the corresponding input only
2537 # field.
2538 # Use this sub-message for actual values set on Instance attributes as compared
2539 # to the value requested by the user (intent) in their instance CRUD calls.
2540 &quot;acceleratorStatus&quot;: [ # Output only. [Output Only] Accelerators status show results of GPU scans. These scans
2541 # are specialized diagnostic tests designed to uncover latent manufacturing
2542 # defects or other issues that could potentially lead to data corruption or
2543 # impede the customer&#x27;s ability to efficiently execute GPU workloads.
2544 { # The status of an individual accelerator resource.
2545 &quot;passedScans&quot;: [ # The details of scans that passed for an accelerator.
2546 {
2547 &quot;endTime&quot;: &quot;A String&quot;, # The end time of the passed scan inRFC3339 text format.
2548 &quot;name&quot;: &quot;A String&quot;,
2549 &quot;startTime&quot;: &quot;A String&quot;, # The start time of the passed scan inRFC3339 text format.
2550 &quot;version&quot;: &quot;A String&quot;,
2551 },
2552 ],
2553 &quot;recommendedScans&quot;: [ # The details of recommended scans for an accelerator.
2554 {
2555 &quot;estimatedDuration&quot;: { # A Duration represents a fixed-length span of time represented
2556 # as a count of seconds and fractions of seconds at nanosecond
2557 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2558 # or &quot;month&quot;. Range is approximately 10,000 years.
2559 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2560 # Durations less than one second are represented with a 0
2561 # `seconds` field and a positive `nanos` field. Must be from 0
2562 # to 999,999,999 inclusive.
2563 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2564 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2565 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2566 },
2567 &quot;name&quot;: &quot;A String&quot;,
2568 &quot;version&quot;: &quot;A String&quot;,
2569 },
2570 ],
2571 &quot;serialNumber&quot;: &quot;A String&quot;, # The serial number of the accelerator.
2572 &quot;uuid&quot;: &quot;A String&quot;, # The UUID of the accelerator.
2573 },
2574 ],
2575 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this instance
2576 # is consuming from.
2577 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
2578 # instance is consuming from.
2579 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
2580 # zonal instance settings, and instance-level predefined metadata keys to
2581 # provide the overridden value for those metadata keys at the instance level.
2582 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
2583 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
2584 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
2585 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
2586 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
2587 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
2588 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
2589 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
2590 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
2591 },
2592 &quot;lastInstanceTerminationDetails&quot;: { # Output only. [Output Only] Contains last termination details why the instance was
2593 # terminated.
2594 &quot;terminationReason&quot;: &quot;A String&quot;, # Reason for termination
2595 },
2596 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
2597 # center, including the block, sub-block, and host. The field is formatted as
2598 # follows: blockId/subBlockId/hostId.
2599 &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
2600 # Engine cluster, as well as the ID of the block, sub-block, and host on
2601 # which the running instance is located.
2602 # running.
2603 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
2604 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
2605 # example
2606 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
2607 # the location ID of the topologies.
2608 &quot;a_key&quot;: &quot;A String&quot;,
2609 },
2610 },
2611 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
2612 # located. Instances within the same block experience low network latency.
2613 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
2614 # running instance is located.
2615 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
2616 # Instances on the same host experience the lowest possible network
2617 # latency.
2618 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
2619 # located. Instances in the same sub-block experience lower network latency
2620 # than instances in the same block.
2621 },
2622 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
2623 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
2624 # instance is consuming from.
2625 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
2626 # instance is consuming from.
2627 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
2628 # this instance is consuming from.
2629 },
2630 &quot;scheduling&quot;: {
2631 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
2632 # must be a number between 1 and the number of availability domains
2633 # specified in the spread placement policy attached to the instance.
2634 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
2635 },
2636 &quot;serviceIntegrationStatuses&quot;: { # [Output Only] Represents the status of the service integration specs
2637 # defined by the user in instance.serviceIntegrationSpecs.
2638 &quot;a_key&quot;: { # Represents the status of integration between instance and another service.
2639 # See go/gce-backupdr-design for more details.
2640 &quot;backupDr&quot;: { # Message defining compute perspective of the result of integration with
2641 # Backup and DR. FAILED status indicates that the operation specified did
2642 # not complete correctly and should be retried with the same value.
2643 &quot;integrationDetails&quot;: &quot;A String&quot;, # The PlanReference object created by Backup and DR to maintain the
2644 # actual status of backups. May still be present if removing the backup
2645 # plan fails.
2646 &quot;state&quot;: &quot;A String&quot;, # Enum representing the registration state of a Backup and DR backup plan
2647 # for the instance.
2648 },
2649 },
2650 },
2651 &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.
2652 # programmed stop scheduled.
2653 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
2654 # `stop_state=PENDING_STOP`.
2655 # as a count of seconds and fractions of seconds at nanosecond
2656 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2657 # or &quot;month&quot;. Range is approximately 10,000 years.
2658 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2659 # Durations less than one second are represented with a 0
2660 # `seconds` field and a positive `nanos` field. Must be from 0
2661 # to 999,999,999 inclusive.
2662 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2663 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2664 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2665 },
2666 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
2667 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
2668 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
2669 },
2670 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
2671 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
2672 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
2673 # This value is inRFC3339
2674 # text format.
2675 # DEPRECATED: Use window_start_time instead.
2676 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
2677 # This timestamp value is in RFC3339 text format.
2678 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
2679 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
2680 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
2681 &quot;A String&quot;,
2682 ],
2683 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
2684 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
2685 # DEPRECATED: Use window_start_time instead.
2686 # TimeWindow is a container for two strings that represent timestamps in
2687 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
2688 &quot;earliest&quot;: &quot;A String&quot;,
2689 &quot;latest&quot;: &quot;A String&quot;,
2690 },
2691 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
2692 # This value is inRFC3339
2693 # text format.
2694 # DEPRECATED: Use window_start_time instead.
2695 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
2696 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
2697 # This timestamp value is in RFC3339 text format.
2698 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
2699 # This timestamp value is in RFC3339 text format.
2700 },
2701 },
2702 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2703 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2704 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
2705 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
2706 # terminated by Compute Engine (not terminated by a user). You can only set
2707 # the automatic restart option for standard instances.Preemptible instances
2708 # cannot be automatically restarted.
2709 #
2710 # By default, this is set to true so an instance is
2711 # automatically restarted if it is terminated by Compute Engine.
2712 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
2713 # must be a number between 1 and the number of availability domains
2714 # specified in the spread placement policy attached to the instance.
2715 &quot;currentCpus&quot;: 42, # Current number of vCPUs available for VM.
2716 # 0 or unset means default vCPUs of the current machine type.
2717 &quot;currentMemoryMb&quot;: &quot;A String&quot;, # Current amount of memory (in MB) available for VM.
2718 # 0 or unset means default amount of memory of the current machine type.
2719 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
2720 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
2721 &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
2722 # graceful shutdown isn&#x27;t complete after this time, then the instance
2723 # transitions to the STOPPING state.
2724 # as a count of seconds and fractions of seconds at nanosecond
2725 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2726 # or &quot;month&quot;. Range is approximately 10,000 years.
2727 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2728 # Durations less than one second are represented with a 0
2729 # `seconds` field and a positive `nanos` field. Must be from 0
2730 # to 999,999,999 inclusive.
2731 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2732 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2733 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2734 },
2735 },
2736 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
2737 # within the range of [90, 330] with the increment of 30, if unset, the
2738 # default behavior of host error recovery will be used.
2739 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
2740 &quot;latencyTolerant&quot;: True or False, # Defines whether the instance is tolerant of higher cpu latency. This can
2741 # only be set during instance creation, or when the instance is not currently
2742 # running. It must not be set if thepreemptible option is
2743 # also set.
2744 &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
2745 # recovery of the Local Ssd state is attempted. Its value should be in
2746 # between 0 and 168 hours with hour granularity and the default value being 1
2747 # hour.
2748 # as a count of seconds and fractions of seconds at nanosecond
2749 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2750 # or &quot;month&quot;. Range is approximately 10,000 years.
2751 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2752 # Durations less than one second are represented with a 0
2753 # `seconds` field and a positive `nanos` field. Must be from 0
2754 # to 999,999,999 inclusive.
2755 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2756 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2757 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2758 },
2759 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
2760 # resources.
2761 # This field is for use by internal tools that use the public API.
2762 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
2763 # be scheduled for maintenance.
2764 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
2765 # are: `PERIODIC`.
2766 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
2767 # the instance termination action will be performed at the end of the run
2768 # duration.
2769 # as a count of seconds and fractions of seconds at nanosecond
2770 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2771 # or &quot;month&quot;. Range is approximately 10,000 years.
2772 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2773 # Durations less than one second are represented with a 0
2774 # `seconds` field and a positive `nanos` field. Must be from 0
2775 # to 999,999,999 inclusive.
2776 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2777 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2778 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2779 },
2780 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
2781 # on a sole-tenant node.
2782 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
2783 # affinity for more information.
2784 # Overrides reservationAffinity.
2785 { # Node Affinity: the configuration of desired nodes onto which this Instance
2786 # could be scheduled.
2787 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
2788 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
2789 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
2790 &quot;A String&quot;,
2791 ],
2792 },
2793 ],
2794 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
2795 # the default behavior is MIGRATE. Forpreemptible instances,
2796 # the default and only possible behavior is TERMINATE. For more
2797 # information, see
2798 # Set
2799 # VM host maintenance policy.
2800 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
2801 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
2802 # else, the Local SSD data will be preserved when the instance is stopped
2803 # at the end of the run duration/termination time.
2804 },
2805 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
2806 # instance creation or while the instance isstopped and
2807 # therefore, in a `TERMINATED` state. SeeInstance Life
2808 # Cycle for more information on the possible instance states.
2809 &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
2810 # Off signal is triggered for Spot
2811 # VMs only. If not specified, there will be no wait before the G2 Soft
2812 # Off signal is triggered.
2813 # as a count of seconds and fractions of seconds at nanosecond
2814 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2815 # or &quot;month&quot;. Range is approximately 10,000 years.
2816 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2817 # Durations less than one second are represented with a 0
2818 # `seconds` field and a positive `nanos` field. Must be from 0
2819 # to 999,999,999 inclusive.
2820 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2821 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2822 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2823 },
2824 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
2825 &quot;shutdownTimeout&quot;: { # A Duration represents a fixed-length span of time represented # DEPRECATED: please use skipGuestOsShutdown.
2826 # Timeout between GCE ACPI G2 Soft
2827 # Off and ACPI G3 Mechanical
2828 # Off during shutdown operation of VM.
2829 #
2830 # For Standard VMs values between 0s and 120s are allowed. For Spot and
2831 # Preemptible VMs supported values are between 0s and 30s.
2832 #
2833 # If no value is specified for shutdownDuration, default values are 90s for
2834 # Standard VMs and 30s for Spot/Preemptible VMs.
2835 # as a count of seconds and fractions of seconds at nanosecond
2836 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2837 # or &quot;month&quot;. Range is approximately 10,000 years.
2838 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2839 # Durations less than one second are represented with a 0
2840 # `seconds` field and a positive `nanos` field. Must be from 0
2841 # to 999,999,999 inclusive.
2842 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2843 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2844 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2845 },
2846 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
2847 # Off and ACPI G3 Mechanical
2848 # Off for Standard VMs and 30 seconds for Spot VMs.
2849 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
2850 # termination action will be performed at the termination time.
2851 &quot;vsockMode&quot;: { # Message to control the enablement of the vsock device. # The vsock mode of the instance.
2852 &quot;mode&quot;: &quot;A String&quot;,
2853 },
2854 &quot;windowsLicenseOptimizationMode&quot;: &quot;A String&quot;, # Represents the Windows Server License Optimization Mode of the VM. If
2855 # unspecified, the default mode is `OFF`.
2856 },
2857 &quot;secureTags&quot;: [ # [Input Only] Secure tags to apply to this instance. These can be later
2858 # modified by the update method.
2859 # Maximum number of secure tags allowed is 50.
2860 &quot;A String&quot;,
2861 ],
2862 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2863 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2864 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
2865 # this instance. Only one service account per VM instance is supported.
2866 #
2867 # Service accounts generate access tokens that can be accessed
2868 # through the metadata server and used to authenticate applications on the
2869 # instance. SeeService Accounts
2870 # for more information.
2871 { # A service account.
2872 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
2873 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
2874 &quot;A String&quot;,
2875 ],
2876 },
2877 ],
2878 &quot;serviceIntegrationSpecs&quot;: { # Mapping of user-defined keys to specifications for service integrations.
2879 # Currently only a single key-value pair is supported.
2880 &quot;a_key&quot;: { # Specifies the parameters to configure an integration with instances.
2881 &quot;backupDr&quot;: { # Specifies parameters to Backup and DR to attach a BackupPlan to a compute
2882 # instance for managed VM backup.
2883 &quot;plan&quot;: &quot;A String&quot;, # The BackupPlan resource to attach to the instance. Specified as a
2884 # resource reference in instances, and regional instance templates, and as
2885 # just the plan name in global instance templates
2886 },
2887 },
2888 },
2889 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
2890 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
2891 # default.
2892 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
2893 # default.
2894 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
2895 # default.
2896 },
2897 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
2898 # Instance boot integrity is measured.
2899 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
2900 # measurements from the VM instance&#x27;s most recent boot.
2901 },
2902 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
2903 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
2904 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
2905 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
2906 },
2907 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
2908 # VM instance boot integrity is measured.
2909 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
2910 # measurements from the VM instance&#x27;s most recent boot.
2911 },
2912 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
2913 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
2914 # machine image.
2915 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2916 # For example:
2917 #
2918 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2919 # key_region/cryptoKeys/key
2920 #
2921 # The fully-qualifed key name may be returned for resource GET requests. For
2922 # example:
2923 #
2924 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2925 # key_region/cryptoKeys/key
2926 # /cryptoKeyVersions/1
2927 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2928 # key. If absent, the Compute Engine default service account is used.
2929 # For example:
2930 #
2931 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2932 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2933 # encryption key, encoded in RFC
2934 # 4648 base64 to either encrypt or decrypt this resource. You can
2935 # provide either the rawKey or thersaEncryptedKey.
2936 # For example:
2937 #
2938 # &quot;rawKey&quot;:
2939 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2940 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2941 # customer-supplied encryption key to either encrypt or decrypt this
2942 # resource. You can provide either the rawKey or thersaEncryptedKey.
2943 # For example:
2944 #
2945 # &quot;rsaEncryptedKey&quot;:
2946 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2947 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2948 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2949 #
2950 # The key must meet the following requirements before you can provide it to
2951 # Compute Engine:
2952 #
2953 # 1. The key is wrapped using a RSA public key certificate provided by
2954 # Google.
2955 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2956 # encoding.
2957 #
2958 # Gets the RSA public key certificate provided by Google at:
2959 #
2960 #
2961 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2962 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2963 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2964 # encryption key that protects this resource.
2965 },
2966 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
2967 # Engine has detected suspicious activity.
2968 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
2969 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
2970 # instance, see
2971 # Instance life cycle.
2972 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
2973 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
2974 # sources or targets for network firewalls and are specified by the client
2975 # during instance creation. The tags can be later modified by the setTags
2976 # method. Each tag within the list must comply withRFC1035.
2977 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
2978 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
2979 # the tags&#x27; contents and used for optimistic locking. The
2980 # fingerprint is initially generated by Compute Engine and changes after
2981 # every request to modify or update tags. You must always provide an
2982 # up-to-date fingerprint hash in order to update or change tags.
2983 #
2984 # To see the latest fingerprint, make get() request to the
2985 # instance.
2986 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
2987 # with RFC1035.
2988 &quot;A String&quot;,
2989 ],
2990 },
2991 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. [Output Only] DEPRECATED: Please useresource_status.upcoming_maintenance instead. Specifies
2992 # upcoming maintenance for the instance.
2993 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
2994 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
2995 # This value is inRFC3339
2996 # text format.
2997 # DEPRECATED: Use window_start_time instead.
2998 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
2999 # This timestamp value is in RFC3339 text format.
3000 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
3001 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
3002 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
3003 &quot;A String&quot;,
3004 ],
3005 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
3006 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
3007 # DEPRECATED: Use window_start_time instead.
3008 # TimeWindow is a container for two strings that represent timestamps in
3009 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
3010 &quot;earliest&quot;: &quot;A String&quot;,
3011 &quot;latest&quot;: &quot;A String&quot;,
3012 },
3013 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
3014 # This value is inRFC3339
3015 # text format.
3016 # DEPRECATED: Use window_start_time instead.
3017 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
3018 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
3019 # This timestamp value is in RFC3339 text format.
3020 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
3021 # This timestamp value is in RFC3339 text format.
3022 },
3023 &quot;workloadIdentityConfig&quot;: {
3024 &quot;identity&quot;: &quot;A String&quot;,
3025 &quot;identityCertificateEnabled&quot;: True or False,
3026 },
3027 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
3028 # You must specify this field as part of the HTTP request URL. It is
3029 # not settable as a field in the request body.
3030 },
3031 ],
3032 &quot;warning&quot;: { # [Output Only] Informational warning which replaces the list of instances
3033 # when the list is empty.
3034 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3035 # Engine returns NO_RESULTS_ON_PAGE if there
3036 # are no results in the response.
3037 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3038 # value format. For example:
3039 #
3040 # &quot;data&quot;: [
3041 # {
3042 # &quot;key&quot;: &quot;scope&quot;,
3043 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3044 # }
3045 {
3046 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3047 # returned. For example, for warnings where there are no results in a list
3048 # request for a particular zone, this key might be scope and
3049 # the key value might be the zone name. Other examples might be a key
3050 # indicating a deprecated resource and a suggested replacement, or a
3051 # warning about invalid network settings (for example, if an instance
3052 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3053 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3054 },
3055 ],
3056 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3057 },
3058 },
3059 },
3060 &quot;kind&quot;: &quot;compute#instanceAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#instanceAggregatedList for aggregated lists of
3061 # Instance resources.
3062 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
3063 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
3064 # the query parameter pageToken in the next list request.
3065 # Subsequent list requests will have their own nextPageToken to
3066 # continue paging through the results.
3067 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
3068 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
3069 &quot;A String&quot;,
3070 ],
3071 &quot;warning&quot;: { # [Output Only] Informational warning message.
3072 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3073 # Engine returns NO_RESULTS_ON_PAGE if there
3074 # are no results in the response.
3075 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3076 # value format. For example:
3077 #
3078 # &quot;data&quot;: [
3079 # {
3080 # &quot;key&quot;: &quot;scope&quot;,
3081 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3082 # }
3083 {
3084 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3085 # returned. For example, for warnings where there are no results in a list
3086 # request for a particular zone, this key might be scope and
3087 # the key value might be the zone name. Other examples might be a key
3088 # indicating a deprecated resource and a suggested replacement, or a
3089 # warning about invalid network settings (for example, if an instance
3090 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3091 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3092 },
3093 ],
3094 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3095 },
3096 }</pre>
3097 </div>
3098
3099 <div class="method">
3100 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
3101 <pre>Retrieves the next page of results.
3102
3103 Args:
3104 previous_request: The request for the previous page. (required)
3105 previous_response: The response from the request for the previous page. (required)
3106
3107 Returns:
3108 A request object that you can call &#x27;execute()&#x27; on to request the next
3109 page. Returns None if there are no more items in the collection.
3110 </pre>
3111 </div>
3112
3113 <div class="method">
3114 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None, x__xgafv=None)</code>
3115 <pre>Attaches an existing Disk resource to an instance. You must first
3116 create the disk before you can attach it. It is not possible to create
3117 and attach a disk at the same time. For more information, readAdding a
3118 persistent disk to your instance.
3119
3120 Args:
3121 project: string, Project ID for this request. (required)
3122 zone: string, The name of the zone for this request. (required)
3123 instance: string, The instance name for this request. (required)
3124 body: object, The request body.
3125 The object takes the form of:
3126
3127 { # An instance-attached disk resource.
3128 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
3129 # or X86_64.
3130 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
3131 # deleted (but not when the disk is detached from the instance).
3132 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
3133 # partition of the disk for its root filesystem.
3134 &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
3135 # running within the instance. This name can be used to reference the device
3136 # for mounting, resizing, and so on, from within the instance.
3137 #
3138 # If not specified, the server chooses a default device name to apply to this
3139 # disk, in the form persistent-disk-x, where x is a number
3140 # assigned by Google Compute Engine. This field is only applicable for
3141 # persistent disks.
3142 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
3143 # encryption key.
3144 #
3145 # If you are creating a new disk, this field encrypts the new disk using
3146 # an encryption key that you provide. If you are attaching an existing
3147 # disk that is already encrypted, this field decrypts the disk using
3148 # the customer-supplied encryption key.
3149 #
3150 # If you encrypt a disk using a customer-supplied key, you must provide the
3151 # same key again when you attempt to use this resource at a later time. For
3152 # example, you must provide the key when you create a snapshot or an image
3153 # from the disk or when you attach the disk to a virtual machine instance.
3154 #
3155 # If you do not provide an encryption key, then the disk will be encrypted
3156 # using an automatically generated key and you do not need to provide a key
3157 # to use the disk later.
3158 #
3159 # Note:
3160 #
3161 # Instance templates do not storecustomer-supplied
3162 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
3163 #
3164 # You cannot create VMs that have disks with customer-supplied keys using
3165 # the bulk
3166 # insert method.
3167 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3168 # For example:
3169 #
3170 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3171 # key_region/cryptoKeys/key
3172 #
3173 # The fully-qualifed key name may be returned for resource GET requests. For
3174 # example:
3175 #
3176 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3177 # key_region/cryptoKeys/key
3178 # /cryptoKeyVersions/1
3179 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3180 # key. If absent, the Compute Engine default service account is used.
3181 # For example:
3182 #
3183 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3184 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3185 # encryption key, encoded in RFC
3186 # 4648 base64 to either encrypt or decrypt this resource. You can
3187 # provide either the rawKey or thersaEncryptedKey.
3188 # For example:
3189 #
3190 # &quot;rawKey&quot;:
3191 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3192 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3193 # customer-supplied encryption key to either encrypt or decrypt this
3194 # resource. You can provide either the rawKey or thersaEncryptedKey.
3195 # For example:
3196 #
3197 # &quot;rsaEncryptedKey&quot;:
3198 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3199 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3200 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3201 #
3202 # The key must meet the following requirements before you can provide it to
3203 # Compute Engine:
3204 #
3205 # 1. The key is wrapped using a RSA public key certificate provided by
3206 # Google.
3207 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3208 # encoding.
3209 #
3210 # Gets the RSA public key certificate provided by Google at:
3211 #
3212 #
3213 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3214 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3215 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3216 # encryption key that protects this resource.
3217 },
3218 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
3219 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
3220 # currently attached to another instance. If you try to force attach a zonal
3221 # disk to an instance, you will receive an error.
3222 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3223 # only for bootable images. Read
3224 # Enabling guest operating system features to see a list of available
3225 # options.
3226 { # Guest OS features.
3227 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3228 # separate values. Set to one or more of the following values:
3229 #
3230 # - VIRTIO_SCSI_MULTIQUEUE
3231 # - WINDOWS
3232 # - MULTI_IP_SUBNET
3233 # - UEFI_COMPATIBLE
3234 # - GVNIC
3235 # - SEV_CAPABLE
3236 # - SUSPEND_RESUME_COMPATIBLE
3237 # - SEV_LIVE_MIGRATABLE_V2
3238 # - SEV_SNP_CAPABLE
3239 # - TDX_CAPABLE
3240 # - IDPF
3241 # - SNP_SVSM_CAPABLE
3242 # - CCA_CAPABLE
3243 #
3244 #
3245 # For more information, see
3246 # Enabling guest operating system features.
3247 },
3248 ],
3249 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
3250 # boot disk. If you have many disks attached to an instance, each
3251 # disk would have a unique index number.
3252 &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
3253 # alongside the new instance. Use initialization parameters to create boot
3254 # disks or local SSDs attached to the new instance.
3255 #
3256 # This property is mutually exclusive with the source property;
3257 # you can only define one or the other, but not both.
3258 # alongside the new instance. Use initialization parameters to create boot
3259 # disks or local SSDs attached to the new instance.
3260 #
3261 # This field is persisted and returned for instanceTemplate and not returned
3262 # in the context of instance.
3263 #
3264 # This property is mutually exclusive with the source property;
3265 # you can only define one or the other, but not both.
3266 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
3267 # arm64 or x86_64.
3268 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
3269 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
3270 # of the instance. If a disk with the same name already exists in the given
3271 # region, the existing disk is attached to the new instance and the
3272 # new disk is not created.
3273 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
3274 # 10 GB. If you specify a sourceImage, which is required for
3275 # boot disks, the default size is the size of the sourceImage.
3276 # If you do not specify a sourceImage, the default disk size
3277 # is 500 GB.
3278 &quot;diskType&quot;: &quot;A String&quot;,
3279 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
3280 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3281 # only for bootable images. Read
3282 # Enabling guest operating system features to see a list of available
3283 # options.
3284 #
3285 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
3286 { # Guest OS features.
3287 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3288 # separate values. Set to one or more of the following values:
3289 #
3290 # - VIRTIO_SCSI_MULTIQUEUE
3291 # - WINDOWS
3292 # - MULTI_IP_SUBNET
3293 # - UEFI_COMPATIBLE
3294 # - GVNIC
3295 # - SEV_CAPABLE
3296 # - SUSPEND_RESUME_COMPATIBLE
3297 # - SEV_LIVE_MIGRATABLE_V2
3298 # - SEV_SNP_CAPABLE
3299 # - TDX_CAPABLE
3300 # - IDPF
3301 # - SNP_SVSM_CAPABLE
3302 # - CCA_CAPABLE
3303 #
3304 #
3305 # For more information, see
3306 # Enabling guest operating system features.
3307 },
3308 ],
3309 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
3310 # which is either SCSI or NVME. The default isSCSI.
3311 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
3312 # persistent disks.
3313 &quot;a_key&quot;: &quot;A String&quot;,
3314 },
3315 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
3316 # disk.
3317 &quot;A String&quot;,
3318 ],
3319 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
3320 &quot;A String&quot;,
3321 ],
3322 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
3323 # more than one instance.
3324 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
3325 # is to use the existing disk.
3326 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
3327 # of I/O operations per second that the disk can handle. Values must be
3328 # between 10,000 and 120,000. For more details, see theExtreme persistent
3329 # disk documentation.
3330 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
3331 # number of throughput mb per second that the disk can handle. Values must
3332 # greater than or equal to 1.
3333 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
3334 # the URLs of the zones where the disk should be replicated to.
3335 # You must provide exactly two replica zones, and one zone must be the same
3336 # as the instance zone.
3337 &quot;A String&quot;,
3338 ],
3339 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
3340 # have the same definition as resource
3341 # manager tags. Keys and values can be either in numeric format,
3342 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3343 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3344 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
3345 # empty.
3346 &quot;a_key&quot;: &quot;A String&quot;,
3347 },
3348 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
3349 # Specified using the full or partial URL. For instance template, specify
3350 # only the resource policy name.
3351 &quot;A String&quot;,
3352 ],
3353 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
3354 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3355 # is required.
3356 #
3357 # To create a disk with one of the public operating system
3358 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
3359 #
3360 # projects/debian-cloud/global/images/family/debian-9
3361 #
3362 #
3363 # Alternatively, use a specific version of a public operating system image:
3364 #
3365 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
3366 #
3367 #
3368 # To create a disk with a custom image that you created, specify the
3369 # image name in the following format:
3370 #
3371 # global/images/my-custom-image
3372 #
3373 #
3374 # You can also specify a custom image by its image family, which returns
3375 # the latest version of the image in that family. Replace the image name
3376 # with family/family-name:
3377 #
3378 # global/images/family/my-image-family
3379 #
3380 #
3381 # If the source image is deleted later, this field will not be set.
3382 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
3383 # encryption key of the source image. Required if the source image is
3384 # protected by a customer-supplied encryption key.
3385 #
3386 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
3387 # encryption keys, so you cannot create disks for instances in a managed instance group if the
3388 # source images are encrypted with your own keys.
3389 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3390 # For example:
3391 #
3392 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3393 # key_region/cryptoKeys/key
3394 #
3395 # The fully-qualifed key name may be returned for resource GET requests. For
3396 # example:
3397 #
3398 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3399 # key_region/cryptoKeys/key
3400 # /cryptoKeyVersions/1
3401 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3402 # key. If absent, the Compute Engine default service account is used.
3403 # For example:
3404 #
3405 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3406 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3407 # encryption key, encoded in RFC
3408 # 4648 base64 to either encrypt or decrypt this resource. You can
3409 # provide either the rawKey or thersaEncryptedKey.
3410 # For example:
3411 #
3412 # &quot;rawKey&quot;:
3413 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3414 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3415 # customer-supplied encryption key to either encrypt or decrypt this
3416 # resource. You can provide either the rawKey or thersaEncryptedKey.
3417 # For example:
3418 #
3419 # &quot;rsaEncryptedKey&quot;:
3420 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3421 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3422 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3423 #
3424 # The key must meet the following requirements before you can provide it to
3425 # Compute Engine:
3426 #
3427 # 1. The key is wrapped using a RSA public key certificate provided by
3428 # Google.
3429 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3430 # encoding.
3431 #
3432 # Gets the RSA public key certificate provided by Google at:
3433 #
3434 #
3435 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3436 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3437 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3438 # encryption key that protects this resource.
3439 },
3440 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
3441 # instance boot disk, one of initializeParams.sourceSnapshot
3442 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
3443 # is required.
3444 #
3445 # To create a disk with a snapshot that you created, specify the
3446 # snapshot name in the following format:
3447 #
3448 # us-central1-a/instantSnapshots/my-backup
3449 #
3450 #
3451 # If the source instant-snapshot is deleted later, this field will not be
3452 # set.
3453 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
3454 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
3455 # is required.
3456 #
3457 # To create a disk with a snapshot that you created, specify the
3458 # snapshot name in the following format:
3459 #
3460 # global/snapshots/my-backup
3461 #
3462 #
3463 # If the source snapshot is deleted later, this field will not be set.
3464 #
3465 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
3466 # an image instead when you create VMs using
3467 # the bulk
3468 # insert method.
3469 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
3470 # encryption key of the source snapshot.
3471 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3472 # For example:
3473 #
3474 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3475 # key_region/cryptoKeys/key
3476 #
3477 # The fully-qualifed key name may be returned for resource GET requests. For
3478 # example:
3479 #
3480 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3481 # key_region/cryptoKeys/key
3482 # /cryptoKeyVersions/1
3483 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3484 # key. If absent, the Compute Engine default service account is used.
3485 # For example:
3486 #
3487 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3488 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3489 # encryption key, encoded in RFC
3490 # 4648 base64 to either encrypt or decrypt this resource. You can
3491 # provide either the rawKey or thersaEncryptedKey.
3492 # For example:
3493 #
3494 # &quot;rawKey&quot;:
3495 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3496 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3497 # customer-supplied encryption key to either encrypt or decrypt this
3498 # resource. You can provide either the rawKey or thersaEncryptedKey.
3499 # For example:
3500 #
3501 # &quot;rsaEncryptedKey&quot;:
3502 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3503 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3504 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3505 #
3506 # The key must meet the following requirements before you can provide it to
3507 # Compute Engine:
3508 #
3509 # 1. The key is wrapped using a RSA public key certificate provided by
3510 # Google.
3511 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3512 # encoding.
3513 #
3514 # Gets the RSA public key certificate provided by Google at:
3515 #
3516 #
3517 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3518 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3519 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3520 # encryption key that protects this resource.
3521 },
3522 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
3523 # this as a partial or full URL to the resource. For example, the following
3524 # are valid values:
3525 #
3526 #
3527 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
3528 # - projects/project/zones/zone/storagePools/storagePool
3529 # - zones/zone/storagePools/storagePool
3530 },
3531 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
3532 # either SCSI or NVME. For most machine types, the
3533 # default is SCSI. Local SSDs can use either NVME or SCSI.
3534 # In certain configurations, persistent disks can use NVMe. For more
3535 # information, seeAbout
3536 # persistent disks.
3537 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
3538 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
3539 &quot;A String&quot;,
3540 ],
3541 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
3542 # disk is not allowed to be detached from the instance, or to be used as the
3543 # source of the snapshot creation, and the image creation. The instance with
3544 # at least one locked attached disk is not allow to be used as source of
3545 # machine image creation, instant snapshot creation, and not allowed to be
3546 # deleted with --keep-disk parameter set to true for locked disks.
3547 &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
3548 # in READ_WRITE mode.
3549 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
3550 # field is set to PRESERVED if the LocalSSD data has been saved
3551 # to a persistent location by customer request. (see the
3552 # discard_local_ssd option on Stop/Suspend).
3553 # Read-only in the api.
3554 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
3555 # these are public keys which are safe to store in public
3556 &quot;dbs&quot;: [ # The Key Database (db).
3557 {
3558 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3559 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3560 },
3561 ],
3562 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
3563 {
3564 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3565 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3566 },
3567 ],
3568 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
3569 {
3570 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3571 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3572 },
3573 ],
3574 &quot;pk&quot;: { # The Platform Key (PK).
3575 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3576 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3577 },
3578 },
3579 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
3580 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3581 # is required.
3582 #
3583 # If desired, you can also attach existing non-root persistent disks using
3584 # this property. This field is only applicable for persistent disks.
3585 #
3586 # Note that for InstanceTemplate, specify the disk name for zonal disk,
3587 # and the URL for regional disk.
3588 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
3589 }
3590
3591 forceAttach: boolean, Whether to force attach the regional disk even if it&#x27;s currently attached
3592 to another instance. If you try to force attach a zonal disk to an
3593 instance, you will receive an error.
3594 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3595 that if you must retry your request, the server will know to ignore the
3596 request if it has already been completed.
3597
3598 For example, consider a situation where you make an initial request and
3599 the request times out. If you make the request again with the same
3600 request ID, the server can check if original operation with the same
3601 request ID was received, and if so, will ignore the second request. This
3602 prevents clients from accidentally creating duplicate commitments.
3603
3604 The request ID must be
3605 a valid UUID with the exception that zero UUID is not supported
3606 (00000000-0000-0000-0000-000000000000).
3607 x__xgafv: string, V1 error format.
3608 Allowed values
3609 1 - v1 error format
3610 2 - v2 error format
3611
3612 Returns:
3613 An object of the form:
3614
3615 { # Represents an Operation resource.
3616 #
3617 # Google Compute Engine has three Operation resources:
3618 #
3619 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
3620 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
3621 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
3622 #
3623 # You can use an operation resource to manage asynchronous API requests.
3624 # For more information, readHandling
3625 # API responses.
3626 #
3627 # Operations can be global, regional or zonal.
3628 #
3629 # - For global operations, use the `globalOperations`
3630 # resource.
3631 # - For regional operations, use the
3632 # `regionOperations` resource.
3633 # - For zonal operations, use
3634 # the `zoneOperations` resource.
3635 #
3636 #
3637 #
3638 # For more information, read
3639 # Global, Regional, and Zonal Resources.
3640 #
3641 # Note that completed Operation resources have a limited
3642 # retention period.
3643 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3644 # Not present otherwise.
3645 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3646 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3647 # set when the operation is created.
3648 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3649 # text format.
3650 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3651 # this field will be populated.
3652 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3653 # operation.
3654 {
3655 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3656 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3657 # details. There is a set of defined message types to use for providing
3658 # details.The syntax depends on the error code. For example,
3659 # QuotaExceededInfo will have details when the error code is
3660 # QUOTA_EXCEEDED.
3661 {
3662 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3663 #
3664 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3665 # is not enabled:
3666 #
3667 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3668 # &quot;domain&quot;: &quot;googleapis.com&quot;
3669 # &quot;metadata&quot;: {
3670 # &quot;resource&quot;: &quot;projects/123&quot;,
3671 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3672 # }
3673 # }
3674 #
3675 # This response indicates that the pubsub.googleapis.com API is not enabled.
3676 #
3677 # Example of an error that is returned when attempting to create a Spanner
3678 # instance in a region that is out of stock:
3679 #
3680 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3681 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3682 # &quot;metadata&quot;: {
3683 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3684 # }
3685 # }
3686 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3687 # is typically the registered service name of the tool or product that
3688 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3689 # generated by some common infrastructure, the error domain must be a
3690 # globally unique value that identifies the infrastructure. For Google API
3691 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3692 &quot;metadatas&quot;: { # Additional structured details about this error.
3693 #
3694 # Keys must match a regular expression of `a-z+` but should
3695 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3696 # length. When identifying the current value of an exceeded limit, the units
3697 # should be contained in the key, not the value. For example, rather than
3698 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3699 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3700 # instances that can be created in a single (batch) request.
3701 &quot;a_key&quot;: &quot;A String&quot;,
3702 },
3703 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3704 # proximate cause of the error. Error reasons are unique within a particular
3705 # domain of errors. This should be at most 63 characters and match a
3706 # regular expression of `A-Z+[A-Z0-9]`, which represents
3707 # UPPER_SNAKE_CASE.
3708 },
3709 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3710 #
3711 # For example, if a quota check failed with an error indicating the calling
3712 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3713 # directly to the right place in the developer console to flip the bit.
3714 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3715 { # Describes a URL link.
3716 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3717 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3718 },
3719 ],
3720 },
3721 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3722 # which can be attached to an RPC error.
3723 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3724 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3725 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3726 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3727 },
3728 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3729 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3730 &quot;a_key&quot;: &quot;A String&quot;,
3731 },
3732 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3733 # type or metric.
3734 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3735 # or metric.
3736 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3737 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3738 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3739 },
3740 },
3741 ],
3742 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3743 # This property is optional.
3744 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3745 },
3746 ],
3747 },
3748 &quot;getVersionOperationMetadata&quot;: {
3749 &quot;inlineSbomInfo&quot;: {
3750 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3751 # appropriate identifiers.
3752 &quot;a_key&quot;: &quot;A String&quot;,
3753 },
3754 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3755 # identifiers.
3756 &quot;a_key&quot;: &quot;A String&quot;,
3757 },
3758 },
3759 },
3760 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3761 # message that was returned, such as `NOT FOUND`.
3762 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3763 # status code that was returned. For example, a `404` means the
3764 # resource was not found.
3765 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3766 # defined by the server.
3767 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3768 # This value is inRFC3339
3769 # text format.
3770 &quot;instancesBulkInsertOperationMetadata&quot;: {
3771 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3772 # Example key: zones/us-central1-a
3773 &quot;a_key&quot;: {
3774 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3775 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3776 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3777 # error.
3778 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3779 # if the flow is rolling forward or rolling back.
3780 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3781 },
3782 },
3783 },
3784 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3785 # Operation resources.
3786 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3787 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3788 # group of operations results from a `bulkInsert` API request.
3789 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3790 # `update`, or `delete`, and so on.
3791 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3792 # There is no requirement that this be linear or support any granularity of
3793 # operations. This should not be used to guess when the operation will be
3794 # complete. This number should monotonically increase as the operation
3795 # progresses.
3796 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3797 # applicable when performing regional operations.
3798 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3799 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3800 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3801 # this field will contain information on all underlying zonal actions and
3802 # their state.
3803 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3804 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3805 # Example key: zones/us-central1-a
3806 &quot;a_key&quot;: {
3807 &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
3808 # populated.
3809 # different programming environments, including REST APIs and RPC APIs. It is
3810 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3811 # three pieces of data: error code, error message, and error details.
3812 #
3813 # You can find out more about this error model and how to work with it in the
3814 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3815 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3816 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3817 # message types for APIs to use.
3818 {
3819 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3820 },
3821 ],
3822 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3823 # user-facing error message should be localized and sent in the
3824 # google.rpc.Status.details field, or localized by the client.
3825 },
3826 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3827 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3828 },
3829 },
3830 },
3831 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3832 # This value is inRFC3339
3833 # text format.
3834 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3835 # following:
3836 # `PENDING`, `RUNNING`, or `DONE`.
3837 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3838 # operation.
3839 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3840 # of the target resource.
3841 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3842 # operations related to creating a snapshot, this points to the disk
3843 # that the snapshot was created from.
3844 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3845 # `[email protected]` or
3846 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3847 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3848 # operation, this field will be populated.
3849 {
3850 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3851 # Engine returns NO_RESULTS_ON_PAGE if there
3852 # are no results in the response.
3853 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3854 # value format. For example:
3855 #
3856 # &quot;data&quot;: [
3857 # {
3858 # &quot;key&quot;: &quot;scope&quot;,
3859 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3860 # }
3861 {
3862 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3863 # returned. For example, for warnings where there are no results in a list
3864 # request for a particular zone, this key might be scope and
3865 # the key value might be the zone name. Other examples might be a key
3866 # indicating a deprecated resource and a suggested replacement, or a
3867 # warning about invalid network settings (for example, if an instance
3868 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3869 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3870 },
3871 ],
3872 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3873 },
3874 ],
3875 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3876 # applicable when performing per-zone operations.
3877 }</pre>
3878 </div>
3879
3880 <div class="method">
3881 <code class="details" id="bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
3882 <pre>Creates multiple instances. Count specifies the number of instances to
3883 create. For more information, seeAbout bulk
3884 creation of VMs.
3885
3886 Args:
3887 project: string, Project ID for this request. (required)
3888 zone: string, The name of the zone for this request. (required)
3889 body: object, The request body.
3890 The object takes the form of:
3891
3892 { # A transient resource used in compute.instances.bulkInsert and
3893 # compute.regionInstances.bulkInsert . This resource is not persisted
3894 # anywhere, it is used only for processing the requests.
3895 &quot;count&quot;: &quot;A String&quot;, # The maximum number of instances to create.
3896 &quot;instanceFlexibilityPolicy&quot;: { # A flexible specification of machine types for instances to create. # A flexible specification of machine type of instances to create.
3897 &quot;instanceSelections&quot;: { # Specification of alternative, flexible instance subsets.
3898 # One of them will be selected to create the instances
3899 # based on various criteria, like:
3900 # - ranks,
3901 # - location policy,
3902 # - current capacity,
3903 # - available reservations (you can specify affinity in
3904 # InstanceProperties),
3905 # - SWAN/GOOSE limitations.
3906 # Key is an arbitrary, unique RFC1035 string that identifies the instance
3907 # selection.
3908 &quot;a_key&quot;: { # Specification of machine type to use. Every position inside this message
3909 # is an alternative.
3910 # The count specified in the shape flexibility must not exceed the number
3911 # of entries in per_instance_properties or the capacity of the
3912 # name_pattern, if used.
3913 &quot;disks&quot;: [ # Disks to be attached to the instances created from in this selection.
3914 # They override the disks specified in the instance properties.
3915 { # An instance-attached disk resource.
3916 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
3917 # or X86_64.
3918 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
3919 # deleted (but not when the disk is detached from the instance).
3920 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
3921 # partition of the disk for its root filesystem.
3922 &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
3923 # running within the instance. This name can be used to reference the device
3924 # for mounting, resizing, and so on, from within the instance.
3925 #
3926 # If not specified, the server chooses a default device name to apply to this
3927 # disk, in the form persistent-disk-x, where x is a number
3928 # assigned by Google Compute Engine. This field is only applicable for
3929 # persistent disks.
3930 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
3931 # encryption key.
3932 #
3933 # If you are creating a new disk, this field encrypts the new disk using
3934 # an encryption key that you provide. If you are attaching an existing
3935 # disk that is already encrypted, this field decrypts the disk using
3936 # the customer-supplied encryption key.
3937 #
3938 # If you encrypt a disk using a customer-supplied key, you must provide the
3939 # same key again when you attempt to use this resource at a later time. For
3940 # example, you must provide the key when you create a snapshot or an image
3941 # from the disk or when you attach the disk to a virtual machine instance.
3942 #
3943 # If you do not provide an encryption key, then the disk will be encrypted
3944 # using an automatically generated key and you do not need to provide a key
3945 # to use the disk later.
3946 #
3947 # Note:
3948 #
3949 # Instance templates do not storecustomer-supplied
3950 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
3951 #
3952 # You cannot create VMs that have disks with customer-supplied keys using
3953 # the bulk
3954 # insert method.
3955 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3956 # For example:
3957 #
3958 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3959 # key_region/cryptoKeys/key
3960 #
3961 # The fully-qualifed key name may be returned for resource GET requests. For
3962 # example:
3963 #
3964 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3965 # key_region/cryptoKeys/key
3966 # /cryptoKeyVersions/1
3967 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3968 # key. If absent, the Compute Engine default service account is used.
3969 # For example:
3970 #
3971 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3972 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3973 # encryption key, encoded in RFC
3974 # 4648 base64 to either encrypt or decrypt this resource. You can
3975 # provide either the rawKey or thersaEncryptedKey.
3976 # For example:
3977 #
3978 # &quot;rawKey&quot;:
3979 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3980 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3981 # customer-supplied encryption key to either encrypt or decrypt this
3982 # resource. You can provide either the rawKey or thersaEncryptedKey.
3983 # For example:
3984 #
3985 # &quot;rsaEncryptedKey&quot;:
3986 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3987 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3988 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3989 #
3990 # The key must meet the following requirements before you can provide it to
3991 # Compute Engine:
3992 #
3993 # 1. The key is wrapped using a RSA public key certificate provided by
3994 # Google.
3995 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3996 # encoding.
3997 #
3998 # Gets the RSA public key certificate provided by Google at:
3999 #
4000 #
4001 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4002 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4003 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4004 # encryption key that protects this resource.
4005 },
4006 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
4007 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
4008 # currently attached to another instance. If you try to force attach a zonal
4009 # disk to an instance, you will receive an error.
4010 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4011 # only for bootable images. Read
4012 # Enabling guest operating system features to see a list of available
4013 # options.
4014 { # Guest OS features.
4015 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4016 # separate values. Set to one or more of the following values:
4017 #
4018 # - VIRTIO_SCSI_MULTIQUEUE
4019 # - WINDOWS
4020 # - MULTI_IP_SUBNET
4021 # - UEFI_COMPATIBLE
4022 # - GVNIC
4023 # - SEV_CAPABLE
4024 # - SUSPEND_RESUME_COMPATIBLE
4025 # - SEV_LIVE_MIGRATABLE_V2
4026 # - SEV_SNP_CAPABLE
4027 # - TDX_CAPABLE
4028 # - IDPF
4029 # - SNP_SVSM_CAPABLE
4030 # - CCA_CAPABLE
4031 #
4032 #
4033 # For more information, see
4034 # Enabling guest operating system features.
4035 },
4036 ],
4037 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
4038 # boot disk. If you have many disks attached to an instance, each
4039 # disk would have a unique index number.
4040 &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
4041 # alongside the new instance. Use initialization parameters to create boot
4042 # disks or local SSDs attached to the new instance.
4043 #
4044 # This property is mutually exclusive with the source property;
4045 # you can only define one or the other, but not both.
4046 # alongside the new instance. Use initialization parameters to create boot
4047 # disks or local SSDs attached to the new instance.
4048 #
4049 # This field is persisted and returned for instanceTemplate and not returned
4050 # in the context of instance.
4051 #
4052 # This property is mutually exclusive with the source property;
4053 # you can only define one or the other, but not both.
4054 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
4055 # arm64 or x86_64.
4056 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
4057 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
4058 # of the instance. If a disk with the same name already exists in the given
4059 # region, the existing disk is attached to the new instance and the
4060 # new disk is not created.
4061 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
4062 # 10 GB. If you specify a sourceImage, which is required for
4063 # boot disks, the default size is the size of the sourceImage.
4064 # If you do not specify a sourceImage, the default disk size
4065 # is 500 GB.
4066 &quot;diskType&quot;: &quot;A String&quot;,
4067 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
4068 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4069 # only for bootable images. Read
4070 # Enabling guest operating system features to see a list of available
4071 # options.
4072 #
4073 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
4074 { # Guest OS features.
4075 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4076 # separate values. Set to one or more of the following values:
4077 #
4078 # - VIRTIO_SCSI_MULTIQUEUE
4079 # - WINDOWS
4080 # - MULTI_IP_SUBNET
4081 # - UEFI_COMPATIBLE
4082 # - GVNIC
4083 # - SEV_CAPABLE
4084 # - SUSPEND_RESUME_COMPATIBLE
4085 # - SEV_LIVE_MIGRATABLE_V2
4086 # - SEV_SNP_CAPABLE
4087 # - TDX_CAPABLE
4088 # - IDPF
4089 # - SNP_SVSM_CAPABLE
4090 # - CCA_CAPABLE
4091 #
4092 #
4093 # For more information, see
4094 # Enabling guest operating system features.
4095 },
4096 ],
4097 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
4098 # which is either SCSI or NVME. The default isSCSI.
4099 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
4100 # persistent disks.
4101 &quot;a_key&quot;: &quot;A String&quot;,
4102 },
4103 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
4104 # disk.
4105 &quot;A String&quot;,
4106 ],
4107 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
4108 &quot;A String&quot;,
4109 ],
4110 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
4111 # more than one instance.
4112 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
4113 # is to use the existing disk.
4114 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
4115 # of I/O operations per second that the disk can handle. Values must be
4116 # between 10,000 and 120,000. For more details, see theExtreme persistent
4117 # disk documentation.
4118 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
4119 # number of throughput mb per second that the disk can handle. Values must
4120 # greater than or equal to 1.
4121 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
4122 # the URLs of the zones where the disk should be replicated to.
4123 # You must provide exactly two replica zones, and one zone must be the same
4124 # as the instance zone.
4125 &quot;A String&quot;,
4126 ],
4127 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
4128 # have the same definition as resource
4129 # manager tags. Keys and values can be either in numeric format,
4130 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4131 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4132 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
4133 # empty.
4134 &quot;a_key&quot;: &quot;A String&quot;,
4135 },
4136 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
4137 # Specified using the full or partial URL. For instance template, specify
4138 # only the resource policy name.
4139 &quot;A String&quot;,
4140 ],
4141 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
4142 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4143 # is required.
4144 #
4145 # To create a disk with one of the public operating system
4146 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
4147 #
4148 # projects/debian-cloud/global/images/family/debian-9
4149 #
4150 #
4151 # Alternatively, use a specific version of a public operating system image:
4152 #
4153 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
4154 #
4155 #
4156 # To create a disk with a custom image that you created, specify the
4157 # image name in the following format:
4158 #
4159 # global/images/my-custom-image
4160 #
4161 #
4162 # You can also specify a custom image by its image family, which returns
4163 # the latest version of the image in that family. Replace the image name
4164 # with family/family-name:
4165 #
4166 # global/images/family/my-image-family
4167 #
4168 #
4169 # If the source image is deleted later, this field will not be set.
4170 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
4171 # encryption key of the source image. Required if the source image is
4172 # protected by a customer-supplied encryption key.
4173 #
4174 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
4175 # encryption keys, so you cannot create disks for instances in a managed instance group if the
4176 # source images are encrypted with your own keys.
4177 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4178 # For example:
4179 #
4180 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4181 # key_region/cryptoKeys/key
4182 #
4183 # The fully-qualifed key name may be returned for resource GET requests. For
4184 # example:
4185 #
4186 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4187 # key_region/cryptoKeys/key
4188 # /cryptoKeyVersions/1
4189 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4190 # key. If absent, the Compute Engine default service account is used.
4191 # For example:
4192 #
4193 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4194 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4195 # encryption key, encoded in RFC
4196 # 4648 base64 to either encrypt or decrypt this resource. You can
4197 # provide either the rawKey or thersaEncryptedKey.
4198 # For example:
4199 #
4200 # &quot;rawKey&quot;:
4201 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4202 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4203 # customer-supplied encryption key to either encrypt or decrypt this
4204 # resource. You can provide either the rawKey or thersaEncryptedKey.
4205 # For example:
4206 #
4207 # &quot;rsaEncryptedKey&quot;:
4208 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4209 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4210 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4211 #
4212 # The key must meet the following requirements before you can provide it to
4213 # Compute Engine:
4214 #
4215 # 1. The key is wrapped using a RSA public key certificate provided by
4216 # Google.
4217 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4218 # encoding.
4219 #
4220 # Gets the RSA public key certificate provided by Google at:
4221 #
4222 #
4223 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4224 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4225 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4226 # encryption key that protects this resource.
4227 },
4228 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
4229 # instance boot disk, one of initializeParams.sourceSnapshot
4230 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
4231 # is required.
4232 #
4233 # To create a disk with a snapshot that you created, specify the
4234 # snapshot name in the following format:
4235 #
4236 # us-central1-a/instantSnapshots/my-backup
4237 #
4238 #
4239 # If the source instant-snapshot is deleted later, this field will not be
4240 # set.
4241 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
4242 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
4243 # is required.
4244 #
4245 # To create a disk with a snapshot that you created, specify the
4246 # snapshot name in the following format:
4247 #
4248 # global/snapshots/my-backup
4249 #
4250 #
4251 # If the source snapshot is deleted later, this field will not be set.
4252 #
4253 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
4254 # an image instead when you create VMs using
4255 # the bulk
4256 # insert method.
4257 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
4258 # encryption key of the source snapshot.
4259 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4260 # For example:
4261 #
4262 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4263 # key_region/cryptoKeys/key
4264 #
4265 # The fully-qualifed key name may be returned for resource GET requests. For
4266 # example:
4267 #
4268 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4269 # key_region/cryptoKeys/key
4270 # /cryptoKeyVersions/1
4271 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4272 # key. If absent, the Compute Engine default service account is used.
4273 # For example:
4274 #
4275 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4276 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4277 # encryption key, encoded in RFC
4278 # 4648 base64 to either encrypt or decrypt this resource. You can
4279 # provide either the rawKey or thersaEncryptedKey.
4280 # For example:
4281 #
4282 # &quot;rawKey&quot;:
4283 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4284 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4285 # customer-supplied encryption key to either encrypt or decrypt this
4286 # resource. You can provide either the rawKey or thersaEncryptedKey.
4287 # For example:
4288 #
4289 # &quot;rsaEncryptedKey&quot;:
4290 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4291 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4292 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4293 #
4294 # The key must meet the following requirements before you can provide it to
4295 # Compute Engine:
4296 #
4297 # 1. The key is wrapped using a RSA public key certificate provided by
4298 # Google.
4299 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4300 # encoding.
4301 #
4302 # Gets the RSA public key certificate provided by Google at:
4303 #
4304 #
4305 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4306 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4307 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4308 # encryption key that protects this resource.
4309 },
4310 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
4311 # this as a partial or full URL to the resource. For example, the following
4312 # are valid values:
4313 #
4314 #
4315 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
4316 # - projects/project/zones/zone/storagePools/storagePool
4317 # - zones/zone/storagePools/storagePool
4318 },
4319 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
4320 # either SCSI or NVME. For most machine types, the
4321 # default is SCSI. Local SSDs can use either NVME or SCSI.
4322 # In certain configurations, persistent disks can use NVMe. For more
4323 # information, seeAbout
4324 # persistent disks.
4325 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
4326 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
4327 &quot;A String&quot;,
4328 ],
4329 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
4330 # disk is not allowed to be detached from the instance, or to be used as the
4331 # source of the snapshot creation, and the image creation. The instance with
4332 # at least one locked attached disk is not allow to be used as source of
4333 # machine image creation, instant snapshot creation, and not allowed to be
4334 # deleted with --keep-disk parameter set to true for locked disks.
4335 &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
4336 # in READ_WRITE mode.
4337 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
4338 # field is set to PRESERVED if the LocalSSD data has been saved
4339 # to a persistent location by customer request. (see the
4340 # discard_local_ssd option on Stop/Suspend).
4341 # Read-only in the api.
4342 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
4343 # these are public keys which are safe to store in public
4344 &quot;dbs&quot;: [ # The Key Database (db).
4345 {
4346 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4347 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4348 },
4349 ],
4350 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
4351 {
4352 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4353 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4354 },
4355 ],
4356 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
4357 {
4358 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4359 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4360 },
4361 ],
4362 &quot;pk&quot;: { # The Platform Key (PK).
4363 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4364 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4365 },
4366 },
4367 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
4368 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4369 # is required.
4370 #
4371 # If desired, you can also attach existing non-root persistent disks using
4372 # this property. This field is only applicable for persistent disks.
4373 #
4374 # Note that for InstanceTemplate, specify the disk name for zonal disk,
4375 # and the URL for regional disk.
4376 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
4377 },
4378 ],
4379 &quot;machineTypes&quot;: [ # Alternative machine types to use for instances that are created from
4380 # these properties. This field only accepts a machine type names, for
4381 # example `n2-standard-4` and not URLs or partial URLs.
4382 &quot;A String&quot;,
4383 ],
4384 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Name of the minimum CPU platform to be used by this instance selection.
4385 # e.g. &#x27;Intel Ice Lake&#x27;.
4386 &quot;rank&quot;: &quot;A String&quot;, # Rank when prioritizing the shape flexibilities.
4387 # The instance selections with rank are considered
4388 # first, in the ascending order of the rank.
4389 # If not set, defaults to 0.
4390 },
4391 },
4392 },
4393 &quot;instanceProperties&quot;: { # The instance properties defining the VM instances to be created. Required
4394 # if sourceInstanceTemplate is not provided.
4395 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
4396 # Note that for MachineImage, this is not supported yet.
4397 # Options that would traditionally be configured in a BIOS belong
4398 # here. Features that require operating system support may have
4399 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
4400 # disabled).
4401 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
4402 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
4403 &quot;enableWatchdogTimer&quot;: True or False, # Whether to enable the watchdog timer.
4404 &quot;numaNodeCount&quot;: 42, # The number of vNUMA nodes.
4405 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
4406 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
4407 # multithreading (SMT) set this to 1. If unset, the maximum number
4408 # of threads supported per core by the underlying processor is
4409 # assumed.
4410 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
4411 # Supported modes include:
4412 # * ALL_CORE_MAX
4413 #
4414 # Using empty string or not setting this field will use the platform-specific
4415 # default turbo mode.
4416 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
4417 # the number of threads per core to compute the total number of virtual
4418 # CPUs to expose to the instance. If unset, the number of cores is
4419 # inferred from the instance&#x27;s nominal CPU count and the underlying
4420 # platform&#x27;s SMT width.
4421 },
4422 &quot;canIpForward&quot;: True or False, # Enables instances created based on these properties to send packets with
4423 # source IP addresses other than their own and receive packets with
4424 # destination IP addresses other than their own. If these instances will be
4425 # used as an IP gateway or it will be set as the next-hop in a Route
4426 # resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding
4427 # documentation for more information.
4428 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
4429 # Note that for MachineImage, this is not supported yet.
4430 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
4431 &quot;confidentialParavisorConfig&quot;: { # A set of Confidential Paravisor (SVSM) options. # Defines a set of Confidential Paravisor (SVSM) options.
4432 &quot;confidentialTpmType&quot;: &quot;A String&quot;,
4433 &quot;sevSnpIrqMode&quot;: &quot;A String&quot;,
4434 },
4435 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
4436 },
4437 &quot;description&quot;: &quot;A String&quot;, # An optional text description for the instances that are created from these
4438 # properties.
4439 &quot;disks&quot;: [ # An array of disks that are associated with the instances that are created
4440 # from these properties.
4441 { # An instance-attached disk resource.
4442 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
4443 # or X86_64.
4444 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
4445 # deleted (but not when the disk is detached from the instance).
4446 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
4447 # partition of the disk for its root filesystem.
4448 &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
4449 # running within the instance. This name can be used to reference the device
4450 # for mounting, resizing, and so on, from within the instance.
4451 #
4452 # If not specified, the server chooses a default device name to apply to this
4453 # disk, in the form persistent-disk-x, where x is a number
4454 # assigned by Google Compute Engine. This field is only applicable for
4455 # persistent disks.
4456 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
4457 # encryption key.
4458 #
4459 # If you are creating a new disk, this field encrypts the new disk using
4460 # an encryption key that you provide. If you are attaching an existing
4461 # disk that is already encrypted, this field decrypts the disk using
4462 # the customer-supplied encryption key.
4463 #
4464 # If you encrypt a disk using a customer-supplied key, you must provide the
4465 # same key again when you attempt to use this resource at a later time. For
4466 # example, you must provide the key when you create a snapshot or an image
4467 # from the disk or when you attach the disk to a virtual machine instance.
4468 #
4469 # If you do not provide an encryption key, then the disk will be encrypted
4470 # using an automatically generated key and you do not need to provide a key
4471 # to use the disk later.
4472 #
4473 # Note:
4474 #
4475 # Instance templates do not storecustomer-supplied
4476 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
4477 #
4478 # You cannot create VMs that have disks with customer-supplied keys using
4479 # the bulk
4480 # insert method.
4481 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4482 # For example:
4483 #
4484 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4485 # key_region/cryptoKeys/key
4486 #
4487 # The fully-qualifed key name may be returned for resource GET requests. For
4488 # example:
4489 #
4490 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4491 # key_region/cryptoKeys/key
4492 # /cryptoKeyVersions/1
4493 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4494 # key. If absent, the Compute Engine default service account is used.
4495 # For example:
4496 #
4497 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4498 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4499 # encryption key, encoded in RFC
4500 # 4648 base64 to either encrypt or decrypt this resource. You can
4501 # provide either the rawKey or thersaEncryptedKey.
4502 # For example:
4503 #
4504 # &quot;rawKey&quot;:
4505 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4506 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4507 # customer-supplied encryption key to either encrypt or decrypt this
4508 # resource. You can provide either the rawKey or thersaEncryptedKey.
4509 # For example:
4510 #
4511 # &quot;rsaEncryptedKey&quot;:
4512 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4513 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4514 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4515 #
4516 # The key must meet the following requirements before you can provide it to
4517 # Compute Engine:
4518 #
4519 # 1. The key is wrapped using a RSA public key certificate provided by
4520 # Google.
4521 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4522 # encoding.
4523 #
4524 # Gets the RSA public key certificate provided by Google at:
4525 #
4526 #
4527 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4528 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4529 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4530 # encryption key that protects this resource.
4531 },
4532 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
4533 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
4534 # currently attached to another instance. If you try to force attach a zonal
4535 # disk to an instance, you will receive an error.
4536 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4537 # only for bootable images. Read
4538 # Enabling guest operating system features to see a list of available
4539 # options.
4540 { # Guest OS features.
4541 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4542 # separate values. Set to one or more of the following values:
4543 #
4544 # - VIRTIO_SCSI_MULTIQUEUE
4545 # - WINDOWS
4546 # - MULTI_IP_SUBNET
4547 # - UEFI_COMPATIBLE
4548 # - GVNIC
4549 # - SEV_CAPABLE
4550 # - SUSPEND_RESUME_COMPATIBLE
4551 # - SEV_LIVE_MIGRATABLE_V2
4552 # - SEV_SNP_CAPABLE
4553 # - TDX_CAPABLE
4554 # - IDPF
4555 # - SNP_SVSM_CAPABLE
4556 # - CCA_CAPABLE
4557 #
4558 #
4559 # For more information, see
4560 # Enabling guest operating system features.
4561 },
4562 ],
4563 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
4564 # boot disk. If you have many disks attached to an instance, each
4565 # disk would have a unique index number.
4566 &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
4567 # alongside the new instance. Use initialization parameters to create boot
4568 # disks or local SSDs attached to the new instance.
4569 #
4570 # This property is mutually exclusive with the source property;
4571 # you can only define one or the other, but not both.
4572 # alongside the new instance. Use initialization parameters to create boot
4573 # disks or local SSDs attached to the new instance.
4574 #
4575 # This field is persisted and returned for instanceTemplate and not returned
4576 # in the context of instance.
4577 #
4578 # This property is mutually exclusive with the source property;
4579 # you can only define one or the other, but not both.
4580 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
4581 # arm64 or x86_64.
4582 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
4583 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
4584 # of the instance. If a disk with the same name already exists in the given
4585 # region, the existing disk is attached to the new instance and the
4586 # new disk is not created.
4587 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
4588 # 10 GB. If you specify a sourceImage, which is required for
4589 # boot disks, the default size is the size of the sourceImage.
4590 # If you do not specify a sourceImage, the default disk size
4591 # is 500 GB.
4592 &quot;diskType&quot;: &quot;A String&quot;,
4593 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
4594 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4595 # only for bootable images. Read
4596 # Enabling guest operating system features to see a list of available
4597 # options.
4598 #
4599 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
4600 { # Guest OS features.
4601 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4602 # separate values. Set to one or more of the following values:
4603 #
4604 # - VIRTIO_SCSI_MULTIQUEUE
4605 # - WINDOWS
4606 # - MULTI_IP_SUBNET
4607 # - UEFI_COMPATIBLE
4608 # - GVNIC
4609 # - SEV_CAPABLE
4610 # - SUSPEND_RESUME_COMPATIBLE
4611 # - SEV_LIVE_MIGRATABLE_V2
4612 # - SEV_SNP_CAPABLE
4613 # - TDX_CAPABLE
4614 # - IDPF
4615 # - SNP_SVSM_CAPABLE
4616 # - CCA_CAPABLE
4617 #
4618 #
4619 # For more information, see
4620 # Enabling guest operating system features.
4621 },
4622 ],
4623 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
4624 # which is either SCSI or NVME. The default isSCSI.
4625 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
4626 # persistent disks.
4627 &quot;a_key&quot;: &quot;A String&quot;,
4628 },
4629 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
4630 # disk.
4631 &quot;A String&quot;,
4632 ],
4633 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
4634 &quot;A String&quot;,
4635 ],
4636 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
4637 # more than one instance.
4638 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
4639 # is to use the existing disk.
4640 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
4641 # of I/O operations per second that the disk can handle. Values must be
4642 # between 10,000 and 120,000. For more details, see theExtreme persistent
4643 # disk documentation.
4644 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
4645 # number of throughput mb per second that the disk can handle. Values must
4646 # greater than or equal to 1.
4647 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
4648 # the URLs of the zones where the disk should be replicated to.
4649 # You must provide exactly two replica zones, and one zone must be the same
4650 # as the instance zone.
4651 &quot;A String&quot;,
4652 ],
4653 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
4654 # have the same definition as resource
4655 # manager tags. Keys and values can be either in numeric format,
4656 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4657 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4658 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
4659 # empty.
4660 &quot;a_key&quot;: &quot;A String&quot;,
4661 },
4662 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
4663 # Specified using the full or partial URL. For instance template, specify
4664 # only the resource policy name.
4665 &quot;A String&quot;,
4666 ],
4667 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
4668 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4669 # is required.
4670 #
4671 # To create a disk with one of the public operating system
4672 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
4673 #
4674 # projects/debian-cloud/global/images/family/debian-9
4675 #
4676 #
4677 # Alternatively, use a specific version of a public operating system image:
4678 #
4679 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
4680 #
4681 #
4682 # To create a disk with a custom image that you created, specify the
4683 # image name in the following format:
4684 #
4685 # global/images/my-custom-image
4686 #
4687 #
4688 # You can also specify a custom image by its image family, which returns
4689 # the latest version of the image in that family. Replace the image name
4690 # with family/family-name:
4691 #
4692 # global/images/family/my-image-family
4693 #
4694 #
4695 # If the source image is deleted later, this field will not be set.
4696 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
4697 # encryption key of the source image. Required if the source image is
4698 # protected by a customer-supplied encryption key.
4699 #
4700 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
4701 # encryption keys, so you cannot create disks for instances in a managed instance group if the
4702 # source images are encrypted with your own keys.
4703 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4704 # For example:
4705 #
4706 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4707 # key_region/cryptoKeys/key
4708 #
4709 # The fully-qualifed key name may be returned for resource GET requests. For
4710 # example:
4711 #
4712 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4713 # key_region/cryptoKeys/key
4714 # /cryptoKeyVersions/1
4715 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4716 # key. If absent, the Compute Engine default service account is used.
4717 # For example:
4718 #
4719 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4720 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4721 # encryption key, encoded in RFC
4722 # 4648 base64 to either encrypt or decrypt this resource. You can
4723 # provide either the rawKey or thersaEncryptedKey.
4724 # For example:
4725 #
4726 # &quot;rawKey&quot;:
4727 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4728 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4729 # customer-supplied encryption key to either encrypt or decrypt this
4730 # resource. You can provide either the rawKey or thersaEncryptedKey.
4731 # For example:
4732 #
4733 # &quot;rsaEncryptedKey&quot;:
4734 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4735 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4736 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4737 #
4738 # The key must meet the following requirements before you can provide it to
4739 # Compute Engine:
4740 #
4741 # 1. The key is wrapped using a RSA public key certificate provided by
4742 # Google.
4743 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4744 # encoding.
4745 #
4746 # Gets the RSA public key certificate provided by Google at:
4747 #
4748 #
4749 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4750 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4751 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4752 # encryption key that protects this resource.
4753 },
4754 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
4755 # instance boot disk, one of initializeParams.sourceSnapshot
4756 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
4757 # is required.
4758 #
4759 # To create a disk with a snapshot that you created, specify the
4760 # snapshot name in the following format:
4761 #
4762 # us-central1-a/instantSnapshots/my-backup
4763 #
4764 #
4765 # If the source instant-snapshot is deleted later, this field will not be
4766 # set.
4767 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
4768 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
4769 # is required.
4770 #
4771 # To create a disk with a snapshot that you created, specify the
4772 # snapshot name in the following format:
4773 #
4774 # global/snapshots/my-backup
4775 #
4776 #
4777 # If the source snapshot is deleted later, this field will not be set.
4778 #
4779 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
4780 # an image instead when you create VMs using
4781 # the bulk
4782 # insert method.
4783 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
4784 # encryption key of the source snapshot.
4785 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4786 # For example:
4787 #
4788 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4789 # key_region/cryptoKeys/key
4790 #
4791 # The fully-qualifed key name may be returned for resource GET requests. For
4792 # example:
4793 #
4794 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4795 # key_region/cryptoKeys/key
4796 # /cryptoKeyVersions/1
4797 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4798 # key. If absent, the Compute Engine default service account is used.
4799 # For example:
4800 #
4801 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4802 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4803 # encryption key, encoded in RFC
4804 # 4648 base64 to either encrypt or decrypt this resource. You can
4805 # provide either the rawKey or thersaEncryptedKey.
4806 # For example:
4807 #
4808 # &quot;rawKey&quot;:
4809 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4810 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4811 # customer-supplied encryption key to either encrypt or decrypt this
4812 # resource. You can provide either the rawKey or thersaEncryptedKey.
4813 # For example:
4814 #
4815 # &quot;rsaEncryptedKey&quot;:
4816 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4817 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4818 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4819 #
4820 # The key must meet the following requirements before you can provide it to
4821 # Compute Engine:
4822 #
4823 # 1. The key is wrapped using a RSA public key certificate provided by
4824 # Google.
4825 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4826 # encoding.
4827 #
4828 # Gets the RSA public key certificate provided by Google at:
4829 #
4830 #
4831 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4832 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4833 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4834 # encryption key that protects this resource.
4835 },
4836 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
4837 # this as a partial or full URL to the resource. For example, the following
4838 # are valid values:
4839 #
4840 #
4841 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
4842 # - projects/project/zones/zone/storagePools/storagePool
4843 # - zones/zone/storagePools/storagePool
4844 },
4845 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
4846 # either SCSI or NVME. For most machine types, the
4847 # default is SCSI. Local SSDs can use either NVME or SCSI.
4848 # In certain configurations, persistent disks can use NVMe. For more
4849 # information, seeAbout
4850 # persistent disks.
4851 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
4852 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
4853 &quot;A String&quot;,
4854 ],
4855 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
4856 # disk is not allowed to be detached from the instance, or to be used as the
4857 # source of the snapshot creation, and the image creation. The instance with
4858 # at least one locked attached disk is not allow to be used as source of
4859 # machine image creation, instant snapshot creation, and not allowed to be
4860 # deleted with --keep-disk parameter set to true for locked disks.
4861 &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
4862 # in READ_WRITE mode.
4863 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
4864 # field is set to PRESERVED if the LocalSSD data has been saved
4865 # to a persistent location by customer request. (see the
4866 # discard_local_ssd option on Stop/Suspend).
4867 # Read-only in the api.
4868 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
4869 # these are public keys which are safe to store in public
4870 &quot;dbs&quot;: [ # The Key Database (db).
4871 {
4872 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4873 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4874 },
4875 ],
4876 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
4877 {
4878 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4879 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4880 },
4881 ],
4882 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
4883 {
4884 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4885 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4886 },
4887 ],
4888 &quot;pk&quot;: { # The Platform Key (PK).
4889 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4890 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4891 },
4892 },
4893 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
4894 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4895 # is required.
4896 #
4897 # If desired, you can also attach existing non-root persistent disks using
4898 # this property. This field is only applicable for persistent disks.
4899 #
4900 # Note that for InstanceTemplate, specify the disk name for zonal disk,
4901 # and the URL for regional disk.
4902 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
4903 },
4904 ],
4905 &quot;displayDevice&quot;: { # A set of Display Device options # Display Device properties to enable support
4906 # for remote display products like: Teradici,
4907 # VNC and TeamViewer
4908 # Note that for MachineImage, this is not supported yet.
4909 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
4910 },
4911 &quot;guestAccelerators&quot;: [ # A list of guest accelerator cards&#x27; type and count to use for instances
4912 # created from these properties.
4913 { # A specification of the type and number of accelerator cards attached to the
4914 # instance.
4915 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
4916 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
4917 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
4918 # If you are creating an instance template, specify only the
4919 # accelerator name.
4920 # See GPUs on Compute Engine
4921 # for a full list of accelerator types.
4922 },
4923 ],
4924 &quot;identity&quot;: &quot;A String&quot;,
4925 &quot;identityCertificate&quot;: True or False,
4926 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
4927 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
4928 &quot;labels&quot;: { # Labels to apply to instances that are created from these properties.
4929 &quot;a_key&quot;: &quot;A String&quot;,
4930 },
4931 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for instances that are created from these
4932 # properties.
4933 # This field only accepts a machine type name, for example `n2-standard-4`.
4934 # If you use the machine type full or partial URL, for example
4935 # `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
4936 # the request will result in an `INTERNAL_ERROR`.
4937 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
4938 # these properties. These pairs can consist of custom metadata or predefined
4939 # keys. SeeProject and
4940 # instance metadata for more information.
4941 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
4942 # the metadata&#x27;s contents and used for optimistic locking. The
4943 # fingerprint is initially generated by Compute Engine and changes after
4944 # every request to modify or update metadata. You must always provide an
4945 # up-to-date fingerprint hash in order to update or change metadata,
4946 # otherwise the request will fail with error412 conditionNotMet.
4947 #
4948 # To see the latest fingerprint, make a get() request to
4949 # retrieve the resource.
4950 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
4951 # less than 512 KB.
4952 { # Metadata
4953 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
4954 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
4955 # This is reflected as part of a URL in the metadata server. Additionally, to
4956 # avoid ambiguity, keys must not conflict with any other metadata keys
4957 # for the project.
4958 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
4959 # have meaning as interpreted by the image running in the instance. The
4960 # only restriction placed on values is that their size must be less than
4961 # or equal to 262144 bytes (256 KiB).
4962 },
4963 ],
4964 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
4965 # for metadata.
4966 },
4967 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform to be used by instances. The instance may be
4968 # scheduled on the specified or newer cpu/platform. Applicable values are the
4969 # friendly names of CPU platforms, such asminCpuPlatform: &quot;Intel Haswell&quot; orminCpuPlatform: &quot;Intel Sandy Bridge&quot;. For more
4970 # information, read Specifying a
4971 # Minimum CPU Platform.
4972 &quot;networkInterfaces&quot;: [ # An array of network access configurations for this interface.
4973 { # A network interface resource attached to an instance.
4974 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
4975 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
4976 # no external internet access.
4977 { # An access configuration attached to an instance&#x27;s network interface.
4978 # Only one access config per instance is supported.
4979 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
4980 # The first IPv6 address of the external IPv6 range associated
4981 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
4982 # use a static external IP address, it must be unused and in the same region
4983 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
4984 # assign an external IPv6 address from the instance&#x27;s subnetwork.
4985 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
4986 # external IPv6 range.
4987 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
4988 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
4989 # (IPv4), the default and recommended name is External NAT, but
4990 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
4991 # recommend name is External IPv6.
4992 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
4993 # address associated with this instance. Specify an unused static
4994 # external IP address available to the project or leave this field undefined
4995 # to use an IP from a shared ephemeral IP address pool. If you specify a
4996 # static external IP address, it must live in the same region as the zone of
4997 # the instance.
4998 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
4999 # configuration and can only take the following values: PREMIUM,STANDARD.
5000 #
5001 # If an AccessConfig is specified without a valid external IP address, an
5002 # ephemeral IP will be created with this networkTier.
5003 #
5004 # If an AccessConfig with a valid external IP address is specified, it must
5005 # match that of the networkTier associated with the Address resource owning
5006 # that IP.
5007 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
5008 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
5009 #
5010 # 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
5011 # first IP in associated external IPv6 range.
5012 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
5013 # config.
5014 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
5015 # external IP address of this access configuration.
5016 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
5017 # external IP address of the instance to a DNS domain name.
5018 #
5019 # This field is not used in ipv6AccessConfig. A default PTR
5020 # record will be created if the VM has external IPv6 range associated.
5021 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
5022 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
5023 },
5024 ],
5025 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
5026 # You can only specify this field for network interfaces in VPC networks.
5027 { # An alias IP range attached to an instance&#x27;s network interface.
5028 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
5029 # must belong to the specified subnetwork and cannot contain IP addresses
5030 # reserved by system or used by other network interfaces. This range may be
5031 # 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).
5032 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
5033 # alias range. If not specified, the primary range of the subnetwork is used.
5034 },
5035 ],
5036 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
5037 # You can only specify this field for network interfaces in VPC networks.
5038 { # An alias IP range attached to an instance&#x27;s network interface.
5039 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
5040 # must belong to the specified subnetwork and cannot contain IP addresses
5041 # reserved by system or used by other network interfaces. This range may be
5042 # 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).
5043 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
5044 # alias range. If not specified, the primary range of the subnetwork is used.
5045 },
5046 ],
5047 &quot;dns64Eligible&quot;: True or False, # If true, this network interface is eligible for DNS64.
5048 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
5049 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
5050 # with network_attachment.
5051 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
5052 # This field will be ignored when inserting an Instance or
5053 # adding a NetworkInterface. An up-to-date
5054 # 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.
5055 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
5056 # or not. If enabled, also indicates the version of IGMP supported.
5057 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
5058 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
5059 # one IPv6 access config, DIRECT_IPV6, is supported. If there
5060 # is no ipv6AccessConfig specified, then this instance will
5061 # have no external IPv6 Internet access.
5062 { # An access configuration attached to an instance&#x27;s network interface.
5063 # Only one access config per instance is supported.
5064 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
5065 # The first IPv6 address of the external IPv6 range associated
5066 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
5067 # use a static external IP address, it must be unused and in the same region
5068 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
5069 # assign an external IPv6 address from the instance&#x27;s subnetwork.
5070 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
5071 # external IPv6 range.
5072 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
5073 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
5074 # (IPv4), the default and recommended name is External NAT, but
5075 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
5076 # recommend name is External IPv6.
5077 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
5078 # address associated with this instance. Specify an unused static
5079 # external IP address available to the project or leave this field undefined
5080 # to use an IP from a shared ephemeral IP address pool. If you specify a
5081 # static external IP address, it must live in the same region as the zone of
5082 # the instance.
5083 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
5084 # configuration and can only take the following values: PREMIUM,STANDARD.
5085 #
5086 # If an AccessConfig is specified without a valid external IP address, an
5087 # ephemeral IP will be created with this networkTier.
5088 #
5089 # If an AccessConfig with a valid external IP address is specified, it must
5090 # match that of the networkTier associated with the Address resource owning
5091 # that IP.
5092 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
5093 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
5094 #
5095 # 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
5096 # first IP in associated external IPv6 range.
5097 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
5098 # config.
5099 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
5100 # external IP address of this access configuration.
5101 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
5102 # external IP address of the instance to a DNS domain name.
5103 #
5104 # This field is not used in ipv6AccessConfig. A default PTR
5105 # record will be created if the VM has external IPv6 range associated.
5106 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
5107 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
5108 },
5109 ],
5110 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
5111 # accessed from the Internet. This field is always inherited from its
5112 # subnetwork.
5113 #
5114 # Valid only if stackType is IPV4_IPV6.
5115 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
5116 # use a static internal IP address, it must be unused and in the same region
5117 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
5118 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
5119 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
5120 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
5121 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
5122 # server. For a VM, the network interface uses the nicN naming
5123 # format. Where N is a value between 0 and7. The default interface value is nic0.
5124 &quot;nat64Eligible&quot;: True or False, # If true, this network interface is eligible for NAT64.
5125 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
5126 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
5127 # instance, if neither the network nor the subnetwork is specified, the
5128 # default network global/networks/default is used. If the
5129 # selected project doesn&#x27;t have the default network, you must specify a
5130 # network or subnet. If the network is not specified but the subnetwork is
5131 # specified, the network is inferred.
5132 #
5133 # If you specify this property, you can specify the network as
5134 # a full or partial URL. For example, the following are all valid URLs:
5135 #
5136 #
5137 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
5138 # - projects/project/global/networks/network
5139 # - global/networks/default
5140 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
5141 # to in the following format:
5142 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
5143 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
5144 # interface. If not specified by the user, an unused internal IP is
5145 # assigned by the system.
5146 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
5147 # VirtioNet.
5148 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
5149 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
5150 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
5151 # if not specified by the users.
5152 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
5153 # interface. Can only be used with network_attachment. It is not possible to
5154 # use on its own however, network_attachment can be used without
5155 # service_class_id.
5156 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
5157 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
5158 #
5159 # This field can be both set at instance creation and update network
5160 # interface operations.
5161 &quot;subinterfaces&quot;: [ # SubInterfaces help enable L2 communication for the instance over
5162 # subnetworks that support L2. Every network interface will get a default
5163 # untagged (vlan not specified) subinterface. Users can specify additional
5164 # tagged subinterfaces which are sub-fields to the Network Interface.
5165 {
5166 &quot;ipAddress&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this
5167 # subinterface. If specified, ip_allocation_mode should be set to
5168 # ALLOCATE_IP.
5169 &quot;ipAllocationMode&quot;: &quot;A String&quot;,
5170 &quot;subnetwork&quot;: &quot;A String&quot;, # If specified, this subnetwork must belong to the same network
5171 # as that of the network interface.
5172 # If not specified the subnet of network interface will be used.
5173 # If you specify this property, you can specify the subnetwork as a full
5174 # or partial URL. For example, the following are all valid URLs:
5175 #
5176 #
5177 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
5178 # - regions/region/subnetworks/subnetwork
5179 &quot;vlan&quot;: 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which
5180 # this subinterface is connecting.
5181 },
5182 ],
5183 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
5184 # resource is inlegacy
5185 # mode, do not specify this field. If the network is in auto subnet
5186 # mode, specifying the subnetwork is optional. If the network is in custom
5187 # subnet mode, specifying the subnetwork is required. If you specify this
5188 # field, you can specify the subnetwork as a full or partial URL. For
5189 # example, the following are all valid URLs:
5190 #
5191 #
5192 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
5193 # - regions/region/subnetworks/subnetwork
5194 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
5195 # from 2 to 255 inclusively.
5196 },
5197 ],
5198 &quot;networkPerformanceConfig&quot;: { # Note that for MachineImage, this is not supported yet.
5199 &quot;externalIpEgressBandwidthTier&quot;: &quot;A String&quot;,
5200 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
5201 },
5202 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance properties. A map from a
5203 # subdomain (namespace) to entries map.
5204 &quot;a_key&quot;: {
5205 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
5206 # It accepts any value including google.protobuf.Struct.
5207 &quot;a_key&quot;: &quot;&quot;,
5208 },
5209 },
5210 },
5211 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
5212 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for VMs.
5213 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
5214 # Note that for MachineImage, this is not supported yet.
5215 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
5216 # Note that for MachineImage, this is not supported yet.
5217 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
5218 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
5219 # Consuming reserved instances for examples.
5220 &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
5221 # the name of your reservation as its value.
5222 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
5223 # either a name to a reservation in the same project or
5224 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
5225 # shared reservation in the same zone but in a different project.
5226 &quot;A String&quot;,
5227 ],
5228 },
5229 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
5230 # have the same definition as resource
5231 # manager tags. Keys and values can be either in numeric format,
5232 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
5233 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
5234 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
5235 # PATCH) when empty.
5236 &quot;a_key&quot;: &quot;A String&quot;,
5237 },
5238 &quot;resourcePolicies&quot;: [ # Resource policies (names, not URLs) applied to instances created from
5239 # these properties.
5240 # Note that for MachineImage, this is not supported yet.
5241 &quot;A String&quot;,
5242 ],
5243 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
5244 # these properties.
5245 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
5246 # terminated by Compute Engine (not terminated by a user). You can only set
5247 # the automatic restart option for standard instances.Preemptible instances
5248 # cannot be automatically restarted.
5249 #
5250 # By default, this is set to true so an instance is
5251 # automatically restarted if it is terminated by Compute Engine.
5252 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
5253 # must be a number between 1 and the number of availability domains
5254 # specified in the spread placement policy attached to the instance.
5255 &quot;currentCpus&quot;: 42, # Current number of vCPUs available for VM.
5256 # 0 or unset means default vCPUs of the current machine type.
5257 &quot;currentMemoryMb&quot;: &quot;A String&quot;, # Current amount of memory (in MB) available for VM.
5258 # 0 or unset means default amount of memory of the current machine type.
5259 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
5260 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
5261 &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
5262 # graceful shutdown isn&#x27;t complete after this time, then the instance
5263 # transitions to the STOPPING state.
5264 # as a count of seconds and fractions of seconds at nanosecond
5265 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5266 # or &quot;month&quot;. Range is approximately 10,000 years.
5267 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5268 # Durations less than one second are represented with a 0
5269 # `seconds` field and a positive `nanos` field. Must be from 0
5270 # to 999,999,999 inclusive.
5271 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5272 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5273 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5274 },
5275 },
5276 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
5277 # within the range of [90, 330] with the increment of 30, if unset, the
5278 # default behavior of host error recovery will be used.
5279 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
5280 &quot;latencyTolerant&quot;: True or False, # Defines whether the instance is tolerant of higher cpu latency. This can
5281 # only be set during instance creation, or when the instance is not currently
5282 # running. It must not be set if thepreemptible option is
5283 # also set.
5284 &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
5285 # recovery of the Local Ssd state is attempted. Its value should be in
5286 # between 0 and 168 hours with hour granularity and the default value being 1
5287 # hour.
5288 # as a count of seconds and fractions of seconds at nanosecond
5289 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5290 # or &quot;month&quot;. Range is approximately 10,000 years.
5291 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5292 # Durations less than one second are represented with a 0
5293 # `seconds` field and a positive `nanos` field. Must be from 0
5294 # to 999,999,999 inclusive.
5295 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5296 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5297 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5298 },
5299 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
5300 # resources.
5301 # This field is for use by internal tools that use the public API.
5302 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
5303 # be scheduled for maintenance.
5304 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
5305 # are: `PERIODIC`.
5306 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
5307 # the instance termination action will be performed at the end of the run
5308 # duration.
5309 # as a count of seconds and fractions of seconds at nanosecond
5310 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5311 # or &quot;month&quot;. Range is approximately 10,000 years.
5312 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5313 # Durations less than one second are represented with a 0
5314 # `seconds` field and a positive `nanos` field. Must be from 0
5315 # to 999,999,999 inclusive.
5316 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5317 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5318 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5319 },
5320 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
5321 # on a sole-tenant node.
5322 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
5323 # affinity for more information.
5324 # Overrides reservationAffinity.
5325 { # Node Affinity: the configuration of desired nodes onto which this Instance
5326 # could be scheduled.
5327 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
5328 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
5329 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
5330 &quot;A String&quot;,
5331 ],
5332 },
5333 ],
5334 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
5335 # the default behavior is MIGRATE. Forpreemptible instances,
5336 # the default and only possible behavior is TERMINATE. For more
5337 # information, see
5338 # Set
5339 # VM host maintenance policy.
5340 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
5341 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
5342 # else, the Local SSD data will be preserved when the instance is stopped
5343 # at the end of the run duration/termination time.
5344 },
5345 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
5346 # instance creation or while the instance isstopped and
5347 # therefore, in a `TERMINATED` state. SeeInstance Life
5348 # Cycle for more information on the possible instance states.
5349 &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
5350 # Off signal is triggered for Spot
5351 # VMs only. If not specified, there will be no wait before the G2 Soft
5352 # Off signal is triggered.
5353 # as a count of seconds and fractions of seconds at nanosecond
5354 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5355 # or &quot;month&quot;. Range is approximately 10,000 years.
5356 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5357 # Durations less than one second are represented with a 0
5358 # `seconds` field and a positive `nanos` field. Must be from 0
5359 # to 999,999,999 inclusive.
5360 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5361 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5362 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5363 },
5364 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
5365 &quot;shutdownTimeout&quot;: { # A Duration represents a fixed-length span of time represented # DEPRECATED: please use skipGuestOsShutdown.
5366 # Timeout between GCE ACPI G2 Soft
5367 # Off and ACPI G3 Mechanical
5368 # Off during shutdown operation of VM.
5369 #
5370 # For Standard VMs values between 0s and 120s are allowed. For Spot and
5371 # Preemptible VMs supported values are between 0s and 30s.
5372 #
5373 # If no value is specified for shutdownDuration, default values are 90s for
5374 # Standard VMs and 30s for Spot/Preemptible VMs.
5375 # as a count of seconds and fractions of seconds at nanosecond
5376 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5377 # or &quot;month&quot;. Range is approximately 10,000 years.
5378 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5379 # Durations less than one second are represented with a 0
5380 # `seconds` field and a positive `nanos` field. Must be from 0
5381 # to 999,999,999 inclusive.
5382 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5383 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5384 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5385 },
5386 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
5387 # Off and ACPI G3 Mechanical
5388 # Off for Standard VMs and 30 seconds for Spot VMs.
5389 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
5390 # termination action will be performed at the termination time.
5391 &quot;vsockMode&quot;: { # Message to control the enablement of the vsock device. # The vsock mode of the instance.
5392 &quot;mode&quot;: &quot;A String&quot;,
5393 },
5394 &quot;windowsLicenseOptimizationMode&quot;: &quot;A String&quot;, # Represents the Windows Server License Optimization Mode of the VM. If
5395 # unspecified, the default mode is `OFF`.
5396 },
5397 &quot;secureTags&quot;: [ # [Input Only] Secure tags to apply to this instance.
5398 # Maximum number of secure tags allowed is 50.
5399 # Note that for MachineImage, this is not supported yet.
5400 &quot;A String&quot;,
5401 ],
5402 &quot;serviceAccounts&quot;: [ # A list of service accounts with specified scopes. Access tokens for these
5403 # service accounts are available to the instances that are created from
5404 # these properties. Use metadata queries to obtain the access tokens for
5405 # these instances.
5406 { # A service account.
5407 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
5408 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
5409 &quot;A String&quot;,
5410 ],
5411 },
5412 ],
5413 &quot;serviceIntegrationSpecs&quot;: { # Mapping of user defined keys to ServiceIntegrationSpec.
5414 &quot;a_key&quot;: { # Specifies the parameters to configure an integration with instances.
5415 &quot;backupDr&quot;: { # Specifies parameters to Backup and DR to attach a BackupPlan to a compute
5416 # instance for managed VM backup.
5417 &quot;plan&quot;: &quot;A String&quot;, # The BackupPlan resource to attach to the instance. Specified as a
5418 # resource reference in instances, and regional instance templates, and as
5419 # just the plan name in global instance templates
5420 },
5421 },
5422 },
5423 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet.
5424 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
5425 # default.
5426 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
5427 # default.
5428 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
5429 # default.
5430 },
5431 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from
5432 # these properties.
5433 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
5434 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
5435 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
5436 },
5437 &quot;tags&quot;: { # A set of instance tags. # A list of tags to apply to the instances that are created from these
5438 # properties. The tags identify valid sources or targets for network
5439 # firewalls. The setTags method can modify this list of tags. Each tag within
5440 # the list must comply with RFC1035.
5441 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
5442 # the tags&#x27; contents and used for optimistic locking. The
5443 # fingerprint is initially generated by Compute Engine and changes after
5444 # every request to modify or update tags. You must always provide an
5445 # up-to-date fingerprint hash in order to update or change tags.
5446 #
5447 # To see the latest fingerprint, make get() request to the
5448 # instance.
5449 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
5450 # with RFC1035.
5451 &quot;A String&quot;,
5452 ],
5453 },
5454 &quot;workloadIdentityConfig&quot;: {
5455 &quot;identity&quot;: &quot;A String&quot;,
5456 &quot;identityCertificateEnabled&quot;: True or False,
5457 },
5458 },
5459 &quot;locationPolicy&quot;: { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
5460 # bulk.
5461 # (e.g. preferences for zone selection among zones in a single region).
5462 &quot;locations&quot;: { # Location configurations mapped by location name.
5463 # Currently only zone names are supported and must be represented as valid
5464 # internal URLs, such as zones/us-central1-a.
5465 # The bulkInsert operation doesn&#x27;t create instances in an AI zone, even if
5466 # an AI zone is available in the specified region. For example, if you set a
5467 # DENY preference for us-central1-a, Compute Engine will consider
5468 # us-central1-b and us-central1-c for instance creation, but not
5469 # us-central1-ai1a. Also, you can&#x27;t use the locations[] configuration to
5470 # allow instance creation in an AI zone. To include an AI zone in bulkInsert
5471 # operations, use the locationPolicy.zones[] field.
5472 &quot;a_key&quot;: {
5473 &quot;constraints&quot;: { # Per-zone constraints on location policy for this zone. # Constraints that the caller requires on the result distribution
5474 # in this zone.
5475 &quot;maxCount&quot;: 42, # Maximum number of items that are allowed to be placed in this zone.
5476 # The value must be non-negative.
5477 },
5478 &quot;names&quot;: [ # Names of resources to be put in the location.
5479 # Must contain unique, correct resource names.
5480 # If used, targetShape must be left unset.
5481 &quot;A String&quot;,
5482 ],
5483 &quot;preference&quot;: &quot;A String&quot;, # Preference for a given location. Set to either ALLOW orDENY.
5484 },
5485 },
5486 &quot;targetShape&quot;: &quot;A String&quot;, # Strategy for distributing VMs across zones in a region.
5487 &quot;zones&quot;: [ # The bulkInsert operation applies any preferences set in the locations
5488 # field to the specific zones listed in the zones field if the same zones
5489 # are specified in both fields.
5490 {
5491 &quot;zone&quot;: &quot;A String&quot;, # The URL of the zone.
5492 # The zone must exist in the region where the request is called.
5493 # Zones must be represented as valid partial URLs,
5494 # such as zones/us-central1-a.
5495 },
5496 ],
5497 },
5498 &quot;minCount&quot;: &quot;A String&quot;, # The minimum number of instances to create. If no min_count is
5499 # specified then count is used as the default value. Ifmin_count instances cannot be created, then no instances will
5500 # be created and instances already created will be deleted.
5501 &quot;namePattern&quot;: &quot;A String&quot;, # The string pattern used for the names of the VMs.
5502 # Either name_pattern or per_instance_properties
5503 # must be set. The pattern must contain one continuous sequence of
5504 # placeholder hash characters (#) with each character corresponding to one
5505 # digit of the generated instance name. Example: a name_pattern
5506 # of inst-#### generates instance names such asinst-0001 and inst-0002. If existing instances
5507 # in the same project and zone have names that match the name pattern
5508 # then the generated instance numbers start after the biggest
5509 # 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
5510 # placeholder #...# can contain up to 18 characters.
5511 &quot;perInstanceProperties&quot;: { # Per-instance properties to be set on individual instances.
5512 # Keys of this map specify requested instance names.
5513 # Can be empty if name_pattern is used.
5514 &quot;a_key&quot;: { # Per-instance properties to be set on individual instances.
5515 # To be extended in the future.
5516 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. More details in:
5517 # https://cloud.google.com/compute/docs/instances/custom-hostname-vm#naming_convention
5518 &quot;name&quot;: &quot;A String&quot;, # Output only. This field is only temporary. It will be removed. Do not use it.
5519 },
5520 },
5521 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template from which to create instances. You may
5522 # combine sourceInstanceTemplate withinstanceProperties to override specific values from an
5523 # existing instance template. Bulk API follows the semantics of JSON Merge
5524 # Patch described by RFC
5525 # 7396.
5526 #
5527 # It can be a full or partial URL. For example, the following are
5528 # all valid URLs to an instance template:
5529 #
5530 #
5531 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
5532 # - projects/project/global/instanceTemplates/instanceTemplate
5533 # - global/instanceTemplates/instanceTemplate
5534 #
5535 #
5536 #
5537 # This field is optional.
5538 }
5539
5540 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5541 that if you must retry your request, the server will know to ignore the
5542 request if it has already been completed.
5543
5544 For example, consider a situation where you make an initial request and
5545 the request times out. If you make the request again with the same
5546 request ID, the server can check if original operation with the same
5547 request ID was received, and if so, will ignore the second request. This
5548 prevents clients from accidentally creating duplicate commitments.
5549
5550 The request ID must be
5551 a valid UUID with the exception that zero UUID is not supported
5552 (00000000-0000-0000-0000-000000000000).
5553 x__xgafv: string, V1 error format.
5554 Allowed values
5555 1 - v1 error format
5556 2 - v2 error format
5557
5558 Returns:
5559 An object of the form:
5560
5561 { # Represents an Operation resource.
5562 #
5563 # Google Compute Engine has three Operation resources:
5564 #
5565 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
5566 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
5567 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
5568 #
5569 # You can use an operation resource to manage asynchronous API requests.
5570 # For more information, readHandling
5571 # API responses.
5572 #
5573 # Operations can be global, regional or zonal.
5574 #
5575 # - For global operations, use the `globalOperations`
5576 # resource.
5577 # - For regional operations, use the
5578 # `regionOperations` resource.
5579 # - For zonal operations, use
5580 # the `zoneOperations` resource.
5581 #
5582 #
5583 #
5584 # For more information, read
5585 # Global, Regional, and Zonal Resources.
5586 #
5587 # Note that completed Operation resources have a limited
5588 # retention period.
5589 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5590 # Not present otherwise.
5591 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5592 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5593 # set when the operation is created.
5594 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5595 # text format.
5596 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5597 # this field will be populated.
5598 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5599 # operation.
5600 {
5601 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5602 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5603 # details. There is a set of defined message types to use for providing
5604 # details.The syntax depends on the error code. For example,
5605 # QuotaExceededInfo will have details when the error code is
5606 # QUOTA_EXCEEDED.
5607 {
5608 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5609 #
5610 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5611 # is not enabled:
5612 #
5613 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5614 # &quot;domain&quot;: &quot;googleapis.com&quot;
5615 # &quot;metadata&quot;: {
5616 # &quot;resource&quot;: &quot;projects/123&quot;,
5617 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5618 # }
5619 # }
5620 #
5621 # This response indicates that the pubsub.googleapis.com API is not enabled.
5622 #
5623 # Example of an error that is returned when attempting to create a Spanner
5624 # instance in a region that is out of stock:
5625 #
5626 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5627 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5628 # &quot;metadata&quot;: {
5629 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5630 # }
5631 # }
5632 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5633 # is typically the registered service name of the tool or product that
5634 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5635 # generated by some common infrastructure, the error domain must be a
5636 # globally unique value that identifies the infrastructure. For Google API
5637 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5638 &quot;metadatas&quot;: { # Additional structured details about this error.
5639 #
5640 # Keys must match a regular expression of `a-z+` but should
5641 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5642 # length. When identifying the current value of an exceeded limit, the units
5643 # should be contained in the key, not the value. For example, rather than
5644 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5645 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5646 # instances that can be created in a single (batch) request.
5647 &quot;a_key&quot;: &quot;A String&quot;,
5648 },
5649 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5650 # proximate cause of the error. Error reasons are unique within a particular
5651 # domain of errors. This should be at most 63 characters and match a
5652 # regular expression of `A-Z+[A-Z0-9]`, which represents
5653 # UPPER_SNAKE_CASE.
5654 },
5655 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5656 #
5657 # For example, if a quota check failed with an error indicating the calling
5658 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5659 # directly to the right place in the developer console to flip the bit.
5660 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5661 { # Describes a URL link.
5662 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5663 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5664 },
5665 ],
5666 },
5667 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5668 # which can be attached to an RPC error.
5669 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5670 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5671 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5672 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5673 },
5674 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5675 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5676 &quot;a_key&quot;: &quot;A String&quot;,
5677 },
5678 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5679 # type or metric.
5680 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5681 # or metric.
5682 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5683 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5684 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5685 },
5686 },
5687 ],
5688 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5689 # This property is optional.
5690 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5691 },
5692 ],
5693 },
5694 &quot;getVersionOperationMetadata&quot;: {
5695 &quot;inlineSbomInfo&quot;: {
5696 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5697 # appropriate identifiers.
5698 &quot;a_key&quot;: &quot;A String&quot;,
5699 },
5700 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5701 # identifiers.
5702 &quot;a_key&quot;: &quot;A String&quot;,
5703 },
5704 },
5705 },
5706 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5707 # message that was returned, such as `NOT FOUND`.
5708 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5709 # status code that was returned. For example, a `404` means the
5710 # resource was not found.
5711 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5712 # defined by the server.
5713 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5714 # This value is inRFC3339
5715 # text format.
5716 &quot;instancesBulkInsertOperationMetadata&quot;: {
5717 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5718 # Example key: zones/us-central1-a
5719 &quot;a_key&quot;: {
5720 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5721 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5722 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5723 # error.
5724 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5725 # if the flow is rolling forward or rolling back.
5726 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5727 },
5728 },
5729 },
5730 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5731 # Operation resources.
5732 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5733 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5734 # group of operations results from a `bulkInsert` API request.
5735 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5736 # `update`, or `delete`, and so on.
5737 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5738 # There is no requirement that this be linear or support any granularity of
5739 # operations. This should not be used to guess when the operation will be
5740 # complete. This number should monotonically increase as the operation
5741 # progresses.
5742 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5743 # applicable when performing regional operations.
5744 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5745 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5746 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5747 # this field will contain information on all underlying zonal actions and
5748 # their state.
5749 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5750 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5751 # Example key: zones/us-central1-a
5752 &quot;a_key&quot;: {
5753 &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
5754 # populated.
5755 # different programming environments, including REST APIs and RPC APIs. It is
5756 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5757 # three pieces of data: error code, error message, and error details.
5758 #
5759 # You can find out more about this error model and how to work with it in the
5760 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5761 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5762 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5763 # message types for APIs to use.
5764 {
5765 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5766 },
5767 ],
5768 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5769 # user-facing error message should be localized and sent in the
5770 # google.rpc.Status.details field, or localized by the client.
5771 },
5772 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5773 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5774 },
5775 },
5776 },
5777 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5778 # This value is inRFC3339
5779 # text format.
5780 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5781 # following:
5782 # `PENDING`, `RUNNING`, or `DONE`.
5783 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5784 # operation.
5785 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5786 # of the target resource.
5787 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5788 # operations related to creating a snapshot, this points to the disk
5789 # that the snapshot was created from.
5790 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5791 # `[email protected]` or
5792 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5793 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5794 # operation, this field will be populated.
5795 {
5796 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5797 # Engine returns NO_RESULTS_ON_PAGE if there
5798 # are no results in the response.
5799 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5800 # value format. For example:
5801 #
5802 # &quot;data&quot;: [
5803 # {
5804 # &quot;key&quot;: &quot;scope&quot;,
5805 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5806 # }
5807 {
5808 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5809 # returned. For example, for warnings where there are no results in a list
5810 # request for a particular zone, this key might be scope and
5811 # the key value might be the zone name. Other examples might be a key
5812 # indicating a deprecated resource and a suggested replacement, or a
5813 # warning about invalid network settings (for example, if an instance
5814 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5815 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5816 },
5817 ],
5818 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5819 },
5820 ],
5821 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5822 # applicable when performing per-zone operations.
5823 }</pre>
5824 </div>
5825
5826 <div class="method">
5827 <code class="details" id="close">close()</code>
5828 <pre>Close httplib2 connections.</pre>
5829 </div>
5830
5831 <div class="method">
5832 <code class="details" id="delete">delete(project, zone, instance, noGracefulShutdown=None, requestId=None, x__xgafv=None)</code>
5833 <pre>Deletes the specified Instance resource. For more information, seeDeleting
5834 an instance.
5835
5836 Args:
5837 project: string, Project ID for this request. (required)
5838 zone: string, The name of the zone for this request. (required)
5839 instance: string, Name of the instance resource to delete. (required)
5840 noGracefulShutdown: boolean, If set to true, Graceful Shutdown is skipped.
5841 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5842 that if you must retry your request, the server will know to ignore the
5843 request if it has already been completed.
5844
5845 For example, consider a situation where you make an initial request and
5846 the request times out. If you make the request again with the same
5847 request ID, the server can check if original operation with the same
5848 request ID was received, and if so, will ignore the second request. This
5849 prevents clients from accidentally creating duplicate commitments.
5850
5851 The request ID must be
5852 a valid UUID with the exception that zero UUID is not supported
5853 (00000000-0000-0000-0000-000000000000).
5854 x__xgafv: string, V1 error format.
5855 Allowed values
5856 1 - v1 error format
5857 2 - v2 error format
5858
5859 Returns:
5860 An object of the form:
5861
5862 { # Represents an Operation resource.
5863 #
5864 # Google Compute Engine has three Operation resources:
5865 #
5866 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
5867 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
5868 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
5869 #
5870 # You can use an operation resource to manage asynchronous API requests.
5871 # For more information, readHandling
5872 # API responses.
5873 #
5874 # Operations can be global, regional or zonal.
5875 #
5876 # - For global operations, use the `globalOperations`
5877 # resource.
5878 # - For regional operations, use the
5879 # `regionOperations` resource.
5880 # - For zonal operations, use
5881 # the `zoneOperations` resource.
5882 #
5883 #
5884 #
5885 # For more information, read
5886 # Global, Regional, and Zonal Resources.
5887 #
5888 # Note that completed Operation resources have a limited
5889 # retention period.
5890 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5891 # Not present otherwise.
5892 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5893 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5894 # set when the operation is created.
5895 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5896 # text format.
5897 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5898 # this field will be populated.
5899 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5900 # operation.
5901 {
5902 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5903 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5904 # details. There is a set of defined message types to use for providing
5905 # details.The syntax depends on the error code. For example,
5906 # QuotaExceededInfo will have details when the error code is
5907 # QUOTA_EXCEEDED.
5908 {
5909 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5910 #
5911 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5912 # is not enabled:
5913 #
5914 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5915 # &quot;domain&quot;: &quot;googleapis.com&quot;
5916 # &quot;metadata&quot;: {
5917 # &quot;resource&quot;: &quot;projects/123&quot;,
5918 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5919 # }
5920 # }
5921 #
5922 # This response indicates that the pubsub.googleapis.com API is not enabled.
5923 #
5924 # Example of an error that is returned when attempting to create a Spanner
5925 # instance in a region that is out of stock:
5926 #
5927 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5928 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5929 # &quot;metadata&quot;: {
5930 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5931 # }
5932 # }
5933 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5934 # is typically the registered service name of the tool or product that
5935 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5936 # generated by some common infrastructure, the error domain must be a
5937 # globally unique value that identifies the infrastructure. For Google API
5938 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5939 &quot;metadatas&quot;: { # Additional structured details about this error.
5940 #
5941 # Keys must match a regular expression of `a-z+` but should
5942 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5943 # length. When identifying the current value of an exceeded limit, the units
5944 # should be contained in the key, not the value. For example, rather than
5945 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5946 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5947 # instances that can be created in a single (batch) request.
5948 &quot;a_key&quot;: &quot;A String&quot;,
5949 },
5950 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5951 # proximate cause of the error. Error reasons are unique within a particular
5952 # domain of errors. This should be at most 63 characters and match a
5953 # regular expression of `A-Z+[A-Z0-9]`, which represents
5954 # UPPER_SNAKE_CASE.
5955 },
5956 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5957 #
5958 # For example, if a quota check failed with an error indicating the calling
5959 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5960 # directly to the right place in the developer console to flip the bit.
5961 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5962 { # Describes a URL link.
5963 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5964 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5965 },
5966 ],
5967 },
5968 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5969 # which can be attached to an RPC error.
5970 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5971 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5972 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5973 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5974 },
5975 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5976 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5977 &quot;a_key&quot;: &quot;A String&quot;,
5978 },
5979 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5980 # type or metric.
5981 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5982 # or metric.
5983 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5984 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5985 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5986 },
5987 },
5988 ],
5989 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5990 # This property is optional.
5991 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5992 },
5993 ],
5994 },
5995 &quot;getVersionOperationMetadata&quot;: {
5996 &quot;inlineSbomInfo&quot;: {
5997 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5998 # appropriate identifiers.
5999 &quot;a_key&quot;: &quot;A String&quot;,
6000 },
6001 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6002 # identifiers.
6003 &quot;a_key&quot;: &quot;A String&quot;,
6004 },
6005 },
6006 },
6007 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6008 # message that was returned, such as `NOT FOUND`.
6009 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6010 # status code that was returned. For example, a `404` means the
6011 # resource was not found.
6012 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6013 # defined by the server.
6014 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6015 # This value is inRFC3339
6016 # text format.
6017 &quot;instancesBulkInsertOperationMetadata&quot;: {
6018 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6019 # Example key: zones/us-central1-a
6020 &quot;a_key&quot;: {
6021 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6022 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6023 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6024 # error.
6025 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6026 # if the flow is rolling forward or rolling back.
6027 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6028 },
6029 },
6030 },
6031 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6032 # Operation resources.
6033 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6034 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6035 # group of operations results from a `bulkInsert` API request.
6036 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6037 # `update`, or `delete`, and so on.
6038 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6039 # There is no requirement that this be linear or support any granularity of
6040 # operations. This should not be used to guess when the operation will be
6041 # complete. This number should monotonically increase as the operation
6042 # progresses.
6043 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6044 # applicable when performing regional operations.
6045 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6046 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6047 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6048 # this field will contain information on all underlying zonal actions and
6049 # their state.
6050 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6051 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6052 # Example key: zones/us-central1-a
6053 &quot;a_key&quot;: {
6054 &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
6055 # populated.
6056 # different programming environments, including REST APIs and RPC APIs. It is
6057 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6058 # three pieces of data: error code, error message, and error details.
6059 #
6060 # You can find out more about this error model and how to work with it in the
6061 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6062 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6063 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6064 # message types for APIs to use.
6065 {
6066 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6067 },
6068 ],
6069 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6070 # user-facing error message should be localized and sent in the
6071 # google.rpc.Status.details field, or localized by the client.
6072 },
6073 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6074 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6075 },
6076 },
6077 },
6078 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6079 # This value is inRFC3339
6080 # text format.
6081 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6082 # following:
6083 # `PENDING`, `RUNNING`, or `DONE`.
6084 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6085 # operation.
6086 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6087 # of the target resource.
6088 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6089 # operations related to creating a snapshot, this points to the disk
6090 # that the snapshot was created from.
6091 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6092 # `[email protected]` or
6093 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6094 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6095 # operation, this field will be populated.
6096 {
6097 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6098 # Engine returns NO_RESULTS_ON_PAGE if there
6099 # are no results in the response.
6100 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6101 # value format. For example:
6102 #
6103 # &quot;data&quot;: [
6104 # {
6105 # &quot;key&quot;: &quot;scope&quot;,
6106 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6107 # }
6108 {
6109 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6110 # returned. For example, for warnings where there are no results in a list
6111 # request for a particular zone, this key might be scope and
6112 # the key value might be the zone name. Other examples might be a key
6113 # indicating a deprecated resource and a suggested replacement, or a
6114 # warning about invalid network settings (for example, if an instance
6115 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6116 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6117 },
6118 ],
6119 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6120 },
6121 ],
6122 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6123 # applicable when performing per-zone operations.
6124 }</pre>
6125 </div>
6126
6127 <div class="method">
6128 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</code>
6129 <pre>Deletes an access config from an instance&#x27;s network interface.
6130
6131 Args:
6132 project: string, Project ID for this request. (required)
6133 zone: string, The name of the zone for this request. (required)
6134 instance: string, The instance name for this request. (required)
6135 accessConfig: string, The name of the access config to delete. (required)
6136 networkInterface: string, The name of the network interface. (required)
6137 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6138 that if you must retry your request, the server will know to ignore the
6139 request if it has already been completed.
6140
6141 For example, consider a situation where you make an initial request and
6142 the request times out. If you make the request again with the same
6143 request ID, the server can check if original operation with the same
6144 request ID was received, and if so, will ignore the second request. This
6145 prevents clients from accidentally creating duplicate commitments.
6146
6147 The request ID must be
6148 a valid UUID with the exception that zero UUID is not supported
6149 (00000000-0000-0000-0000-000000000000).
6150 x__xgafv: string, V1 error format.
6151 Allowed values
6152 1 - v1 error format
6153 2 - v2 error format
6154
6155 Returns:
6156 An object of the form:
6157
6158 { # Represents an Operation resource.
6159 #
6160 # Google Compute Engine has three Operation resources:
6161 #
6162 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6163 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6164 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6165 #
6166 # You can use an operation resource to manage asynchronous API requests.
6167 # For more information, readHandling
6168 # API responses.
6169 #
6170 # Operations can be global, regional or zonal.
6171 #
6172 # - For global operations, use the `globalOperations`
6173 # resource.
6174 # - For regional operations, use the
6175 # `regionOperations` resource.
6176 # - For zonal operations, use
6177 # the `zoneOperations` resource.
6178 #
6179 #
6180 #
6181 # For more information, read
6182 # Global, Regional, and Zonal Resources.
6183 #
6184 # Note that completed Operation resources have a limited
6185 # retention period.
6186 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6187 # Not present otherwise.
6188 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6189 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6190 # set when the operation is created.
6191 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6192 # text format.
6193 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6194 # this field will be populated.
6195 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6196 # operation.
6197 {
6198 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6199 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6200 # details. There is a set of defined message types to use for providing
6201 # details.The syntax depends on the error code. For example,
6202 # QuotaExceededInfo will have details when the error code is
6203 # QUOTA_EXCEEDED.
6204 {
6205 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6206 #
6207 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6208 # is not enabled:
6209 #
6210 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6211 # &quot;domain&quot;: &quot;googleapis.com&quot;
6212 # &quot;metadata&quot;: {
6213 # &quot;resource&quot;: &quot;projects/123&quot;,
6214 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6215 # }
6216 # }
6217 #
6218 # This response indicates that the pubsub.googleapis.com API is not enabled.
6219 #
6220 # Example of an error that is returned when attempting to create a Spanner
6221 # instance in a region that is out of stock:
6222 #
6223 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6224 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6225 # &quot;metadata&quot;: {
6226 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6227 # }
6228 # }
6229 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6230 # is typically the registered service name of the tool or product that
6231 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6232 # generated by some common infrastructure, the error domain must be a
6233 # globally unique value that identifies the infrastructure. For Google API
6234 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6235 &quot;metadatas&quot;: { # Additional structured details about this error.
6236 #
6237 # Keys must match a regular expression of `a-z+` but should
6238 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6239 # length. When identifying the current value of an exceeded limit, the units
6240 # should be contained in the key, not the value. For example, rather than
6241 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6242 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6243 # instances that can be created in a single (batch) request.
6244 &quot;a_key&quot;: &quot;A String&quot;,
6245 },
6246 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6247 # proximate cause of the error. Error reasons are unique within a particular
6248 # domain of errors. This should be at most 63 characters and match a
6249 # regular expression of `A-Z+[A-Z0-9]`, which represents
6250 # UPPER_SNAKE_CASE.
6251 },
6252 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6253 #
6254 # For example, if a quota check failed with an error indicating the calling
6255 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6256 # directly to the right place in the developer console to flip the bit.
6257 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6258 { # Describes a URL link.
6259 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6260 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6261 },
6262 ],
6263 },
6264 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6265 # which can be attached to an RPC error.
6266 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6267 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6268 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6269 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6270 },
6271 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6272 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6273 &quot;a_key&quot;: &quot;A String&quot;,
6274 },
6275 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6276 # type or metric.
6277 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6278 # or metric.
6279 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6280 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6281 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6282 },
6283 },
6284 ],
6285 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6286 # This property is optional.
6287 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6288 },
6289 ],
6290 },
6291 &quot;getVersionOperationMetadata&quot;: {
6292 &quot;inlineSbomInfo&quot;: {
6293 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6294 # appropriate identifiers.
6295 &quot;a_key&quot;: &quot;A String&quot;,
6296 },
6297 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6298 # identifiers.
6299 &quot;a_key&quot;: &quot;A String&quot;,
6300 },
6301 },
6302 },
6303 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6304 # message that was returned, such as `NOT FOUND`.
6305 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6306 # status code that was returned. For example, a `404` means the
6307 # resource was not found.
6308 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6309 # defined by the server.
6310 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6311 # This value is inRFC3339
6312 # text format.
6313 &quot;instancesBulkInsertOperationMetadata&quot;: {
6314 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6315 # Example key: zones/us-central1-a
6316 &quot;a_key&quot;: {
6317 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6318 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6319 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6320 # error.
6321 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6322 # if the flow is rolling forward or rolling back.
6323 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6324 },
6325 },
6326 },
6327 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6328 # Operation resources.
6329 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6330 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6331 # group of operations results from a `bulkInsert` API request.
6332 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6333 # `update`, or `delete`, and so on.
6334 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6335 # There is no requirement that this be linear or support any granularity of
6336 # operations. This should not be used to guess when the operation will be
6337 # complete. This number should monotonically increase as the operation
6338 # progresses.
6339 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6340 # applicable when performing regional operations.
6341 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6342 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6343 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6344 # this field will contain information on all underlying zonal actions and
6345 # their state.
6346 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6347 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6348 # Example key: zones/us-central1-a
6349 &quot;a_key&quot;: {
6350 &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
6351 # populated.
6352 # different programming environments, including REST APIs and RPC APIs. It is
6353 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6354 # three pieces of data: error code, error message, and error details.
6355 #
6356 # You can find out more about this error model and how to work with it in the
6357 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6358 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6359 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6360 # message types for APIs to use.
6361 {
6362 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6363 },
6364 ],
6365 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6366 # user-facing error message should be localized and sent in the
6367 # google.rpc.Status.details field, or localized by the client.
6368 },
6369 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6370 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6371 },
6372 },
6373 },
6374 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6375 # This value is inRFC3339
6376 # text format.
6377 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6378 # following:
6379 # `PENDING`, `RUNNING`, or `DONE`.
6380 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6381 # operation.
6382 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6383 # of the target resource.
6384 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6385 # operations related to creating a snapshot, this points to the disk
6386 # that the snapshot was created from.
6387 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6388 # `[email protected]` or
6389 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6390 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6391 # operation, this field will be populated.
6392 {
6393 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6394 # Engine returns NO_RESULTS_ON_PAGE if there
6395 # are no results in the response.
6396 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6397 # value format. For example:
6398 #
6399 # &quot;data&quot;: [
6400 # {
6401 # &quot;key&quot;: &quot;scope&quot;,
6402 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6403 # }
6404 {
6405 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6406 # returned. For example, for warnings where there are no results in a list
6407 # request for a particular zone, this key might be scope and
6408 # the key value might be the zone name. Other examples might be a key
6409 # indicating a deprecated resource and a suggested replacement, or a
6410 # warning about invalid network settings (for example, if an instance
6411 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6412 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6413 },
6414 ],
6415 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6416 },
6417 ],
6418 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6419 # applicable when performing per-zone operations.
6420 }</pre>
6421 </div>
6422
6423 <div class="method">
6424 <code class="details" id="deleteNetworkInterface">deleteNetworkInterface(project, zone, instance, networkInterfaceName, requestId=None, x__xgafv=None)</code>
6425 <pre>Deletes one dynamic network interface from an active instance.
6426 InstancesDeleteNetworkInterfaceRequest indicates:
6427 - instance from which to delete, using project+zone+resource_id fields;
6428 - dynamic network interface to be deleted, using network_interface_name
6429 field;
6430
6431 Args:
6432 project: string, Project ID for this request. (required)
6433 zone: string, The name of the zone for this request. (required)
6434 instance: string, The instance name for this request stored as resource_id.
6435 Name should conform to RFC1035 or be an unsigned long integer. (required)
6436 networkInterfaceName: string, The name of the dynamic network interface to be deleted from the instance. (required)
6437 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6438 that if you must retry your request, the server will know to ignore the
6439 request if it has already been completed.
6440
6441 For example, consider a situation where you make an initial request and
6442 the request times out. If you make the request again with the same
6443 request ID, the server can check if original operation with the same
6444 request ID was received, and if so, will ignore the second request. This
6445 prevents clients from accidentally creating duplicate commitments.
6446
6447 The request ID must be
6448 a valid UUID with the exception that zero UUID is not supported
6449 (00000000-0000-0000-0000-000000000000).
6450 x__xgafv: string, V1 error format.
6451 Allowed values
6452 1 - v1 error format
6453 2 - v2 error format
6454
6455 Returns:
6456 An object of the form:
6457
6458 { # Represents an Operation resource.
6459 #
6460 # Google Compute Engine has three Operation resources:
6461 #
6462 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6463 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6464 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6465 #
6466 # You can use an operation resource to manage asynchronous API requests.
6467 # For more information, readHandling
6468 # API responses.
6469 #
6470 # Operations can be global, regional or zonal.
6471 #
6472 # - For global operations, use the `globalOperations`
6473 # resource.
6474 # - For regional operations, use the
6475 # `regionOperations` resource.
6476 # - For zonal operations, use
6477 # the `zoneOperations` resource.
6478 #
6479 #
6480 #
6481 # For more information, read
6482 # Global, Regional, and Zonal Resources.
6483 #
6484 # Note that completed Operation resources have a limited
6485 # retention period.
6486 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6487 # Not present otherwise.
6488 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6489 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6490 # set when the operation is created.
6491 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6492 # text format.
6493 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6494 # this field will be populated.
6495 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6496 # operation.
6497 {
6498 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6499 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6500 # details. There is a set of defined message types to use for providing
6501 # details.The syntax depends on the error code. For example,
6502 # QuotaExceededInfo will have details when the error code is
6503 # QUOTA_EXCEEDED.
6504 {
6505 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6506 #
6507 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6508 # is not enabled:
6509 #
6510 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6511 # &quot;domain&quot;: &quot;googleapis.com&quot;
6512 # &quot;metadata&quot;: {
6513 # &quot;resource&quot;: &quot;projects/123&quot;,
6514 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6515 # }
6516 # }
6517 #
6518 # This response indicates that the pubsub.googleapis.com API is not enabled.
6519 #
6520 # Example of an error that is returned when attempting to create a Spanner
6521 # instance in a region that is out of stock:
6522 #
6523 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6524 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6525 # &quot;metadata&quot;: {
6526 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6527 # }
6528 # }
6529 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6530 # is typically the registered service name of the tool or product that
6531 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6532 # generated by some common infrastructure, the error domain must be a
6533 # globally unique value that identifies the infrastructure. For Google API
6534 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6535 &quot;metadatas&quot;: { # Additional structured details about this error.
6536 #
6537 # Keys must match a regular expression of `a-z+` but should
6538 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6539 # length. When identifying the current value of an exceeded limit, the units
6540 # should be contained in the key, not the value. For example, rather than
6541 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6542 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6543 # instances that can be created in a single (batch) request.
6544 &quot;a_key&quot;: &quot;A String&quot;,
6545 },
6546 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6547 # proximate cause of the error. Error reasons are unique within a particular
6548 # domain of errors. This should be at most 63 characters and match a
6549 # regular expression of `A-Z+[A-Z0-9]`, which represents
6550 # UPPER_SNAKE_CASE.
6551 },
6552 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6553 #
6554 # For example, if a quota check failed with an error indicating the calling
6555 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6556 # directly to the right place in the developer console to flip the bit.
6557 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6558 { # Describes a URL link.
6559 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6560 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6561 },
6562 ],
6563 },
6564 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6565 # which can be attached to an RPC error.
6566 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6567 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6568 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6569 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6570 },
6571 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6572 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6573 &quot;a_key&quot;: &quot;A String&quot;,
6574 },
6575 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6576 # type or metric.
6577 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6578 # or metric.
6579 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6580 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6581 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6582 },
6583 },
6584 ],
6585 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6586 # This property is optional.
6587 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6588 },
6589 ],
6590 },
6591 &quot;getVersionOperationMetadata&quot;: {
6592 &quot;inlineSbomInfo&quot;: {
6593 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6594 # appropriate identifiers.
6595 &quot;a_key&quot;: &quot;A String&quot;,
6596 },
6597 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6598 # identifiers.
6599 &quot;a_key&quot;: &quot;A String&quot;,
6600 },
6601 },
6602 },
6603 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6604 # message that was returned, such as `NOT FOUND`.
6605 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6606 # status code that was returned. For example, a `404` means the
6607 # resource was not found.
6608 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6609 # defined by the server.
6610 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6611 # This value is inRFC3339
6612 # text format.
6613 &quot;instancesBulkInsertOperationMetadata&quot;: {
6614 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6615 # Example key: zones/us-central1-a
6616 &quot;a_key&quot;: {
6617 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6618 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6619 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6620 # error.
6621 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6622 # if the flow is rolling forward or rolling back.
6623 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6624 },
6625 },
6626 },
6627 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6628 # Operation resources.
6629 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6630 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6631 # group of operations results from a `bulkInsert` API request.
6632 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6633 # `update`, or `delete`, and so on.
6634 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6635 # There is no requirement that this be linear or support any granularity of
6636 # operations. This should not be used to guess when the operation will be
6637 # complete. This number should monotonically increase as the operation
6638 # progresses.
6639 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6640 # applicable when performing regional operations.
6641 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6642 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6643 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6644 # this field will contain information on all underlying zonal actions and
6645 # their state.
6646 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6647 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6648 # Example key: zones/us-central1-a
6649 &quot;a_key&quot;: {
6650 &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
6651 # populated.
6652 # different programming environments, including REST APIs and RPC APIs. It is
6653 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6654 # three pieces of data: error code, error message, and error details.
6655 #
6656 # You can find out more about this error model and how to work with it in the
6657 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6658 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6659 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6660 # message types for APIs to use.
6661 {
6662 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6663 },
6664 ],
6665 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6666 # user-facing error message should be localized and sent in the
6667 # google.rpc.Status.details field, or localized by the client.
6668 },
6669 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6670 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6671 },
6672 },
6673 },
6674 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6675 # This value is inRFC3339
6676 # text format.
6677 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6678 # following:
6679 # `PENDING`, `RUNNING`, or `DONE`.
6680 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6681 # operation.
6682 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6683 # of the target resource.
6684 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6685 # operations related to creating a snapshot, this points to the disk
6686 # that the snapshot was created from.
6687 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6688 # `[email protected]` or
6689 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6690 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6691 # operation, this field will be populated.
6692 {
6693 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6694 # Engine returns NO_RESULTS_ON_PAGE if there
6695 # are no results in the response.
6696 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6697 # value format. For example:
6698 #
6699 # &quot;data&quot;: [
6700 # {
6701 # &quot;key&quot;: &quot;scope&quot;,
6702 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6703 # }
6704 {
6705 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6706 # returned. For example, for warnings where there are no results in a list
6707 # request for a particular zone, this key might be scope and
6708 # the key value might be the zone name. Other examples might be a key
6709 # indicating a deprecated resource and a suggested replacement, or a
6710 # warning about invalid network settings (for example, if an instance
6711 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6712 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6713 },
6714 ],
6715 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6716 },
6717 ],
6718 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6719 # applicable when performing per-zone operations.
6720 }</pre>
6721 </div>
6722
6723 <div class="method">
6724 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</code>
6725 <pre>Detaches a disk from an instance.
6726
6727 Args:
6728 project: string, Project ID for this request. (required)
6729 zone: string, The name of the zone for this request. (required)
6730 instance: string, Instance name for this request. (required)
6731 deviceName: string, The device name of the disk to detach. Make a get() request on
6732 the instance to view currently attached disks and device names. (required)
6733 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6734 that if you must retry your request, the server will know to ignore the
6735 request if it has already been completed.
6736
6737 For example, consider a situation where you make an initial request and
6738 the request times out. If you make the request again with the same
6739 request ID, the server can check if original operation with the same
6740 request ID was received, and if so, will ignore the second request. This
6741 prevents clients from accidentally creating duplicate commitments.
6742
6743 The request ID must be
6744 a valid UUID with the exception that zero UUID is not supported
6745 (00000000-0000-0000-0000-000000000000).
6746 x__xgafv: string, V1 error format.
6747 Allowed values
6748 1 - v1 error format
6749 2 - v2 error format
6750
6751 Returns:
6752 An object of the form:
6753
6754 { # Represents an Operation resource.
6755 #
6756 # Google Compute Engine has three Operation resources:
6757 #
6758 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
6759 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
6760 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
6761 #
6762 # You can use an operation resource to manage asynchronous API requests.
6763 # For more information, readHandling
6764 # API responses.
6765 #
6766 # Operations can be global, regional or zonal.
6767 #
6768 # - For global operations, use the `globalOperations`
6769 # resource.
6770 # - For regional operations, use the
6771 # `regionOperations` resource.
6772 # - For zonal operations, use
6773 # the `zoneOperations` resource.
6774 #
6775 #
6776 #
6777 # For more information, read
6778 # Global, Regional, and Zonal Resources.
6779 #
6780 # Note that completed Operation resources have a limited
6781 # retention period.
6782 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6783 # Not present otherwise.
6784 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6785 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6786 # set when the operation is created.
6787 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6788 # text format.
6789 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6790 # this field will be populated.
6791 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6792 # operation.
6793 {
6794 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6795 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6796 # details. There is a set of defined message types to use for providing
6797 # details.The syntax depends on the error code. For example,
6798 # QuotaExceededInfo will have details when the error code is
6799 # QUOTA_EXCEEDED.
6800 {
6801 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6802 #
6803 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6804 # is not enabled:
6805 #
6806 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6807 # &quot;domain&quot;: &quot;googleapis.com&quot;
6808 # &quot;metadata&quot;: {
6809 # &quot;resource&quot;: &quot;projects/123&quot;,
6810 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6811 # }
6812 # }
6813 #
6814 # This response indicates that the pubsub.googleapis.com API is not enabled.
6815 #
6816 # Example of an error that is returned when attempting to create a Spanner
6817 # instance in a region that is out of stock:
6818 #
6819 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6820 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6821 # &quot;metadata&quot;: {
6822 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6823 # }
6824 # }
6825 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6826 # is typically the registered service name of the tool or product that
6827 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6828 # generated by some common infrastructure, the error domain must be a
6829 # globally unique value that identifies the infrastructure. For Google API
6830 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6831 &quot;metadatas&quot;: { # Additional structured details about this error.
6832 #
6833 # Keys must match a regular expression of `a-z+` but should
6834 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6835 # length. When identifying the current value of an exceeded limit, the units
6836 # should be contained in the key, not the value. For example, rather than
6837 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6838 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6839 # instances that can be created in a single (batch) request.
6840 &quot;a_key&quot;: &quot;A String&quot;,
6841 },
6842 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6843 # proximate cause of the error. Error reasons are unique within a particular
6844 # domain of errors. This should be at most 63 characters and match a
6845 # regular expression of `A-Z+[A-Z0-9]`, which represents
6846 # UPPER_SNAKE_CASE.
6847 },
6848 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6849 #
6850 # For example, if a quota check failed with an error indicating the calling
6851 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6852 # directly to the right place in the developer console to flip the bit.
6853 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6854 { # Describes a URL link.
6855 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6856 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6857 },
6858 ],
6859 },
6860 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6861 # which can be attached to an RPC error.
6862 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6863 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6864 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6865 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6866 },
6867 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6868 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6869 &quot;a_key&quot;: &quot;A String&quot;,
6870 },
6871 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6872 # type or metric.
6873 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6874 # or metric.
6875 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6876 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6877 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6878 },
6879 },
6880 ],
6881 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6882 # This property is optional.
6883 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6884 },
6885 ],
6886 },
6887 &quot;getVersionOperationMetadata&quot;: {
6888 &quot;inlineSbomInfo&quot;: {
6889 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6890 # appropriate identifiers.
6891 &quot;a_key&quot;: &quot;A String&quot;,
6892 },
6893 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6894 # identifiers.
6895 &quot;a_key&quot;: &quot;A String&quot;,
6896 },
6897 },
6898 },
6899 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6900 # message that was returned, such as `NOT FOUND`.
6901 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6902 # status code that was returned. For example, a `404` means the
6903 # resource was not found.
6904 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6905 # defined by the server.
6906 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6907 # This value is inRFC3339
6908 # text format.
6909 &quot;instancesBulkInsertOperationMetadata&quot;: {
6910 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6911 # Example key: zones/us-central1-a
6912 &quot;a_key&quot;: {
6913 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6914 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6915 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6916 # error.
6917 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6918 # if the flow is rolling forward or rolling back.
6919 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6920 },
6921 },
6922 },
6923 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6924 # Operation resources.
6925 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6926 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6927 # group of operations results from a `bulkInsert` API request.
6928 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6929 # `update`, or `delete`, and so on.
6930 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6931 # There is no requirement that this be linear or support any granularity of
6932 # operations. This should not be used to guess when the operation will be
6933 # complete. This number should monotonically increase as the operation
6934 # progresses.
6935 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6936 # applicable when performing regional operations.
6937 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6938 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6939 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6940 # this field will contain information on all underlying zonal actions and
6941 # their state.
6942 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6943 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6944 # Example key: zones/us-central1-a
6945 &quot;a_key&quot;: {
6946 &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
6947 # populated.
6948 # different programming environments, including REST APIs and RPC APIs. It is
6949 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6950 # three pieces of data: error code, error message, and error details.
6951 #
6952 # You can find out more about this error model and how to work with it in the
6953 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6954 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6955 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6956 # message types for APIs to use.
6957 {
6958 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6959 },
6960 ],
6961 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6962 # user-facing error message should be localized and sent in the
6963 # google.rpc.Status.details field, or localized by the client.
6964 },
6965 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6966 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6967 },
6968 },
6969 },
6970 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6971 # This value is inRFC3339
6972 # text format.
6973 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6974 # following:
6975 # `PENDING`, `RUNNING`, or `DONE`.
6976 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6977 # operation.
6978 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6979 # of the target resource.
6980 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6981 # operations related to creating a snapshot, this points to the disk
6982 # that the snapshot was created from.
6983 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6984 # `[email protected]` or
6985 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6986 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6987 # operation, this field will be populated.
6988 {
6989 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6990 # Engine returns NO_RESULTS_ON_PAGE if there
6991 # are no results in the response.
6992 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6993 # value format. For example:
6994 #
6995 # &quot;data&quot;: [
6996 # {
6997 # &quot;key&quot;: &quot;scope&quot;,
6998 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6999 # }
7000 {
7001 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7002 # returned. For example, for warnings where there are no results in a list
7003 # request for a particular zone, this key might be scope and
7004 # the key value might be the zone name. Other examples might be a key
7005 # indicating a deprecated resource and a suggested replacement, or a
7006 # warning about invalid network settings (for example, if an instance
7007 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7008 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7009 },
7010 ],
7011 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7012 },
7013 ],
7014 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7015 # applicable when performing per-zone operations.
7016 }</pre>
7017 </div>
7018
7019 <div class="method">
7020 <code class="details" id="get">get(project, zone, instance, view=None, x__xgafv=None)</code>
7021 <pre>Returns the specified Instance resource.
7022
7023 Args:
7024 project: string, Project ID for this request. (required)
7025 zone: string, The name of the zone for this request. (required)
7026 instance: string, Name of the instance resource to return. (required)
7027 view: string, View of the instance.
7028 Allowed values
7029 BASIC - Include everything except Partner Metadata.
7030 FULL - Include everything.
7031 INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
7032 x__xgafv: string, V1 error format.
7033 Allowed values
7034 1 - v1 error format
7035 2 - v2 error format
7036
7037 Returns:
7038 An object of the form:
7039
7040 { # Represents an Instance resource.
7041 #
7042 # An instance is a virtual machine that is hosted on Google Cloud Platform.
7043 # For more information, readVirtual Machine Instances.
7044 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
7045 # Options that would traditionally be configured in a BIOS belong
7046 # here. Features that require operating system support may have
7047 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
7048 # disabled).
7049 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
7050 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
7051 &quot;enableWatchdogTimer&quot;: True or False, # Whether to enable the watchdog timer.
7052 &quot;numaNodeCount&quot;: 42, # The number of vNUMA nodes.
7053 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
7054 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
7055 # multithreading (SMT) set this to 1. If unset, the maximum number
7056 # of threads supported per core by the underlying processor is
7057 # assumed.
7058 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
7059 # Supported modes include:
7060 # * ALL_CORE_MAX
7061 #
7062 # Using empty string or not setting this field will use the platform-specific
7063 # default turbo mode.
7064 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
7065 # the number of threads per core to compute the total number of virtual
7066 # CPUs to expose to the instance. If unset, the number of cores is
7067 # inferred from the instance&#x27;s nominal CPU count and the underlying
7068 # platform&#x27;s SMT width.
7069 },
7070 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
7071 # destination or source IPs. This is required if you plan to use this
7072 # instance to forward routes. For more information, seeEnabling IP Forwarding.
7073 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
7074 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
7075 &quot;confidentialParavisorConfig&quot;: { # A set of Confidential Paravisor (SVSM) options. # Defines a set of Confidential Paravisor (SVSM) options.
7076 &quot;confidentialTpmType&quot;: &quot;A String&quot;,
7077 &quot;sevSnpIrqMode&quot;: &quot;A String&quot;,
7078 },
7079 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
7080 },
7081 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
7082 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
7083 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
7084 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7085 # create the resource.
7086 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
7087 # created before you can assign them.
7088 { # An instance-attached disk resource.
7089 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
7090 # or X86_64.
7091 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
7092 # deleted (but not when the disk is detached from the instance).
7093 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
7094 # partition of the disk for its root filesystem.
7095 &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
7096 # running within the instance. This name can be used to reference the device
7097 # for mounting, resizing, and so on, from within the instance.
7098 #
7099 # If not specified, the server chooses a default device name to apply to this
7100 # disk, in the form persistent-disk-x, where x is a number
7101 # assigned by Google Compute Engine. This field is only applicable for
7102 # persistent disks.
7103 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
7104 # encryption key.
7105 #
7106 # If you are creating a new disk, this field encrypts the new disk using
7107 # an encryption key that you provide. If you are attaching an existing
7108 # disk that is already encrypted, this field decrypts the disk using
7109 # the customer-supplied encryption key.
7110 #
7111 # If you encrypt a disk using a customer-supplied key, you must provide the
7112 # same key again when you attempt to use this resource at a later time. For
7113 # example, you must provide the key when you create a snapshot or an image
7114 # from the disk or when you attach the disk to a virtual machine instance.
7115 #
7116 # If you do not provide an encryption key, then the disk will be encrypted
7117 # using an automatically generated key and you do not need to provide a key
7118 # to use the disk later.
7119 #
7120 # Note:
7121 #
7122 # Instance templates do not storecustomer-supplied
7123 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
7124 #
7125 # You cannot create VMs that have disks with customer-supplied keys using
7126 # the bulk
7127 # insert method.
7128 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
7129 # For example:
7130 #
7131 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7132 # key_region/cryptoKeys/key
7133 #
7134 # The fully-qualifed key name may be returned for resource GET requests. For
7135 # example:
7136 #
7137 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7138 # key_region/cryptoKeys/key
7139 # /cryptoKeyVersions/1
7140 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
7141 # key. If absent, the Compute Engine default service account is used.
7142 # For example:
7143 #
7144 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
7145 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
7146 # encryption key, encoded in RFC
7147 # 4648 base64 to either encrypt or decrypt this resource. You can
7148 # provide either the rawKey or thersaEncryptedKey.
7149 # For example:
7150 #
7151 # &quot;rawKey&quot;:
7152 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
7153 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
7154 # customer-supplied encryption key to either encrypt or decrypt this
7155 # resource. You can provide either the rawKey or thersaEncryptedKey.
7156 # For example:
7157 #
7158 # &quot;rsaEncryptedKey&quot;:
7159 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
7160 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
7161 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
7162 #
7163 # The key must meet the following requirements before you can provide it to
7164 # Compute Engine:
7165 #
7166 # 1. The key is wrapped using a RSA public key certificate provided by
7167 # Google.
7168 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
7169 # encoding.
7170 #
7171 # Gets the RSA public key certificate provided by Google at:
7172 #
7173 #
7174 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
7175 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
7176 # 4648 base64 encoded SHA-256 hash of the customer-supplied
7177 # encryption key that protects this resource.
7178 },
7179 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
7180 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
7181 # currently attached to another instance. If you try to force attach a zonal
7182 # disk to an instance, you will receive an error.
7183 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
7184 # only for bootable images. Read
7185 # Enabling guest operating system features to see a list of available
7186 # options.
7187 { # Guest OS features.
7188 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
7189 # separate values. Set to one or more of the following values:
7190 #
7191 # - VIRTIO_SCSI_MULTIQUEUE
7192 # - WINDOWS
7193 # - MULTI_IP_SUBNET
7194 # - UEFI_COMPATIBLE
7195 # - GVNIC
7196 # - SEV_CAPABLE
7197 # - SUSPEND_RESUME_COMPATIBLE
7198 # - SEV_LIVE_MIGRATABLE_V2
7199 # - SEV_SNP_CAPABLE
7200 # - TDX_CAPABLE
7201 # - IDPF
7202 # - SNP_SVSM_CAPABLE
7203 # - CCA_CAPABLE
7204 #
7205 #
7206 # For more information, see
7207 # Enabling guest operating system features.
7208 },
7209 ],
7210 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
7211 # boot disk. If you have many disks attached to an instance, each
7212 # disk would have a unique index number.
7213 &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
7214 # alongside the new instance. Use initialization parameters to create boot
7215 # disks or local SSDs attached to the new instance.
7216 #
7217 # This property is mutually exclusive with the source property;
7218 # you can only define one or the other, but not both.
7219 # alongside the new instance. Use initialization parameters to create boot
7220 # disks or local SSDs attached to the new instance.
7221 #
7222 # This field is persisted and returned for instanceTemplate and not returned
7223 # in the context of instance.
7224 #
7225 # This property is mutually exclusive with the source property;
7226 # you can only define one or the other, but not both.
7227 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
7228 # arm64 or x86_64.
7229 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
7230 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
7231 # of the instance. If a disk with the same name already exists in the given
7232 # region, the existing disk is attached to the new instance and the
7233 # new disk is not created.
7234 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
7235 # 10 GB. If you specify a sourceImage, which is required for
7236 # boot disks, the default size is the size of the sourceImage.
7237 # If you do not specify a sourceImage, the default disk size
7238 # is 500 GB.
7239 &quot;diskType&quot;: &quot;A String&quot;,
7240 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
7241 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
7242 # only for bootable images. Read
7243 # Enabling guest operating system features to see a list of available
7244 # options.
7245 #
7246 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
7247 { # Guest OS features.
7248 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
7249 # separate values. Set to one or more of the following values:
7250 #
7251 # - VIRTIO_SCSI_MULTIQUEUE
7252 # - WINDOWS
7253 # - MULTI_IP_SUBNET
7254 # - UEFI_COMPATIBLE
7255 # - GVNIC
7256 # - SEV_CAPABLE
7257 # - SUSPEND_RESUME_COMPATIBLE
7258 # - SEV_LIVE_MIGRATABLE_V2
7259 # - SEV_SNP_CAPABLE
7260 # - TDX_CAPABLE
7261 # - IDPF
7262 # - SNP_SVSM_CAPABLE
7263 # - CCA_CAPABLE
7264 #
7265 #
7266 # For more information, see
7267 # Enabling guest operating system features.
7268 },
7269 ],
7270 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
7271 # which is either SCSI or NVME. The default isSCSI.
7272 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
7273 # persistent disks.
7274 &quot;a_key&quot;: &quot;A String&quot;,
7275 },
7276 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
7277 # disk.
7278 &quot;A String&quot;,
7279 ],
7280 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
7281 &quot;A String&quot;,
7282 ],
7283 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
7284 # more than one instance.
7285 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
7286 # is to use the existing disk.
7287 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
7288 # of I/O operations per second that the disk can handle. Values must be
7289 # between 10,000 and 120,000. For more details, see theExtreme persistent
7290 # disk documentation.
7291 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
7292 # number of throughput mb per second that the disk can handle. Values must
7293 # greater than or equal to 1.
7294 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
7295 # the URLs of the zones where the disk should be replicated to.
7296 # You must provide exactly two replica zones, and one zone must be the same
7297 # as the instance zone.
7298 &quot;A String&quot;,
7299 ],
7300 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
7301 # have the same definition as resource
7302 # manager tags. Keys and values can be either in numeric format,
7303 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
7304 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
7305 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
7306 # empty.
7307 &quot;a_key&quot;: &quot;A String&quot;,
7308 },
7309 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
7310 # Specified using the full or partial URL. For instance template, specify
7311 # only the resource policy name.
7312 &quot;A String&quot;,
7313 ],
7314 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
7315 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
7316 # is required.
7317 #
7318 # To create a disk with one of the public operating system
7319 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
7320 #
7321 # projects/debian-cloud/global/images/family/debian-9
7322 #
7323 #
7324 # Alternatively, use a specific version of a public operating system image:
7325 #
7326 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
7327 #
7328 #
7329 # To create a disk with a custom image that you created, specify the
7330 # image name in the following format:
7331 #
7332 # global/images/my-custom-image
7333 #
7334 #
7335 # You can also specify a custom image by its image family, which returns
7336 # the latest version of the image in that family. Replace the image name
7337 # with family/family-name:
7338 #
7339 # global/images/family/my-image-family
7340 #
7341 #
7342 # If the source image is deleted later, this field will not be set.
7343 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
7344 # encryption key of the source image. Required if the source image is
7345 # protected by a customer-supplied encryption key.
7346 #
7347 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
7348 # encryption keys, so you cannot create disks for instances in a managed instance group if the
7349 # source images are encrypted with your own keys.
7350 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
7351 # For example:
7352 #
7353 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7354 # key_region/cryptoKeys/key
7355 #
7356 # The fully-qualifed key name may be returned for resource GET requests. For
7357 # example:
7358 #
7359 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7360 # key_region/cryptoKeys/key
7361 # /cryptoKeyVersions/1
7362 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
7363 # key. If absent, the Compute Engine default service account is used.
7364 # For example:
7365 #
7366 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
7367 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
7368 # encryption key, encoded in RFC
7369 # 4648 base64 to either encrypt or decrypt this resource. You can
7370 # provide either the rawKey or thersaEncryptedKey.
7371 # For example:
7372 #
7373 # &quot;rawKey&quot;:
7374 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
7375 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
7376 # customer-supplied encryption key to either encrypt or decrypt this
7377 # resource. You can provide either the rawKey or thersaEncryptedKey.
7378 # For example:
7379 #
7380 # &quot;rsaEncryptedKey&quot;:
7381 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
7382 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
7383 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
7384 #
7385 # The key must meet the following requirements before you can provide it to
7386 # Compute Engine:
7387 #
7388 # 1. The key is wrapped using a RSA public key certificate provided by
7389 # Google.
7390 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
7391 # encoding.
7392 #
7393 # Gets the RSA public key certificate provided by Google at:
7394 #
7395 #
7396 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
7397 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
7398 # 4648 base64 encoded SHA-256 hash of the customer-supplied
7399 # encryption key that protects this resource.
7400 },
7401 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
7402 # instance boot disk, one of initializeParams.sourceSnapshot
7403 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
7404 # is required.
7405 #
7406 # To create a disk with a snapshot that you created, specify the
7407 # snapshot name in the following format:
7408 #
7409 # us-central1-a/instantSnapshots/my-backup
7410 #
7411 #
7412 # If the source instant-snapshot is deleted later, this field will not be
7413 # set.
7414 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
7415 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
7416 # is required.
7417 #
7418 # To create a disk with a snapshot that you created, specify the
7419 # snapshot name in the following format:
7420 #
7421 # global/snapshots/my-backup
7422 #
7423 #
7424 # If the source snapshot is deleted later, this field will not be set.
7425 #
7426 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
7427 # an image instead when you create VMs using
7428 # the bulk
7429 # insert method.
7430 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
7431 # encryption key of the source snapshot.
7432 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
7433 # For example:
7434 #
7435 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7436 # key_region/cryptoKeys/key
7437 #
7438 # The fully-qualifed key name may be returned for resource GET requests. For
7439 # example:
7440 #
7441 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7442 # key_region/cryptoKeys/key
7443 # /cryptoKeyVersions/1
7444 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
7445 # key. If absent, the Compute Engine default service account is used.
7446 # For example:
7447 #
7448 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
7449 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
7450 # encryption key, encoded in RFC
7451 # 4648 base64 to either encrypt or decrypt this resource. You can
7452 # provide either the rawKey or thersaEncryptedKey.
7453 # For example:
7454 #
7455 # &quot;rawKey&quot;:
7456 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
7457 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
7458 # customer-supplied encryption key to either encrypt or decrypt this
7459 # resource. You can provide either the rawKey or thersaEncryptedKey.
7460 # For example:
7461 #
7462 # &quot;rsaEncryptedKey&quot;:
7463 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
7464 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
7465 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
7466 #
7467 # The key must meet the following requirements before you can provide it to
7468 # Compute Engine:
7469 #
7470 # 1. The key is wrapped using a RSA public key certificate provided by
7471 # Google.
7472 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
7473 # encoding.
7474 #
7475 # Gets the RSA public key certificate provided by Google at:
7476 #
7477 #
7478 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
7479 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
7480 # 4648 base64 encoded SHA-256 hash of the customer-supplied
7481 # encryption key that protects this resource.
7482 },
7483 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
7484 # this as a partial or full URL to the resource. For example, the following
7485 # are valid values:
7486 #
7487 #
7488 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
7489 # - projects/project/zones/zone/storagePools/storagePool
7490 # - zones/zone/storagePools/storagePool
7491 },
7492 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
7493 # either SCSI or NVME. For most machine types, the
7494 # default is SCSI. Local SSDs can use either NVME or SCSI.
7495 # In certain configurations, persistent disks can use NVMe. For more
7496 # information, seeAbout
7497 # persistent disks.
7498 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
7499 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
7500 &quot;A String&quot;,
7501 ],
7502 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
7503 # disk is not allowed to be detached from the instance, or to be used as the
7504 # source of the snapshot creation, and the image creation. The instance with
7505 # at least one locked attached disk is not allow to be used as source of
7506 # machine image creation, instant snapshot creation, and not allowed to be
7507 # deleted with --keep-disk parameter set to true for locked disks.
7508 &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
7509 # in READ_WRITE mode.
7510 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
7511 # field is set to PRESERVED if the LocalSSD data has been saved
7512 # to a persistent location by customer request. (see the
7513 # discard_local_ssd option on Stop/Suspend).
7514 # Read-only in the api.
7515 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
7516 # these are public keys which are safe to store in public
7517 &quot;dbs&quot;: [ # The Key Database (db).
7518 {
7519 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
7520 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
7521 },
7522 ],
7523 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
7524 {
7525 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
7526 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
7527 },
7528 ],
7529 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
7530 {
7531 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
7532 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
7533 },
7534 ],
7535 &quot;pk&quot;: { # The Platform Key (PK).
7536 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
7537 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
7538 },
7539 },
7540 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
7541 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
7542 # is required.
7543 #
7544 # If desired, you can also attach existing non-root persistent disks using
7545 # this property. This field is only applicable for persistent disks.
7546 #
7547 # Note that for InstanceTemplate, specify the disk name for zonal disk,
7548 # and the URL for regional disk.
7549 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
7550 },
7551 ],
7552 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
7553 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
7554 },
7555 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
7556 # machine image should erase Windows specific VSS signature.
7557 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
7558 # the instance&#x27;s contents and used for optimistic locking. The
7559 # fingerprint is initially generated by Compute Engine and changes after
7560 # every request to modify or update the instance. You must always provide an
7561 # up-to-date fingerprint hash in order to update the instance.
7562 #
7563 # To see the latest fingerprint, make get() request to the
7564 # instance.
7565 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
7566 { # A specification of the type and number of accelerator cards attached to the
7567 # instance.
7568 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
7569 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
7570 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
7571 # If you are creating an instance template, specify only the
7572 # accelerator name.
7573 # See GPUs on Compute Engine
7574 # for a full list of accelerator types.
7575 },
7576 ],
7577 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
7578 # RFC1035 compliant. If hostname is not specified, the default hostname is
7579 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
7580 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
7581 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
7582 # defined by the server.
7583 &quot;identity&quot;: &quot;A String&quot;,
7584 &quot;identityCertificate&quot;: True or False,
7585 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
7586 # encryption key.
7587 #
7588 # If you are creating a new instance, this field will encrypt the local SSD
7589 # and in-memory contents of the instance during the suspend operation.
7590 #
7591 # If you do not provide an encryption key when creating the instance, then
7592 # the local SSD and in-memory contents will be encrypted using
7593 # an automatically generated key during the suspend operation.
7594 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
7595 # For example:
7596 #
7597 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7598 # key_region/cryptoKeys/key
7599 #
7600 # The fully-qualifed key name may be returned for resource GET requests. For
7601 # example:
7602 #
7603 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7604 # key_region/cryptoKeys/key
7605 # /cryptoKeyVersions/1
7606 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
7607 # key. If absent, the Compute Engine default service account is used.
7608 # For example:
7609 #
7610 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
7611 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
7612 # encryption key, encoded in RFC
7613 # 4648 base64 to either encrypt or decrypt this resource. You can
7614 # provide either the rawKey or thersaEncryptedKey.
7615 # For example:
7616 #
7617 # &quot;rawKey&quot;:
7618 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
7619 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
7620 # customer-supplied encryption key to either encrypt or decrypt this
7621 # resource. You can provide either the rawKey or thersaEncryptedKey.
7622 # For example:
7623 #
7624 # &quot;rsaEncryptedKey&quot;:
7625 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
7626 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
7627 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
7628 #
7629 # The key must meet the following requirements before you can provide it to
7630 # Compute Engine:
7631 #
7632 # 1. The key is wrapped using a RSA public key certificate provided by
7633 # Google.
7634 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
7635 # encoding.
7636 #
7637 # Gets the RSA public key certificate provided by Google at:
7638 #
7639 #
7640 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
7641 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
7642 # 4648 base64 encoded SHA-256 hash of the customer-supplied
7643 # encryption key that protects this resource.
7644 },
7645 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
7646 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
7647 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
7648 # for instances.
7649 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
7650 # the label&#x27;s contents and used for optimistic locking. The
7651 # fingerprint is initially generated by Compute Engine and changes after
7652 # every request to modify or update labels. You must always provide an
7653 # up-to-date fingerprint hash in order to update or change labels.
7654 #
7655 # To see the latest fingerprint, make get() request to the
7656 # instance.
7657 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
7658 # the setLabels method.
7659 &quot;a_key&quot;: &quot;A String&quot;,
7660 },
7661 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
7662 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
7663 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
7664 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
7665 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
7666 # when the instance is created. For example, the following is a valid partial
7667 # url to a predefined
7668 # machine type:
7669 #
7670 # zones/us-central1-f/machineTypes/n1-standard-1
7671 #
7672 #
7673 # To create acustom
7674 # machine type, provide a URL to a machine type in the following format,
7675 # where CPUS is 1 or an even number up to 32 (2,
7676 # 4, 6, ... 24, etc), and MEMORY is the total
7677 # memory for this instance. Memory must be a multiple of 256 MB and must
7678 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
7679 #
7680 # zones/zone/machineTypes/custom-CPUS-MEMORY
7681 #
7682 #
7683 # For example: zones/us-central1-f/machineTypes/custom-4-5120
7684 # For a full list of restrictions, read theSpecifications
7685 # for custom machine types.
7686 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
7687 # to this instance. This includes metadata keys that were explicitly defined
7688 # for the instance.
7689 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
7690 # the metadata&#x27;s contents and used for optimistic locking. The
7691 # fingerprint is initially generated by Compute Engine and changes after
7692 # every request to modify or update metadata. You must always provide an
7693 # up-to-date fingerprint hash in order to update or change metadata,
7694 # otherwise the request will fail with error412 conditionNotMet.
7695 #
7696 # To see the latest fingerprint, make a get() request to
7697 # retrieve the resource.
7698 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
7699 # less than 512 KB.
7700 { # Metadata
7701 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
7702 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
7703 # This is reflected as part of a URL in the metadata server. Additionally, to
7704 # avoid ambiguity, keys must not conflict with any other metadata keys
7705 # for the project.
7706 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
7707 # have meaning as interpreted by the image running in the instance. The
7708 # only restriction placed on values is that their size must be less than
7709 # or equal to 262144 bytes (256 KiB).
7710 },
7711 ],
7712 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
7713 # for metadata.
7714 },
7715 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
7716 # platform for the VM instance. Applicable values are the friendly names
7717 # of CPU platforms, such as minCpuPlatform: &quot;Intel
7718 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
7719 # Bridge&quot;.
7720 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
7721 # the resource. The resource name must be 1-63 characters long, and comply
7722 # withRFC1035.
7723 # Specifically, the name must be 1-63 characters long and match the regular
7724 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7725 # character must be a lowercase letter, and all following characters must be
7726 # a dash, lowercase letter, or digit, except the last character, which cannot
7727 # be a dash.
7728 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
7729 # interfaces are configured to interact with other network services, such as
7730 # connecting to the internet. Multiple interfaces are supported
7731 # per instance.
7732 { # A network interface resource attached to an instance.
7733 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
7734 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
7735 # no external internet access.
7736 { # An access configuration attached to an instance&#x27;s network interface.
7737 # Only one access config per instance is supported.
7738 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
7739 # The first IPv6 address of the external IPv6 range associated
7740 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
7741 # use a static external IP address, it must be unused and in the same region
7742 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
7743 # assign an external IPv6 address from the instance&#x27;s subnetwork.
7744 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
7745 # external IPv6 range.
7746 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
7747 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
7748 # (IPv4), the default and recommended name is External NAT, but
7749 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
7750 # recommend name is External IPv6.
7751 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
7752 # address associated with this instance. Specify an unused static
7753 # external IP address available to the project or leave this field undefined
7754 # to use an IP from a shared ephemeral IP address pool. If you specify a
7755 # static external IP address, it must live in the same region as the zone of
7756 # the instance.
7757 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
7758 # configuration and can only take the following values: PREMIUM,STANDARD.
7759 #
7760 # If an AccessConfig is specified without a valid external IP address, an
7761 # ephemeral IP will be created with this networkTier.
7762 #
7763 # If an AccessConfig with a valid external IP address is specified, it must
7764 # match that of the networkTier associated with the Address resource owning
7765 # that IP.
7766 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
7767 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
7768 #
7769 # 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
7770 # first IP in associated external IPv6 range.
7771 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
7772 # config.
7773 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
7774 # external IP address of this access configuration.
7775 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
7776 # external IP address of the instance to a DNS domain name.
7777 #
7778 # This field is not used in ipv6AccessConfig. A default PTR
7779 # record will be created if the VM has external IPv6 range associated.
7780 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
7781 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
7782 },
7783 ],
7784 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
7785 # You can only specify this field for network interfaces in VPC networks.
7786 { # An alias IP range attached to an instance&#x27;s network interface.
7787 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
7788 # must belong to the specified subnetwork and cannot contain IP addresses
7789 # reserved by system or used by other network interfaces. This range may be
7790 # 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).
7791 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
7792 # alias range. If not specified, the primary range of the subnetwork is used.
7793 },
7794 ],
7795 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
7796 # You can only specify this field for network interfaces in VPC networks.
7797 { # An alias IP range attached to an instance&#x27;s network interface.
7798 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
7799 # must belong to the specified subnetwork and cannot contain IP addresses
7800 # reserved by system or used by other network interfaces. This range may be
7801 # 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).
7802 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
7803 # alias range. If not specified, the primary range of the subnetwork is used.
7804 },
7805 ],
7806 &quot;dns64Eligible&quot;: True or False, # If true, this network interface is eligible for DNS64.
7807 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
7808 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
7809 # with network_attachment.
7810 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
7811 # This field will be ignored when inserting an Instance or
7812 # adding a NetworkInterface. An up-to-date
7813 # 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.
7814 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
7815 # or not. If enabled, also indicates the version of IGMP supported.
7816 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
7817 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
7818 # one IPv6 access config, DIRECT_IPV6, is supported. If there
7819 # is no ipv6AccessConfig specified, then this instance will
7820 # have no external IPv6 Internet access.
7821 { # An access configuration attached to an instance&#x27;s network interface.
7822 # Only one access config per instance is supported.
7823 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
7824 # The first IPv6 address of the external IPv6 range associated
7825 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
7826 # use a static external IP address, it must be unused and in the same region
7827 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
7828 # assign an external IPv6 address from the instance&#x27;s subnetwork.
7829 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
7830 # external IPv6 range.
7831 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
7832 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
7833 # (IPv4), the default and recommended name is External NAT, but
7834 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
7835 # recommend name is External IPv6.
7836 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
7837 # address associated with this instance. Specify an unused static
7838 # external IP address available to the project or leave this field undefined
7839 # to use an IP from a shared ephemeral IP address pool. If you specify a
7840 # static external IP address, it must live in the same region as the zone of
7841 # the instance.
7842 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
7843 # configuration and can only take the following values: PREMIUM,STANDARD.
7844 #
7845 # If an AccessConfig is specified without a valid external IP address, an
7846 # ephemeral IP will be created with this networkTier.
7847 #
7848 # If an AccessConfig with a valid external IP address is specified, it must
7849 # match that of the networkTier associated with the Address resource owning
7850 # that IP.
7851 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
7852 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
7853 #
7854 # 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
7855 # first IP in associated external IPv6 range.
7856 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
7857 # config.
7858 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
7859 # external IP address of this access configuration.
7860 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
7861 # external IP address of the instance to a DNS domain name.
7862 #
7863 # This field is not used in ipv6AccessConfig. A default PTR
7864 # record will be created if the VM has external IPv6 range associated.
7865 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
7866 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
7867 },
7868 ],
7869 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
7870 # accessed from the Internet. This field is always inherited from its
7871 # subnetwork.
7872 #
7873 # Valid only if stackType is IPV4_IPV6.
7874 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
7875 # use a static internal IP address, it must be unused and in the same region
7876 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
7877 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
7878 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
7879 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
7880 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
7881 # server. For a VM, the network interface uses the nicN naming
7882 # format. Where N is a value between 0 and7. The default interface value is nic0.
7883 &quot;nat64Eligible&quot;: True or False, # If true, this network interface is eligible for NAT64.
7884 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
7885 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
7886 # instance, if neither the network nor the subnetwork is specified, the
7887 # default network global/networks/default is used. If the
7888 # selected project doesn&#x27;t have the default network, you must specify a
7889 # network or subnet. If the network is not specified but the subnetwork is
7890 # specified, the network is inferred.
7891 #
7892 # If you specify this property, you can specify the network as
7893 # a full or partial URL. For example, the following are all valid URLs:
7894 #
7895 #
7896 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
7897 # - projects/project/global/networks/network
7898 # - global/networks/default
7899 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
7900 # to in the following format:
7901 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
7902 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
7903 # interface. If not specified by the user, an unused internal IP is
7904 # assigned by the system.
7905 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
7906 # VirtioNet.
7907 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
7908 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
7909 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
7910 # if not specified by the users.
7911 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
7912 # interface. Can only be used with network_attachment. It is not possible to
7913 # use on its own however, network_attachment can be used without
7914 # service_class_id.
7915 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
7916 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
7917 #
7918 # This field can be both set at instance creation and update network
7919 # interface operations.
7920 &quot;subinterfaces&quot;: [ # SubInterfaces help enable L2 communication for the instance over
7921 # subnetworks that support L2. Every network interface will get a default
7922 # untagged (vlan not specified) subinterface. Users can specify additional
7923 # tagged subinterfaces which are sub-fields to the Network Interface.
7924 {
7925 &quot;ipAddress&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this
7926 # subinterface. If specified, ip_allocation_mode should be set to
7927 # ALLOCATE_IP.
7928 &quot;ipAllocationMode&quot;: &quot;A String&quot;,
7929 &quot;subnetwork&quot;: &quot;A String&quot;, # If specified, this subnetwork must belong to the same network
7930 # as that of the network interface.
7931 # If not specified the subnet of network interface will be used.
7932 # If you specify this property, you can specify the subnetwork as a full
7933 # or partial URL. For example, the following are all valid URLs:
7934 #
7935 #
7936 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
7937 # - regions/region/subnetworks/subnetwork
7938 &quot;vlan&quot;: 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which
7939 # this subinterface is connecting.
7940 },
7941 ],
7942 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
7943 # resource is inlegacy
7944 # mode, do not specify this field. If the network is in auto subnet
7945 # mode, specifying the subnetwork is optional. If the network is in custom
7946 # subnet mode, specifying the subnetwork is required. If you specify this
7947 # field, you can specify the subnetwork as a full or partial URL. For
7948 # example, the following are all valid URLs:
7949 #
7950 #
7951 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
7952 # - regions/region/subnetworks/subnetwork
7953 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
7954 # from 2 to 255 inclusively.
7955 },
7956 ],
7957 &quot;networkPerformanceConfig&quot;: {
7958 &quot;externalIpEgressBandwidthTier&quot;: &quot;A String&quot;,
7959 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
7960 },
7961 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
7962 # as part of resource payload.
7963 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
7964 # Instances.Insert API.
7965 # as a count of seconds and fractions of seconds at nanosecond
7966 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7967 # or &quot;month&quot;. Range is approximately 10,000 years.
7968 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7969 # Durations less than one second are represented with a 0
7970 # `seconds` field and a positive `nanos` field. Must be from 0
7971 # to 999,999,999 inclusive.
7972 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7973 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7974 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7975 },
7976 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
7977 # have the same definition as resource
7978 # manager tags. Keys and values can be either in numeric format,
7979 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
7980 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
7981 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
7982 # PATCH) when empty.
7983 &quot;a_key&quot;: &quot;A String&quot;,
7984 },
7985 },
7986 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
7987 # (namespace) to entries map.
7988 &quot;a_key&quot;: {
7989 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
7990 # It accepts any value including google.protobuf.Struct.
7991 &quot;a_key&quot;: &quot;&quot;,
7992 },
7993 },
7994 },
7995 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
7996 &quot;preservedStateSizeGb&quot;: &quot;A String&quot;, # Output only. Total amount of preserved state for SUSPENDED instances.
7997 # Read-only in the api.
7998 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
7999 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
8000 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
8001 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
8002 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
8003 # Consuming reserved instances for examples.
8004 &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
8005 # the name of your reservation as its value.
8006 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
8007 # either a name to a reservation in the same project or
8008 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
8009 # shared reservation in the same zone but in a different project.
8010 &quot;A String&quot;,
8011 ],
8012 },
8013 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
8014 &quot;A String&quot;,
8015 ],
8016 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
8017 # compared to the values requested by user in the corresponding input only
8018 # field.
8019 # Use this sub-message for actual values set on Instance attributes as compared
8020 # to the value requested by the user (intent) in their instance CRUD calls.
8021 &quot;acceleratorStatus&quot;: [ # Output only. [Output Only] Accelerators status show results of GPU scans. These scans
8022 # are specialized diagnostic tests designed to uncover latent manufacturing
8023 # defects or other issues that could potentially lead to data corruption or
8024 # impede the customer&#x27;s ability to efficiently execute GPU workloads.
8025 { # The status of an individual accelerator resource.
8026 &quot;passedScans&quot;: [ # The details of scans that passed for an accelerator.
8027 {
8028 &quot;endTime&quot;: &quot;A String&quot;, # The end time of the passed scan inRFC3339 text format.
8029 &quot;name&quot;: &quot;A String&quot;,
8030 &quot;startTime&quot;: &quot;A String&quot;, # The start time of the passed scan inRFC3339 text format.
8031 &quot;version&quot;: &quot;A String&quot;,
8032 },
8033 ],
8034 &quot;recommendedScans&quot;: [ # The details of recommended scans for an accelerator.
8035 {
8036 &quot;estimatedDuration&quot;: { # A Duration represents a fixed-length span of time represented
8037 # as a count of seconds and fractions of seconds at nanosecond
8038 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8039 # or &quot;month&quot;. Range is approximately 10,000 years.
8040 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8041 # Durations less than one second are represented with a 0
8042 # `seconds` field and a positive `nanos` field. Must be from 0
8043 # to 999,999,999 inclusive.
8044 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8045 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8046 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8047 },
8048 &quot;name&quot;: &quot;A String&quot;,
8049 &quot;version&quot;: &quot;A String&quot;,
8050 },
8051 ],
8052 &quot;serialNumber&quot;: &quot;A String&quot;, # The serial number of the accelerator.
8053 &quot;uuid&quot;: &quot;A String&quot;, # The UUID of the accelerator.
8054 },
8055 ],
8056 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this instance
8057 # is consuming from.
8058 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
8059 # instance is consuming from.
8060 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
8061 # zonal instance settings, and instance-level predefined metadata keys to
8062 # provide the overridden value for those metadata keys at the instance level.
8063 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
8064 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
8065 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
8066 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
8067 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
8068 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
8069 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
8070 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
8071 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
8072 },
8073 &quot;lastInstanceTerminationDetails&quot;: { # Output only. [Output Only] Contains last termination details why the instance was
8074 # terminated.
8075 &quot;terminationReason&quot;: &quot;A String&quot;, # Reason for termination
8076 },
8077 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
8078 # center, including the block, sub-block, and host. The field is formatted as
8079 # follows: blockId/subBlockId/hostId.
8080 &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
8081 # Engine cluster, as well as the ID of the block, sub-block, and host on
8082 # which the running instance is located.
8083 # running.
8084 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
8085 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
8086 # example
8087 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
8088 # the location ID of the topologies.
8089 &quot;a_key&quot;: &quot;A String&quot;,
8090 },
8091 },
8092 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
8093 # located. Instances within the same block experience low network latency.
8094 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
8095 # running instance is located.
8096 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
8097 # Instances on the same host experience the lowest possible network
8098 # latency.
8099 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
8100 # located. Instances in the same sub-block experience lower network latency
8101 # than instances in the same block.
8102 },
8103 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
8104 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
8105 # instance is consuming from.
8106 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
8107 # instance is consuming from.
8108 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
8109 # this instance is consuming from.
8110 },
8111 &quot;scheduling&quot;: {
8112 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
8113 # must be a number between 1 and the number of availability domains
8114 # specified in the spread placement policy attached to the instance.
8115 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
8116 },
8117 &quot;serviceIntegrationStatuses&quot;: { # [Output Only] Represents the status of the service integration specs
8118 # defined by the user in instance.serviceIntegrationSpecs.
8119 &quot;a_key&quot;: { # Represents the status of integration between instance and another service.
8120 # See go/gce-backupdr-design for more details.
8121 &quot;backupDr&quot;: { # Message defining compute perspective of the result of integration with
8122 # Backup and DR. FAILED status indicates that the operation specified did
8123 # not complete correctly and should be retried with the same value.
8124 &quot;integrationDetails&quot;: &quot;A String&quot;, # The PlanReference object created by Backup and DR to maintain the
8125 # actual status of backups. May still be present if removing the backup
8126 # plan fails.
8127 &quot;state&quot;: &quot;A String&quot;, # Enum representing the registration state of a Backup and DR backup plan
8128 # for the instance.
8129 },
8130 },
8131 },
8132 &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.
8133 # programmed stop scheduled.
8134 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
8135 # `stop_state=PENDING_STOP`.
8136 # as a count of seconds and fractions of seconds at nanosecond
8137 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8138 # or &quot;month&quot;. Range is approximately 10,000 years.
8139 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8140 # Durations less than one second are represented with a 0
8141 # `seconds` field and a positive `nanos` field. Must be from 0
8142 # to 999,999,999 inclusive.
8143 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8144 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8145 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8146 },
8147 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
8148 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
8149 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
8150 },
8151 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
8152 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
8153 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
8154 # This value is inRFC3339
8155 # text format.
8156 # DEPRECATED: Use window_start_time instead.
8157 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
8158 # This timestamp value is in RFC3339 text format.
8159 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
8160 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
8161 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
8162 &quot;A String&quot;,
8163 ],
8164 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
8165 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
8166 # DEPRECATED: Use window_start_time instead.
8167 # TimeWindow is a container for two strings that represent timestamps in
8168 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
8169 &quot;earliest&quot;: &quot;A String&quot;,
8170 &quot;latest&quot;: &quot;A String&quot;,
8171 },
8172 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
8173 # This value is inRFC3339
8174 # text format.
8175 # DEPRECATED: Use window_start_time instead.
8176 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
8177 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
8178 # This timestamp value is in RFC3339 text format.
8179 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
8180 # This timestamp value is in RFC3339 text format.
8181 },
8182 },
8183 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
8184 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
8185 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
8186 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
8187 # terminated by Compute Engine (not terminated by a user). You can only set
8188 # the automatic restart option for standard instances.Preemptible instances
8189 # cannot be automatically restarted.
8190 #
8191 # By default, this is set to true so an instance is
8192 # automatically restarted if it is terminated by Compute Engine.
8193 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
8194 # must be a number between 1 and the number of availability domains
8195 # specified in the spread placement policy attached to the instance.
8196 &quot;currentCpus&quot;: 42, # Current number of vCPUs available for VM.
8197 # 0 or unset means default vCPUs of the current machine type.
8198 &quot;currentMemoryMb&quot;: &quot;A String&quot;, # Current amount of memory (in MB) available for VM.
8199 # 0 or unset means default amount of memory of the current machine type.
8200 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
8201 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
8202 &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
8203 # graceful shutdown isn&#x27;t complete after this time, then the instance
8204 # transitions to the STOPPING state.
8205 # as a count of seconds and fractions of seconds at nanosecond
8206 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8207 # or &quot;month&quot;. Range is approximately 10,000 years.
8208 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8209 # Durations less than one second are represented with a 0
8210 # `seconds` field and a positive `nanos` field. Must be from 0
8211 # to 999,999,999 inclusive.
8212 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8213 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8214 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8215 },
8216 },
8217 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
8218 # within the range of [90, 330] with the increment of 30, if unset, the
8219 # default behavior of host error recovery will be used.
8220 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
8221 &quot;latencyTolerant&quot;: True or False, # Defines whether the instance is tolerant of higher cpu latency. This can
8222 # only be set during instance creation, or when the instance is not currently
8223 # running. It must not be set if thepreemptible option is
8224 # also set.
8225 &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
8226 # recovery of the Local Ssd state is attempted. Its value should be in
8227 # between 0 and 168 hours with hour granularity and the default value being 1
8228 # hour.
8229 # as a count of seconds and fractions of seconds at nanosecond
8230 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8231 # or &quot;month&quot;. Range is approximately 10,000 years.
8232 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8233 # Durations less than one second are represented with a 0
8234 # `seconds` field and a positive `nanos` field. Must be from 0
8235 # to 999,999,999 inclusive.
8236 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8237 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8238 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8239 },
8240 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
8241 # resources.
8242 # This field is for use by internal tools that use the public API.
8243 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
8244 # be scheduled for maintenance.
8245 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
8246 # are: `PERIODIC`.
8247 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
8248 # the instance termination action will be performed at the end of the run
8249 # duration.
8250 # as a count of seconds and fractions of seconds at nanosecond
8251 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8252 # or &quot;month&quot;. Range is approximately 10,000 years.
8253 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8254 # Durations less than one second are represented with a 0
8255 # `seconds` field and a positive `nanos` field. Must be from 0
8256 # to 999,999,999 inclusive.
8257 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8258 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8259 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8260 },
8261 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
8262 # on a sole-tenant node.
8263 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
8264 # affinity for more information.
8265 # Overrides reservationAffinity.
8266 { # Node Affinity: the configuration of desired nodes onto which this Instance
8267 # could be scheduled.
8268 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
8269 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
8270 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
8271 &quot;A String&quot;,
8272 ],
8273 },
8274 ],
8275 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
8276 # the default behavior is MIGRATE. Forpreemptible instances,
8277 # the default and only possible behavior is TERMINATE. For more
8278 # information, see
8279 # Set
8280 # VM host maintenance policy.
8281 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
8282 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
8283 # else, the Local SSD data will be preserved when the instance is stopped
8284 # at the end of the run duration/termination time.
8285 },
8286 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
8287 # instance creation or while the instance isstopped and
8288 # therefore, in a `TERMINATED` state. SeeInstance Life
8289 # Cycle for more information on the possible instance states.
8290 &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
8291 # Off signal is triggered for Spot
8292 # VMs only. If not specified, there will be no wait before the G2 Soft
8293 # Off signal is triggered.
8294 # as a count of seconds and fractions of seconds at nanosecond
8295 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8296 # or &quot;month&quot;. Range is approximately 10,000 years.
8297 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8298 # Durations less than one second are represented with a 0
8299 # `seconds` field and a positive `nanos` field. Must be from 0
8300 # to 999,999,999 inclusive.
8301 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8302 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8303 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8304 },
8305 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
8306 &quot;shutdownTimeout&quot;: { # A Duration represents a fixed-length span of time represented # DEPRECATED: please use skipGuestOsShutdown.
8307 # Timeout between GCE ACPI G2 Soft
8308 # Off and ACPI G3 Mechanical
8309 # Off during shutdown operation of VM.
8310 #
8311 # For Standard VMs values between 0s and 120s are allowed. For Spot and
8312 # Preemptible VMs supported values are between 0s and 30s.
8313 #
8314 # If no value is specified for shutdownDuration, default values are 90s for
8315 # Standard VMs and 30s for Spot/Preemptible VMs.
8316 # as a count of seconds and fractions of seconds at nanosecond
8317 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8318 # or &quot;month&quot;. Range is approximately 10,000 years.
8319 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8320 # Durations less than one second are represented with a 0
8321 # `seconds` field and a positive `nanos` field. Must be from 0
8322 # to 999,999,999 inclusive.
8323 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8324 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8325 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8326 },
8327 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
8328 # Off and ACPI G3 Mechanical
8329 # Off for Standard VMs and 30 seconds for Spot VMs.
8330 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
8331 # termination action will be performed at the termination time.
8332 &quot;vsockMode&quot;: { # Message to control the enablement of the vsock device. # The vsock mode of the instance.
8333 &quot;mode&quot;: &quot;A String&quot;,
8334 },
8335 &quot;windowsLicenseOptimizationMode&quot;: &quot;A String&quot;, # Represents the Windows Server License Optimization Mode of the VM. If
8336 # unspecified, the default mode is `OFF`.
8337 },
8338 &quot;secureTags&quot;: [ # [Input Only] Secure tags to apply to this instance. These can be later
8339 # modified by the update method.
8340 # Maximum number of secure tags allowed is 50.
8341 &quot;A String&quot;,
8342 ],
8343 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
8344 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
8345 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
8346 # this instance. Only one service account per VM instance is supported.
8347 #
8348 # Service accounts generate access tokens that can be accessed
8349 # through the metadata server and used to authenticate applications on the
8350 # instance. SeeService Accounts
8351 # for more information.
8352 { # A service account.
8353 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
8354 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
8355 &quot;A String&quot;,
8356 ],
8357 },
8358 ],
8359 &quot;serviceIntegrationSpecs&quot;: { # Mapping of user-defined keys to specifications for service integrations.
8360 # Currently only a single key-value pair is supported.
8361 &quot;a_key&quot;: { # Specifies the parameters to configure an integration with instances.
8362 &quot;backupDr&quot;: { # Specifies parameters to Backup and DR to attach a BackupPlan to a compute
8363 # instance for managed VM backup.
8364 &quot;plan&quot;: &quot;A String&quot;, # The BackupPlan resource to attach to the instance. Specified as a
8365 # resource reference in instances, and regional instance templates, and as
8366 # just the plan name in global instance templates
8367 },
8368 },
8369 },
8370 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
8371 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
8372 # default.
8373 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
8374 # default.
8375 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
8376 # default.
8377 },
8378 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
8379 # Instance boot integrity is measured.
8380 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
8381 # measurements from the VM instance&#x27;s most recent boot.
8382 },
8383 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
8384 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
8385 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
8386 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
8387 },
8388 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
8389 # VM instance boot integrity is measured.
8390 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
8391 # measurements from the VM instance&#x27;s most recent boot.
8392 },
8393 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
8394 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
8395 # machine image.
8396 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8397 # For example:
8398 #
8399 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8400 # key_region/cryptoKeys/key
8401 #
8402 # The fully-qualifed key name may be returned for resource GET requests. For
8403 # example:
8404 #
8405 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8406 # key_region/cryptoKeys/key
8407 # /cryptoKeyVersions/1
8408 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8409 # key. If absent, the Compute Engine default service account is used.
8410 # For example:
8411 #
8412 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8413 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8414 # encryption key, encoded in RFC
8415 # 4648 base64 to either encrypt or decrypt this resource. You can
8416 # provide either the rawKey or thersaEncryptedKey.
8417 # For example:
8418 #
8419 # &quot;rawKey&quot;:
8420 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8421 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8422 # customer-supplied encryption key to either encrypt or decrypt this
8423 # resource. You can provide either the rawKey or thersaEncryptedKey.
8424 # For example:
8425 #
8426 # &quot;rsaEncryptedKey&quot;:
8427 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8428 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8429 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8430 #
8431 # The key must meet the following requirements before you can provide it to
8432 # Compute Engine:
8433 #
8434 # 1. The key is wrapped using a RSA public key certificate provided by
8435 # Google.
8436 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8437 # encoding.
8438 #
8439 # Gets the RSA public key certificate provided by Google at:
8440 #
8441 #
8442 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8443 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8444 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8445 # encryption key that protects this resource.
8446 },
8447 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
8448 # Engine has detected suspicious activity.
8449 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
8450 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
8451 # instance, see
8452 # Instance life cycle.
8453 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
8454 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
8455 # sources or targets for network firewalls and are specified by the client
8456 # during instance creation. The tags can be later modified by the setTags
8457 # method. Each tag within the list must comply withRFC1035.
8458 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
8459 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
8460 # the tags&#x27; contents and used for optimistic locking. The
8461 # fingerprint is initially generated by Compute Engine and changes after
8462 # every request to modify or update tags. You must always provide an
8463 # up-to-date fingerprint hash in order to update or change tags.
8464 #
8465 # To see the latest fingerprint, make get() request to the
8466 # instance.
8467 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
8468 # with RFC1035.
8469 &quot;A String&quot;,
8470 ],
8471 },
8472 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. [Output Only] DEPRECATED: Please useresource_status.upcoming_maintenance instead. Specifies
8473 # upcoming maintenance for the instance.
8474 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
8475 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
8476 # This value is inRFC3339
8477 # text format.
8478 # DEPRECATED: Use window_start_time instead.
8479 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
8480 # This timestamp value is in RFC3339 text format.
8481 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
8482 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
8483 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
8484 &quot;A String&quot;,
8485 ],
8486 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
8487 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
8488 # DEPRECATED: Use window_start_time instead.
8489 # TimeWindow is a container for two strings that represent timestamps in
8490 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
8491 &quot;earliest&quot;: &quot;A String&quot;,
8492 &quot;latest&quot;: &quot;A String&quot;,
8493 },
8494 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
8495 # This value is inRFC3339
8496 # text format.
8497 # DEPRECATED: Use window_start_time instead.
8498 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
8499 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
8500 # This timestamp value is in RFC3339 text format.
8501 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
8502 # This timestamp value is in RFC3339 text format.
8503 },
8504 &quot;workloadIdentityConfig&quot;: {
8505 &quot;identity&quot;: &quot;A String&quot;,
8506 &quot;identityCertificateEnabled&quot;: True or False,
8507 },
8508 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
8509 # You must specify this field as part of the HTTP request URL. It is
8510 # not settable as a field in the request body.
8511 }</pre>
8512 </div>
8513
8514 <div class="method">
8515 <code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</code>
8516 <pre>Returns effective firewalls applied to an interface of the instance.
8517
8518 Args:
8519 project: string, Project ID for this request. (required)
8520 zone: string, The name of the zone for this request. (required)
8521 instance: string, Name of the instance scoping this request. (required)
8522 networkInterface: string, The name of the network interface to get the effective firewalls. (required)
8523 x__xgafv: string, V1 error format.
8524 Allowed values
8525 1 - v1 error format
8526 2 - v2 error format
8527
8528 Returns:
8529 An object of the form:
8530
8531 {
8532 &quot;firewallPolicys&quot;: [ # [Output Only] Effective firewalls from firewall policies.
8533 {
8534 &quot;displayName&quot;: &quot;A String&quot;, # Output only. [Output Only] Deprecated, please use short name instead. The display name
8535 # of the firewall policy.
8536 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the firewall policy.
8537 &quot;packetMirroringRules&quot;: [ # Output only. [Output Only] The packet mirroring rules that apply to the instance.
8538 { # Represents a rule that describes one or more match conditions along with
8539 # the action to be taken when traffic matches this condition (allow or deny).
8540 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
8541 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
8542 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
8543 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
8544 # and &quot;goto_next&quot;.
8545 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
8546 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
8547 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
8548 # the firewall policy rule is not enforced and traffic behaves as if it did
8549 # not exist. If this is unspecified, the firewall policy rule will be
8550 # enabled.
8551 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
8552 # enabled, logs will be exported to the configured export destination in
8553 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
8554 # cannot enable logging on &quot;goto_next&quot; rules.
8555 &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.
8556 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
8557 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
8558 # Exactly one field must be specified.
8559 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
8560 # Maximum number of destination address groups is 10.
8561 &quot;A String&quot;,
8562 ],
8563 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
8564 # traffic destination.
8565 # Maximum number of destination fqdn allowed is 100.
8566 &quot;A String&quot;,
8567 ],
8568 &quot;destIpRanges&quot;: [ # CIDR IP address range.
8569 # Maximum number of destination CIDR IP ranges allowed is 5000.
8570 &quot;A String&quot;,
8571 ],
8572 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
8573 #
8574 #
8575 # - UNSPECIFIED
8576 # - INTERNET
8577 # - NON_INTERNET
8578 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
8579 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
8580 #
8581 #
8582 # - UNSPECIFIED
8583 # - INTERNET
8584 # - NON_INTERNET
8585 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
8586 # of traffic. Should be specified as 2 letter country code defined as per
8587 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
8588 # Maximum number of dest region codes allowed is 5000.
8589 &quot;A String&quot;,
8590 ],
8591 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
8592 # The IPs in these lists will be matched against traffic destination.
8593 &quot;A String&quot;,
8594 ],
8595 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
8596 {
8597 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
8598 # required when creating a firewall rule. This value can either be
8599 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
8600 # protocol number.
8601 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
8602 # only applicable for UDP or TCP protocol. Each entry must be either
8603 # an integer or a range. If not specified, this rule applies to
8604 # connections through any port.
8605 #
8606 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
8607 &quot;A String&quot;,
8608 ],
8609 },
8610 ],
8611 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
8612 # Maximum number of source address groups is 10.
8613 &quot;A String&quot;,
8614 ],
8615 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
8616 # traffic source.
8617 # Maximum number of source fqdn allowed is 100.
8618 &quot;A String&quot;,
8619 ],
8620 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
8621 # Maximum number of source CIDR IP ranges allowed is 5000.
8622 &quot;A String&quot;,
8623 ],
8624 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
8625 #
8626 #
8627 # - UNSPECIFIED
8628 # - INTERNET
8629 # - INTRA_VPC
8630 # - NON_INTERNET
8631 # - VPC_NETWORKS
8632 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
8633 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
8634 #
8635 #
8636 # - UNSPECIFIED
8637 # - INTERNET
8638 # - INTRA_VPC
8639 # - NON_INTERNET
8640 # - VPC_NETWORKS
8641 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
8642 &quot;A String&quot;,
8643 ],
8644 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
8645 # of traffic. Should be specified as 2 letter country code defined as per
8646 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
8647 # Maximum number of source region codes allowed is 5000.
8648 &quot;A String&quot;,
8649 ],
8650 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
8651 # of the traffic.
8652 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
8653 # and there is no srcIpRange, this rule will be ignored.
8654 # Maximum number of source tag values allowed is 256.
8655 {
8656 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
8657 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
8658 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
8659 # or its network is deleted.
8660 },
8661 ],
8662 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
8663 # The IPs in these lists will be matched against traffic source.
8664 &quot;A String&quot;,
8665 ],
8666 },
8667 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
8668 # must be a positive value between 0 and 2147483647.
8669 # Rules are evaluated from highest to lowest priority where 0 is the
8670 # highest priority and 2147483647 is the lowest priority.
8671 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
8672 # and can be updated.
8673 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
8674 # rule.
8675 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
8676 # Example:
8677 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
8678 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
8679 # &#x27;mirror&#x27;. Cannot be specified for other actions.
8680 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
8681 # This field allows you to control which load balancers get this rule.
8682 # For example, the following are valid values:
8683 #
8684 #
8685 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
8686 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
8687 # - projects/project/global/
8688 # forwardingRules/forwardingRule
8689 # - projects/project/regions/region/forwardingRules/
8690 # forwardingRule
8691 &quot;A String&quot;,
8692 ],
8693 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
8694 # allows you to control which network&#x27;s VMs get this rule. If this field
8695 # is left blank, all VMs within the organization will receive the rule.
8696 &quot;A String&quot;,
8697 ],
8698 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
8699 # applies to. If targetSecureTag are specified, then the
8700 # firewall rule applies only to instances in the VPC network that have one
8701 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
8702 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
8703 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
8704 # to all instances on the specified network.
8705 # Maximum number of target label tags allowed is 256.
8706 {
8707 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
8708 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
8709 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
8710 # or its network is deleted.
8711 },
8712 ],
8713 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
8714 # applied with this rule.
8715 &quot;A String&quot;,
8716 ],
8717 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
8718 # Default value is INSTANCES.
8719 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
8720 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
8721 # be set for other actions.
8722 },
8723 ],
8724 &quot;priority&quot;: 42, # Output only. [Output only] Priority of firewall policy association. Not applicable for
8725 # type=HIERARCHY.
8726 &quot;rules&quot;: [ # [Output Only] The rules that apply to the instance. Only rules that
8727 # target the specific VM instance are returned if target service accounts
8728 # or target secure tags are specified in the rules.
8729 { # Represents a rule that describes one or more match conditions along with
8730 # the action to be taken when traffic matches this condition (allow or deny).
8731 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
8732 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
8733 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
8734 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
8735 # and &quot;goto_next&quot;.
8736 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
8737 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
8738 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
8739 # the firewall policy rule is not enforced and traffic behaves as if it did
8740 # not exist. If this is unspecified, the firewall policy rule will be
8741 # enabled.
8742 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
8743 # enabled, logs will be exported to the configured export destination in
8744 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
8745 # cannot enable logging on &quot;goto_next&quot; rules.
8746 &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.
8747 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
8748 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
8749 # Exactly one field must be specified.
8750 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
8751 # Maximum number of destination address groups is 10.
8752 &quot;A String&quot;,
8753 ],
8754 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
8755 # traffic destination.
8756 # Maximum number of destination fqdn allowed is 100.
8757 &quot;A String&quot;,
8758 ],
8759 &quot;destIpRanges&quot;: [ # CIDR IP address range.
8760 # Maximum number of destination CIDR IP ranges allowed is 5000.
8761 &quot;A String&quot;,
8762 ],
8763 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
8764 #
8765 #
8766 # - UNSPECIFIED
8767 # - INTERNET
8768 # - NON_INTERNET
8769 &quot;destNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic destination.
8770 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
8771 #
8772 #
8773 # - UNSPECIFIED
8774 # - INTERNET
8775 # - NON_INTERNET
8776 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
8777 # of traffic. Should be specified as 2 letter country code defined as per
8778 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
8779 # Maximum number of dest region codes allowed is 5000.
8780 &quot;A String&quot;,
8781 ],
8782 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
8783 # The IPs in these lists will be matched against traffic destination.
8784 &quot;A String&quot;,
8785 ],
8786 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
8787 {
8788 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
8789 # required when creating a firewall rule. This value can either be
8790 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
8791 # protocol number.
8792 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
8793 # only applicable for UDP or TCP protocol. Each entry must be either
8794 # an integer or a range. If not specified, this rule applies to
8795 # connections through any port.
8796 #
8797 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
8798 &quot;A String&quot;,
8799 ],
8800 },
8801 ],
8802 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
8803 # Maximum number of source address groups is 10.
8804 &quot;A String&quot;,
8805 ],
8806 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
8807 # traffic source.
8808 # Maximum number of source fqdn allowed is 100.
8809 &quot;A String&quot;,
8810 ],
8811 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
8812 # Maximum number of source CIDR IP ranges allowed is 5000.
8813 &quot;A String&quot;,
8814 ],
8815 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
8816 #
8817 #
8818 # - UNSPECIFIED
8819 # - INTERNET
8820 # - INTRA_VPC
8821 # - NON_INTERNET
8822 # - VPC_NETWORKS
8823 &quot;srcNetworkScope&quot;: &quot;A String&quot;, # Network scope of the traffic source.
8824 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
8825 #
8826 #
8827 # - UNSPECIFIED
8828 # - INTERNET
8829 # - INTRA_VPC
8830 # - NON_INTERNET
8831 # - VPC_NETWORKS
8832 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
8833 &quot;A String&quot;,
8834 ],
8835 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
8836 # of traffic. Should be specified as 2 letter country code defined as per
8837 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
8838 # Maximum number of source region codes allowed is 5000.
8839 &quot;A String&quot;,
8840 ],
8841 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
8842 # of the traffic.
8843 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
8844 # and there is no srcIpRange, this rule will be ignored.
8845 # Maximum number of source tag values allowed is 256.
8846 {
8847 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
8848 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
8849 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
8850 # or its network is deleted.
8851 },
8852 ],
8853 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
8854 # The IPs in these lists will be matched against traffic source.
8855 &quot;A String&quot;,
8856 ],
8857 },
8858 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
8859 # must be a positive value between 0 and 2147483647.
8860 # Rules are evaluated from highest to lowest priority where 0 is the
8861 # highest priority and 2147483647 is the lowest priority.
8862 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
8863 # and can be updated.
8864 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
8865 # rule.
8866 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
8867 # Example:
8868 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
8869 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
8870 # &#x27;mirror&#x27;. Cannot be specified for other actions.
8871 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
8872 # This field allows you to control which load balancers get this rule.
8873 # For example, the following are valid values:
8874 #
8875 #
8876 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
8877 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
8878 # - projects/project/global/
8879 # forwardingRules/forwardingRule
8880 # - projects/project/regions/region/forwardingRules/
8881 # forwardingRule
8882 &quot;A String&quot;,
8883 ],
8884 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
8885 # allows you to control which network&#x27;s VMs get this rule. If this field
8886 # is left blank, all VMs within the organization will receive the rule.
8887 &quot;A String&quot;,
8888 ],
8889 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
8890 # applies to. If targetSecureTag are specified, then the
8891 # firewall rule applies only to instances in the VPC network that have one
8892 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
8893 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
8894 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
8895 # to all instances on the specified network.
8896 # Maximum number of target label tags allowed is 256.
8897 {
8898 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
8899 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
8900 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
8901 # or its network is deleted.
8902 },
8903 ],
8904 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
8905 # applied with this rule.
8906 &quot;A String&quot;,
8907 ],
8908 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
8909 # Default value is INSTANCES.
8910 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
8911 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
8912 # be set for other actions.
8913 },
8914 ],
8915 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy.
8916 &quot;type&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of the firewall policy. Can be one of HIERARCHY,
8917 # NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.
8918 },
8919 ],
8920 &quot;firewalls&quot;: [ # Effective firewalls on the instance.
8921 { # Represents a Firewall Rule resource.
8922 #
8923 # Firewall rules allow or deny ingress traffic to, and egress traffic from your
8924 # instances. For more information, readFirewall rules.
8925 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a
8926 # protocol and port-range tuple that describes a permitted connection.
8927 {
8928 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
8929 # required when creating a firewall rule. This value can either be one of the
8930 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
8931 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
8932 # This field is only applicable for the UDP or TCP protocol.
8933 # Each entry must be either an integer or a range.
8934 # If not specified, this rule applies to connections through any port.
8935 #
8936 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
8937 # and [&quot;12345-12349&quot;].
8938 &quot;A String&quot;,
8939 ],
8940 },
8941 ],
8942 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
8943 # text format.
8944 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a
8945 # protocol and port-range tuple that describes a denied connection.
8946 {
8947 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
8948 # required when creating a firewall rule. This value can either be one of the
8949 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
8950 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
8951 # This field is only applicable for the UDP or TCP protocol.
8952 # Each entry must be either an integer or a range.
8953 # If not specified, this rule applies to connections through any port.
8954 #
8955 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
8956 # and [&quot;12345-12349&quot;].
8957 &quot;A String&quot;,
8958 ],
8959 },
8960 ],
8961 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
8962 # create the resource.
8963 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to
8964 # traffic that has destination IP address in these ranges. These ranges must
8965 # be expressed inCIDR format. Both IPv4 and IPv6 are supported.
8966 &quot;A String&quot;,
8967 ],
8968 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or
8969 # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot
8970 # specify the sourceTags fields.
8971 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the
8972 # firewall rule is not enforced and the network behaves as if it did not
8973 # exist. If this is unspecified, the firewall rule will be enabled.
8974 &quot;enableLogging&quot;: True or False, # Deprecated in favor of enable in LogConfig.
8975 # This field denotes whether to enable logging for a particular
8976 # firewall rule. If logging is enabled, logs will be exported t
8977 # Cloud Logging.
8978 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
8979 # defined by the server.
8980 &quot;kind&quot;: &quot;compute#firewall&quot;, # Output only. [Output Only] Type of the resource. Always compute#firewall
8981 # for firewall rules.
8982 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If
8983 # logging is enabled, logs will be exported to Cloud Logging.
8984 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall
8985 # rule.
8986 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if
8987 # logging is enabled for that rule. This field denotes whether to include
8988 # or exclude metadata for firewall logs.
8989 },
8990 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
8991 # The name must be 1-63 characters long, and comply withRFC1035.
8992 # Specifically, the name must be 1-63 characters long and match the regular
8993 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character
8994 # must be a lowercase letter, and all following characters (except for the
8995 # last character) must be a dash, lowercase letter, or digit. The last
8996 # character must be a lowercase letter or digit.
8997 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not
8998 # specified when creating a firewall rule, the default network
8999 # is used:
9000 #
9001 # global/networks/default
9002 #
9003 # If you choose to specify this field, you can specify the network as a full
9004 # or partial URL. For example, the following are all valid URLs:
9005 #
9006 # -
9007 # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
9008 # - projects/myproject/global/networks/my-network
9009 # - global/networks/default
9010 &quot;params&quot;: { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
9011 # as part of resource payload.
9012 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
9013 # Tag keys and values have the same definition as resource
9014 # manager tags. The field is allowed for INSERT
9015 # only. The keys/values to set on the resource should be specified in
9016 # either ID { : } or Namespaced format
9017 # { : }.
9018 # For example the following are valid inputs:
9019 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
9020 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
9021 # Note:
9022 # * Invalid combinations of ID &amp; namespaced format is not supported. For
9023 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
9024 &quot;a_key&quot;: &quot;A String&quot;,
9025 },
9026 },
9027 &quot;priority&quot;: 42, # Priority for this rule.
9028 # This is an integer between `0` and `65535`, both inclusive.
9029 # The default value is `1000`.
9030 # Relative priorities determine which rule takes effect if multiple rules
9031 # apply. Lower values indicate higher priority. For example, a rule with
9032 # priority `0` has higher precedence than a rule with priority `1`.
9033 # DENY rules take precedence over ALLOW rules if they have equal priority.
9034 # Note that VPC networks have implied
9035 # rules with a priority of `65535`. To avoid conflicts with the implied
9036 # rules, use a priority number less than `65535`.
9037 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9038 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
9039 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic
9040 # that has a source IP address in these ranges. These ranges must be
9041 # expressed inCIDR format. One or both of sourceRanges
9042 # and sourceTags may be set.
9043 # If both fields are set, the rule applies to traffic that has a
9044 # source IP address within sourceRanges OR a source IP
9045 # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match
9046 # both fields for the rule to
9047 # apply. Both IPv4 and IPv6 are supported.
9048 &quot;A String&quot;,
9049 ],
9050 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to
9051 # traffic originating from an instance with a service account in this list.
9052 # Source service accounts cannot be used to control traffic to an instance&#x27;s
9053 # external IP address because service accounts are associated with an
9054 # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.
9055 # If both are set, the firewall applies to traffic that
9056 # has a source IP address within the sourceRanges OR a source
9057 # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match
9058 # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.
9059 &quot;A String&quot;,
9060 ],
9061 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic
9062 # with source IPs that match the primary network interfaces of VM instances
9063 # that have the tag and are in the same VPC network.
9064 # Source tags cannot be used to control traffic to an instance&#x27;s external IP
9065 # address, it only applies to traffic between instances in the same virtual
9066 # network. Because tags are associated with instances, not IP addresses.
9067 # One or both of sourceRanges and sourceTags may be
9068 # set. If both fields are set, the firewall applies to traffic that has a
9069 # source IP address within sourceRanges OR a source IP from a
9070 # resource with a matching tag listed in the sourceTags
9071 # field. The connection does not need to match both fields for the
9072 # firewall to apply.
9073 &quot;A String&quot;,
9074 ],
9075 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the
9076 # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.
9077 # If neither targetServiceAccounts nor targetTags
9078 # are specified, the firewall rule applies to all instances on the specified
9079 # network.
9080 &quot;A String&quot;,
9081 ],
9082 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule
9083 # applies to. If targetTags are specified, then the firewall
9084 # rule applies only to instances in the VPC network that have one of those
9085 # tags. If no targetTags are specified, the firewall rule
9086 # applies to all instances on the specified network.
9087 &quot;A String&quot;,
9088 ],
9089 },
9090 ],
9091 &quot;organizationFirewalls&quot;: [ # Effective firewalls from organization policies.
9092 { # A pruned SecurityPolicy containing ID and any applicable firewall rules.
9093 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier for the security policy. This
9094 # identifier is defined by the server.
9095 &quot;rules&quot;: [ # The rules that apply to the network.
9096 { # Represents a rule that describes one or more match conditions along with
9097 # the action to be taken when traffic matches this condition (allow or deny).
9098 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the rule is matched.
9099 # The following are the valid actions:
9100 #
9101 # - allow: allow access to target.
9102 # - deny(STATUS): deny access to target, returns the
9103 # HTTP response code specified. Valid values for `STATUS`
9104 # are 403, 404, and 502.
9105 # - rate_based_ban: limit client traffic to the configured
9106 # threshold and ban the client if the traffic exceeds the threshold.
9107 # Configure parameters for this action in RateLimitOptions. Requires
9108 # rate_limit_options to be set.
9109 # - redirect: redirect to a different target. This can
9110 # either be an internal reCAPTCHA redirect, or an external URL-based
9111 # redirect via a 302 response. Parameters for this action can be configured
9112 # via redirectOptions. This action is only supported in Global Security
9113 # Policies of type CLOUD_ARMOR.
9114 # - throttle: limit
9115 # client traffic to the configured threshold. Configure parameters for this
9116 # action in rateLimitOptions. Requires rate_limit_options to be set for
9117 # this.
9118 # - fairshare (preview only): when traffic reaches the
9119 # threshold limit, requests from the clients matching this rule begin to be
9120 # rate-limited using the Fair Share algorithm. This action is only allowed
9121 # in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
9122 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
9123 # create the resource.
9124 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies. This field may only be
9125 # specified when versioned_expr is set to FIREWALL.
9126 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
9127 # enabled, logs will be exported to the configured export destination in
9128 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
9129 # cannot enable logging on &quot;goto_next&quot; rules.
9130 #
9131 # This field may only be specified when the versioned_expr is set to
9132 # FIREWALL.
9133 &quot;headerAction&quot;: { # Optional, additional actions that are performed on headers.
9134 # This field is only supported in Global Security Policies of type
9135 # CLOUD_ARMOR.
9136 &quot;requestHeadersToAdds&quot;: [ # The list of request headers to add or overwrite if they&#x27;re already
9137 # present.
9138 {
9139 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to set.
9140 &quot;headerValue&quot;: &quot;A String&quot;, # The value to set the named header to.
9141 },
9142 ],
9143 },
9144 &quot;kind&quot;: &quot;compute#securityPolicyRule&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules
9145 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
9146 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
9147 # Exactly one field must be specified.
9148 &quot;config&quot;: { # The configuration options available when specifying versioned_expr.
9149 # This field must be specified if versioned_expr is specified and cannot
9150 # be specified if versioned_expr is not specified.
9151 &quot;destIpRanges&quot;: [ # CIDR IP address range.
9152 #
9153 # This field may only be specified when versioned_expr is set to
9154 # FIREWALL.
9155 &quot;A String&quot;,
9156 ],
9157 &quot;destPorts&quot;: [ # Pairs of IP protocols and ports that the rule should match.
9158 #
9159 # This field may only be specified when versioned_expr is set to
9160 # FIREWALL.
9161 {
9162 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
9163 # required when creating a firewall rule. This value can either be
9164 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
9165 # protocol number.
9166 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
9167 # only applicable for UDP or TCP protocol. Each entry must be either
9168 # an integer or a range. If not specified, this rule applies to
9169 # connections through any port.
9170 #
9171 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
9172 #
9173 # This field may only be specified when versioned_expr is set to
9174 # FIREWALL.
9175 &quot;A String&quot;,
9176 ],
9177 },
9178 ],
9179 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
9180 #
9181 # This field may only be specified when versioned_expr is set to
9182 # FIREWALL.
9183 {
9184 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
9185 # required when creating a firewall rule. This value can either be
9186 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
9187 # protocol number.
9188 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
9189 # only applicable for UDP or TCP protocol. Each entry must be either
9190 # an integer or a range. If not specified, this rule applies to
9191 # connections through any port.
9192 #
9193 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
9194 #
9195 # This field may only be specified when versioned_expr is set to
9196 # FIREWALL.
9197 &quot;A String&quot;,
9198 ],
9199 },
9200 ],
9201 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
9202 # Maximum number of src_ip_ranges allowed is 10.
9203 &quot;A String&quot;,
9204 ],
9205 },
9206 &quot;expr&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # User defined CEVAL expression.
9207 # A CEVAL expression is used to specify match criteria such as origin.ip,
9208 # source.region_code and contents in the request header.
9209 # Expressions containing `evaluateThreatIntelligence` require a Cloud
9210 # Armor Enterprise subscription and are not supported in Edge Policies
9211 # nor in Regional Policies. Expressions containing
9212 # `evaluatePreconfiguredExpr(&#x27;sourceiplist-*&#x27;)` require a Cloud Armor
9213 # Enterprise subscription and are only supported in Global Security
9214 # Policies.
9215 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9216 # are documented at https://github.com/google/cel-spec.
9217 #
9218 # Example (Comparison):
9219 #
9220 # title: &quot;Summary size limit&quot;
9221 # description: &quot;Determines if a summary is less than 100 chars&quot;
9222 # expression: &quot;document.summary.size() &lt; 100&quot;
9223 #
9224 # Example (Equality):
9225 #
9226 # title: &quot;Requestor is owner&quot;
9227 # description: &quot;Determines if requestor is the document owner&quot;
9228 # expression: &quot;document.owner == request.auth.claims.email&quot;
9229 #
9230 # Example (Logic):
9231 #
9232 # title: &quot;Public documents&quot;
9233 # description: &quot;Determine whether the document should be publicly visible&quot;
9234 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9235 #
9236 # Example (Data Manipulation):
9237 #
9238 # title: &quot;Notification string&quot;
9239 # description: &quot;Create a notification string with a timestamp.&quot;
9240 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9241 #
9242 # The exact variables and functions that may be referenced within an expression
9243 # are determined by the service that evaluates it. See the service
9244 # documentation for additional information.
9245 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9246 # describes the expression, e.g. when hovered over it in a UI.
9247 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9248 # syntax.
9249 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9250 # reporting, e.g. a file name and a position in the file.
9251 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9252 # its purpose. This can be used e.g. in UIs which allow to enter the
9253 # expression.
9254 },
9255 &quot;exprOptions&quot;: { # The configuration options available when specifying a user defined
9256 # CEVAL expression (i.e., &#x27;expr&#x27;).
9257 &quot;recaptchaOptions&quot;: { # reCAPTCHA configuration options to be applied for the rule. If the
9258 # rule does not evaluate reCAPTCHA tokens, this field has no effect.
9259 &quot;actionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
9260 # action-tokens. The provided site keys need to be created from
9261 # reCAPTCHA API under the same project where the security policy is
9262 # created.
9263 &quot;A String&quot;,
9264 ],
9265 &quot;sessionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
9266 # session-tokens. The provided site keys need to be created from
9267 # reCAPTCHA API under the same project where the security policy is
9268 # created.
9269 &quot;A String&quot;,
9270 ],
9271 },
9272 },
9273 &quot;versionedExpr&quot;: &quot;A String&quot;, # Preconfigured versioned expression.
9274 # If this field is specified, config must also be specified.
9275 # Available preconfigured expressions along with their requirements are:
9276 # SRC_IPS_V1 - must specify the corresponding src_ip_range field in
9277 # config.
9278 },
9279 &quot;networkMatch&quot;: { # Represents a match condition that incoming network traffic is evaluated # A match condition that incoming packets are evaluated against for
9280 # CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding
9281 # &#x27;action&#x27; is enforced.
9282 #
9283 # The match criteria for a rule consists of built-in match fields (like
9284 # &#x27;srcIpRanges&#x27;) and potentially multiple user-defined match fields
9285 # (&#x27;userDefinedFields&#x27;).
9286 #
9287 # Field values may be extracted directly from the packet or derived from it
9288 # (e.g. &#x27;srcRegionCodes&#x27;). Some fields may not be present in every packet
9289 # (e.g. &#x27;srcPorts&#x27;). A user-defined field is only present if the base
9290 # header is found in the packet and the entire field is in bounds.
9291 #
9292 # Each match field may specify which values can match it, listing one or
9293 # more ranges, prefixes, or exact values that are considered a match for
9294 # the field. A field value must be present in order to match a specified
9295 # match field. If no match values are specified for a match field, then any
9296 # field value is considered to match it, and it&#x27;s not required to be
9297 # present. For strings specifying &#x27;*&#x27; is also equivalent to match all.
9298 #
9299 # For a packet to match a rule, all specified match fields must match the
9300 # corresponding field values derived from the packet.
9301 #
9302 # Example:
9303 #
9304 # networkMatch:
9305 # srcIpRanges:
9306 # - &quot;192.0.2.0/24&quot;
9307 # - &quot;198.51.100.0/24&quot;
9308 # userDefinedFields:
9309 # - name: &quot;ipv4_fragment_offset&quot;
9310 # values:
9311 # - &quot;1-0x1fff&quot;
9312 #
9313 # The above match condition matches packets with a source IP in
9314 # 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named
9315 # &quot;ipv4_fragment_offset&quot; with a value between 1 and 0x1fff inclusive.
9316 # against.
9317 &quot;destIpRanges&quot;: [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text
9318 # format.
9319 &quot;A String&quot;,
9320 ],
9321 &quot;destPorts&quot;: [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
9322 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
9323 &quot;A String&quot;,
9324 ],
9325 &quot;ipProtocols&quot;: [ # IPv4 protocol / IPv6 next header (after extension headers). Each
9326 # element can be an 8-bit unsigned decimal number (e.g. &quot;6&quot;), range (e.g.
9327 # &quot;253-254&quot;), or one of the following protocol names: &quot;tcp&quot;, &quot;udp&quot;,
9328 # &quot;icmp&quot;, &quot;esp&quot;, &quot;ah&quot;, &quot;ipip&quot;, or &quot;sctp&quot;.
9329 &quot;A String&quot;,
9330 ],
9331 &quot;srcAsns&quot;: [ # BGP Autonomous System Number associated with the source IP address.
9332 42,
9333 ],
9334 &quot;srcIpRanges&quot;: [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
9335 &quot;A String&quot;,
9336 ],
9337 &quot;srcPorts&quot;: [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
9338 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
9339 &quot;A String&quot;,
9340 ],
9341 &quot;srcRegionCodes&quot;: [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source
9342 # IP address.
9343 &quot;A String&quot;,
9344 ],
9345 &quot;userDefinedFields&quot;: [ # User-defined fields. Each element names a defined field and lists the
9346 # matching values for that field.
9347 {
9348 &quot;name&quot;: &quot;A String&quot;, # Name of the user-defined field, as given in the definition.
9349 &quot;values&quot;: [ # Matching values of the field. Each element can be a 32-bit unsigned
9350 # decimal or hexadecimal (starting with &quot;0x&quot;) number (e.g. &quot;64&quot;) or
9351 # range (e.g. &quot;0x400-0x7ff&quot;).
9352 &quot;A String&quot;,
9353 ],
9354 },
9355 ],
9356 },
9357 &quot;preconfiguredWafConfig&quot;: { # Preconfigured WAF configuration to be applied for the rule. If the rule
9358 # does not evaluate preconfigured WAF rules, i.e., if
9359 # evaluatePreconfiguredWaf() is not used, this field will have no effect.
9360 &quot;exclusions&quot;: [ # A list of exclusions to apply during preconfigured WAF evaluation.
9361 {
9362 &quot;requestBodiesToExclude&quot;: [ # A list of request body fields to be excluded from inspection during
9363 # preconfigured WAF evaluation.
9364 {
9365 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
9366 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
9367 },
9368 ],
9369 &quot;requestCookiesToExclude&quot;: [ # A list of request cookie names whose value will be excluded from
9370 # inspection during preconfigured WAF evaluation.
9371 {
9372 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
9373 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
9374 },
9375 ],
9376 &quot;requestHeadersToExclude&quot;: [ # A list of request header names whose value will be excluded from
9377 # inspection during preconfigured WAF evaluation.
9378 {
9379 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
9380 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
9381 },
9382 ],
9383 &quot;requestQueryParamsToExclude&quot;: [ # A list of request query parameter names whose value will be excluded
9384 # from inspection during preconfigured WAF evaluation. Note that the
9385 # parameter can be in the query string or in the POST body.
9386 {
9387 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
9388 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
9389 },
9390 ],
9391 &quot;requestUrisToExclude&quot;: [ # A list of request URIs from the request line to be excluded from
9392 # inspection during preconfigured WAF evaluation. When specifying this
9393 # field, the query or fragment part should be excluded.
9394 {
9395 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
9396 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
9397 },
9398 ],
9399 &quot;targetRuleIds&quot;: [ # A list of target rule IDs under the WAF rule set to apply the
9400 # preconfigured WAF exclusion. If omitted, it refers to all the rule
9401 # IDs under the WAF rule set.
9402 &quot;A String&quot;,
9403 ],
9404 &quot;targetRuleSet&quot;: &quot;A String&quot;, # Target WAF rule set to apply the preconfigured WAF exclusion.
9405 },
9406 ],
9407 },
9408 &quot;preview&quot;: True or False, # If set to true, the specified action is not enforced.
9409 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
9410 # must be a positive value between 0 and 2147483647.
9411 # Rules are evaluated from highest to lowest priority where 0 is the
9412 # highest priority and 2147483647 is the lowest priority.
9413 &quot;rateLimitOptions&quot;: { # Must be specified if the action is &quot;rate_based_ban&quot; or &quot;throttle&quot; or
9414 # &quot;fairshare&quot;. Cannot be specified for any other actions.
9415 &quot;banDurationSec&quot;: 42, # Can only be specified if the action for the rule is
9416 # &quot;rate_based_ban&quot;. If specified, determines the time (in seconds)
9417 # the traffic will continue to be banned by the rate limit after the
9418 # rate falls below the threshold.
9419 &quot;banThreshold&quot;: { # Can only be specified if the action for the rule is
9420 # &quot;rate_based_ban&quot;. If specified, the key will be banned for the
9421 # configured &#x27;ban_duration_sec&#x27; when the number of requests that exceed
9422 # the &#x27;rate_limit_threshold&#x27; also exceed this &#x27;ban_threshold&#x27;.
9423 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
9424 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
9425 },
9426 &quot;conformAction&quot;: &quot;A String&quot;, # Action to take for requests that are under the configured rate limit
9427 # threshold. Valid option is &quot;allow&quot; only.
9428 &quot;enforceOnKey&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
9429 # values are:
9430 #
9431 # - ALL: A single rate limit threshold is applied to all
9432 # the requests matching this rule. This is the default value if
9433 # &quot;enforceOnKey&quot; is not configured.
9434 # - IP: The source IP address of
9435 # the request is the key. Each IP has this limit enforced
9436 # separately.
9437 # - HTTP_HEADER: The value of the HTTP
9438 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
9439 # value is truncated to the first 128 bytes of the header value. If no
9440 # such header is present in the request, the key type defaults toALL.
9441 # - XFF_IP: The first IP address (i.e. the
9442 # originating client IP address) specified in the list of IPs under
9443 # X-Forwarded-For HTTP header. If no such header is present or the value
9444 # is not a valid IP, the key defaults to the source IP address of
9445 # the request i.e. key type IP.
9446 # - HTTP_COOKIE: The value of the HTTP
9447 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
9448 # value is truncated to the first 128 bytes of the cookie value. If no
9449 # such cookie is present in the request, the key type defaults toALL.
9450 # - HTTP_PATH: The URL path of the HTTP request. The key
9451 # value is truncated to the first 128 bytes.
9452 # - SNI: Server name indication in the TLS session of the
9453 # HTTPS request. The key value is truncated to the first 128 bytes. The
9454 # key type defaults to ALL on a HTTP session.
9455 # - REGION_CODE: The country/region from which the request
9456 # originates.
9457 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
9458 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
9459 # key type defaults to ALL.
9460 # - USER_IP: The IP address of the originating client,
9461 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
9462 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration or
9463 # an IP address cannot be resolved from it, the key type defaults toIP.
9464 #
9465 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
9466 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
9467 # key type defaults to ALL.
9468 # For &quot;fairshare&quot; action, this value is limited to ALL i.e. a single rate
9469 # limit threshold is enforced for all the requests matching the rule.
9470 &quot;enforceOnKeyConfigs&quot;: [ # If specified, any combination of values of
9471 # enforce_on_key_type/enforce_on_key_name is treated as the key on which
9472 # ratelimit threshold/action is enforced. You can specify up to 3
9473 # enforce_on_key_configs. If enforce_on_key_configs is specified,
9474 # enforce_on_key must not be specified.
9475 {
9476 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
9477 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the
9478 # key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is
9479 # taken as the key value.
9480 &quot;enforceOnKeyType&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
9481 # values are:
9482 #
9483 # - ALL: A single rate limit threshold is applied to all
9484 # the requests matching this rule. This is the default value if
9485 # &quot;enforceOnKeyConfigs&quot; is not configured.
9486 # - IP: The source IP address of
9487 # the request is the key. Each IP has this limit enforced
9488 # separately.
9489 # - HTTP_HEADER: The value of the HTTP
9490 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
9491 # value is truncated to the first 128 bytes of the header value. If no
9492 # such header is present in the request, the key type defaults toALL.
9493 # - XFF_IP: The first IP address (i.e. the
9494 # originating client IP address) specified in the list of IPs under
9495 # X-Forwarded-For HTTP header. If no such header is present or the
9496 # value is not a valid IP, the key defaults to the source IP address of
9497 # the request i.e. key type IP.
9498 # - HTTP_COOKIE: The value of the HTTP
9499 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
9500 # value is truncated to the first 128 bytes of the cookie value. If no
9501 # such cookie is present in the request, the key type defaults toALL.
9502 # - HTTP_PATH: The URL path of the HTTP request. The key
9503 # value is truncated to the first 128 bytes.
9504 # - SNI: Server name indication in the TLS session of
9505 # the HTTPS request. The key value is truncated to the first 128 bytes.
9506 # The key type defaults to ALL on a HTTP session.
9507 # - REGION_CODE: The country/region from which the
9508 # request originates.
9509 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
9510 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
9511 # key type defaults to ALL.
9512 # - USER_IP: The IP address of the originating client,
9513 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
9514 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration
9515 # or an IP address cannot be resolved from it, the key type defaults toIP.
9516 #
9517 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
9518 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
9519 # key type defaults to ALL.
9520 },
9521 ],
9522 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
9523 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the key
9524 # value.
9525 # HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key
9526 # value.
9527 &quot;exceedAction&quot;: &quot;A String&quot;, # Action to take for requests that are above the configured rate limit
9528 # threshold, to either deny with a specified HTTP response code, or
9529 # redirect to a different endpoint.
9530 # Valid options are `deny(STATUS)`, where valid values for
9531 # `STATUS` are 403, 404, 429, and 502, and
9532 # `redirect`, where the redirect parameters come from
9533 # `exceedRedirectOptions` below.
9534 # The `redirect` action is only supported in Global Security Policies of
9535 # type CLOUD_ARMOR.
9536 &quot;exceedActionRpcStatus&quot;: { # Simplified google.rpc.Status type (omitting details). # Specified gRPC response status for proxyless gRPC requests that are
9537 # above the configured rate limit threshold
9538 &quot;code&quot;: 42, # The status code, which should be an enum value of
9539 # google.rpc.Code.
9540 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English.
9541 },
9542 &quot;exceedRedirectOptions&quot;: { # Parameters defining the redirect action that is used as the exceed
9543 # action. Cannot be specified if the exceed action is not redirect.
9544 # This field is only supported in Global Security Policies of type
9545 # CLOUD_ARMOR.
9546 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
9547 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
9548 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
9549 #
9550 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
9551 # challenge assessment.
9552 # - EXTERNAL_302: redirect to a different URL via a 302
9553 # response.
9554 },
9555 &quot;rateLimitThreshold&quot;: { # Threshold at which to begin ratelimiting.
9556 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
9557 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
9558 },
9559 },
9560 &quot;redirectOptions&quot;: { # Parameters defining the redirect action. Cannot be specified for any
9561 # other actions.
9562 # This field is only supported in Global Security Policies of type
9563 # CLOUD_ARMOR.
9564 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
9565 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
9566 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
9567 #
9568 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
9569 # challenge assessment.
9570 # - EXTERNAL_302: redirect to a different URL via a 302
9571 # response.
9572 },
9573 &quot;redirectTarget&quot;: &quot;A String&quot;, # This must be specified for redirect actions. Cannot be specified for any
9574 # other actions.
9575 &quot;ruleManagedProtectionTier&quot;: &quot;A String&quot;, # Output only. [Output Only] The minimum Cloud Armor subscription required for this
9576 # rule.
9577 # [Deprecated] Use requiredManagedProtectionTiers instead.
9578 &quot;ruleNumber&quot;: &quot;A String&quot;, # Identifier for the rule. This is only unique within the given security
9579 # policy. This can only be set during rule creation, if rule number is not
9580 # specified it will be generated by the server.
9581 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall security
9582 # policy rule.
9583 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
9584 # allows you to control which network&#x27;s VMs get this rule. If this field
9585 # is left blank, all VMs within the organization will receive the rule.
9586 #
9587 # This field may only be specified when versioned_expr is set to FIREWALL.
9588 &quot;A String&quot;,
9589 ],
9590 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
9591 # applied with this rule.
9592 &quot;A String&quot;,
9593 ],
9594 },
9595 ],
9596 },
9597 ],
9598 }</pre>
9599 </div>
9600
9601 <div class="method">
9602 <code class="details" id="getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None, x__xgafv=None)</code>
9603 <pre>Returns the specified guest attributes entry.
9604
9605 Args:
9606 project: string, Project ID for this request. (required)
9607 zone: string, The name of the zone for this request. (required)
9608 instance: string, Name of the instance scoping this request. (required)
9609 queryPath: string, Specifies the guest attributes path to be queried.
9610 variableKey: string, Specifies the key for the guest attributes entry.
9611 x__xgafv: string, V1 error format.
9612 Allowed values
9613 1 - v1 error format
9614 2 - v2 error format
9615
9616 Returns:
9617 An object of the form:
9618
9619 { # A guest attributes entry.
9620 &quot;kind&quot;: &quot;compute#guestAttributes&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#guestAttributes for guest attributes entry.
9621 &quot;queryPath&quot;: &quot;A String&quot;, # The path to be queried. This can be the default namespace (&#x27;&#x27;) or a
9622 # nested namespace (&#x27;\/&#x27;) or a specified key
9623 # (&#x27;\/\&#x27;).
9624 &quot;queryValue&quot;: { # Array of guest attribute namespace/key/value tuples. # Output only. [Output Only] The value of the requested queried path.
9625 &quot;items&quot;: [
9626 { # A guest attributes namespace/key/value entry.
9627 &quot;key&quot;: &quot;A String&quot;, # Key for the guest attribute entry.
9628 &quot;namespace&quot;: &quot;A String&quot;, # Namespace for the guest attribute entry.
9629 &quot;value&quot;: &quot;A String&quot;, # Value for the guest attribute entry.
9630 },
9631 ],
9632 },
9633 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
9634 &quot;variableKey&quot;: &quot;A String&quot;, # The key to search for.
9635 &quot;variableValue&quot;: &quot;A String&quot;, # Output only. [Output Only] The value found for the requested key.
9636 }</pre>
9637 </div>
9638
9639 <div class="method">
9640 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
9641 <pre>Gets the access control policy for a resource. May be empty if no such
9642 policy or resource exists.
9643
9644 Args:
9645 project: string, Project ID for this request. (required)
9646 zone: string, The name of the zone for this request. (required)
9647 resource: string, Name or id of the resource for this request. (required)
9648 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
9649 x__xgafv: string, V1 error format.
9650 Allowed values
9651 1 - v1 error format
9652 2 - v2 error format
9653
9654 Returns:
9655 An object of the form:
9656
9657 { # An Identity and Access Management (IAM) policy, which specifies access
9658 # controls for Google Cloud resources.
9659 #
9660 #
9661 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
9662 # `members`, or principals, to a single `role`. Principals can be user
9663 # accounts, service accounts, Google groups, and domains (such as G Suite). A
9664 # `role` is a named list of permissions; each `role` can be an IAM predefined
9665 # role or a user-created custom role.
9666 #
9667 # For some types of Google Cloud resources, a `binding` can also specify a
9668 # `condition`, which is a logical expression that allows access to a resource
9669 # only if the expression evaluates to `true`. A condition can add constraints
9670 # based on attributes of the request, the resource, or both. To learn which
9671 # resources support conditions in their IAM policies, see the
9672 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9673 #
9674 # **JSON example:**
9675 #
9676 # ```
9677 # {
9678 # &quot;bindings&quot;: [
9679 # {
9680 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
9681 # &quot;members&quot;: [
9682 # &quot;user:[email protected]&quot;,
9683 # &quot;group:[email protected]&quot;,
9684 # &quot;domain:google.com&quot;,
9685 # &quot;serviceAccount:[email protected]&quot;
9686 # ]
9687 # },
9688 # {
9689 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
9690 # &quot;members&quot;: [
9691 # &quot;user:[email protected]&quot;
9692 # ],
9693 # &quot;condition&quot;: {
9694 # &quot;title&quot;: &quot;expirable access&quot;,
9695 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
9696 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
9697 # }
9698 # }
9699 # ],
9700 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
9701 # &quot;version&quot;: 3
9702 # }
9703 # ```
9704 #
9705 # **YAML example:**
9706 #
9707 # ```
9708 # bindings:
9709 # - members:
9710 # - user:[email protected]
9711 # - group:[email protected]
9712 # - domain:google.com
9713 # - serviceAccount:[email protected]
9714 # role: roles/resourcemanager.organizationAdmin
9715 # - members:
9716 # - user:[email protected]
9717 # role: roles/resourcemanager.organizationViewer
9718 # condition:
9719 # title: expirable access
9720 # description: Does not grant access after Sep 2020
9721 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
9722 # etag: BwWWja0YfJA=
9723 # version: 3
9724 # ```
9725 #
9726 # For a description of IAM and its features, see the
9727 # [IAM documentation](https://cloud.google.com/iam/docs/).
9728 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
9729 { # Specifies the audit configuration for a service.
9730 # The configuration determines which permission types are logged, and what
9731 # identities, if any, are exempted from logging.
9732 # An AuditConfig must have one or more AuditLogConfigs.
9733 #
9734 # If there are AuditConfigs for both `allServices` and a specific service,
9735 # the union of the two AuditConfigs is used for that service: the log_types
9736 # specified in each AuditConfig are enabled, and the exempted_members in each
9737 # AuditLogConfig are exempted.
9738 #
9739 # Example Policy with multiple AuditConfigs:
9740 #
9741 # {
9742 # &quot;audit_configs&quot;: [
9743 # {
9744 # &quot;service&quot;: &quot;allServices&quot;,
9745 # &quot;audit_log_configs&quot;: [
9746 # {
9747 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
9748 # &quot;exempted_members&quot;: [
9749 # &quot;user:[email protected]&quot;
9750 # ]
9751 # },
9752 # {
9753 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
9754 # },
9755 # {
9756 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
9757 # }
9758 # ]
9759 # },
9760 # {
9761 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
9762 # &quot;audit_log_configs&quot;: [
9763 # {
9764 # &quot;log_type&quot;: &quot;DATA_READ&quot;
9765 # },
9766 # {
9767 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
9768 # &quot;exempted_members&quot;: [
9769 # &quot;user:[email protected]&quot;
9770 # ]
9771 # }
9772 # ]
9773 # }
9774 # ]
9775 # }
9776 #
9777 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
9778 # logging. It also exempts `[email protected]` from DATA_READ logging, and
9779 # `[email protected]` from DATA_WRITE logging.
9780 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
9781 { # Provides the configuration for logging a type of permissions.
9782 # Example:
9783 #
9784 # {
9785 # &quot;audit_log_configs&quot;: [
9786 # {
9787 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
9788 # &quot;exempted_members&quot;: [
9789 # &quot;user:[email protected]&quot;
9790 # ]
9791 # },
9792 # {
9793 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
9794 # }
9795 # ]
9796 # }
9797 #
9798 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
9799 # [email protected] from DATA_READ logging.
9800 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
9801 # permission.
9802 # Follows the same format of Binding.members.
9803 &quot;A String&quot;,
9804 ],
9805 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
9806 },
9807 ],
9808 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
9809 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
9810 # `allServices` is a special value that covers all services.
9811 },
9812 ],
9813 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
9814 # may specify a `condition` that determines how and when the `bindings` are
9815 # applied. Each of the `bindings` must contain at least one principal.
9816 #
9817 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
9818 # of these principals can be Google groups. Each occurrence of a principal
9819 # counts towards these limits. For example, if the `bindings` grant 50
9820 # different roles to `user:[email protected]`, and not to any other
9821 # principal, then you can add another 1,450 principals to the `bindings` in
9822 # the `Policy`.
9823 { # Associates `members`, or principals, with a `role`.
9824 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
9825 #
9826 # If the condition evaluates to `true`, then this binding applies to the
9827 # current request.
9828 #
9829 # If the condition evaluates to `false`, then this binding does not apply to
9830 # the current request. However, a different role binding might grant the same
9831 # role to one or more of the principals in this binding.
9832 #
9833 # To learn which resources support conditions in their IAM policies, see the
9834 # [IAM
9835 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9836 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9837 # are documented at https://github.com/google/cel-spec.
9838 #
9839 # Example (Comparison):
9840 #
9841 # title: &quot;Summary size limit&quot;
9842 # description: &quot;Determines if a summary is less than 100 chars&quot;
9843 # expression: &quot;document.summary.size() &lt; 100&quot;
9844 #
9845 # Example (Equality):
9846 #
9847 # title: &quot;Requestor is owner&quot;
9848 # description: &quot;Determines if requestor is the document owner&quot;
9849 # expression: &quot;document.owner == request.auth.claims.email&quot;
9850 #
9851 # Example (Logic):
9852 #
9853 # title: &quot;Public documents&quot;
9854 # description: &quot;Determine whether the document should be publicly visible&quot;
9855 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9856 #
9857 # Example (Data Manipulation):
9858 #
9859 # title: &quot;Notification string&quot;
9860 # description: &quot;Create a notification string with a timestamp.&quot;
9861 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9862 #
9863 # The exact variables and functions that may be referenced within an expression
9864 # are determined by the service that evaluates it. See the service
9865 # documentation for additional information.
9866 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9867 # describes the expression, e.g. when hovered over it in a UI.
9868 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9869 # syntax.
9870 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9871 # reporting, e.g. a file name and a position in the file.
9872 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9873 # its purpose. This can be used e.g. in UIs which allow to enter the
9874 # expression.
9875 },
9876 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
9877 # `members` can have the following values:
9878 #
9879 # * `allUsers`: A special identifier that represents anyone who is
9880 # on the internet; with or without a Google account.
9881 #
9882 # * `allAuthenticatedUsers`: A special identifier that represents anyone
9883 # who is authenticated with a Google account or a service account.
9884 # Does not include identities that come from external identity providers
9885 # (IdPs) through identity federation.
9886 #
9887 # * `user:{emailid}`: An email address that represents a specific Google
9888 # account. For example, `[email protected]` .
9889 #
9890 #
9891 # * `serviceAccount:{emailid}`: An email address that represents a Google
9892 # service account. For example,
9893 # `[email protected]`.
9894 #
9895 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
9896 # identifier for a
9897 # [Kubernetes service
9898 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
9899 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
9900 #
9901 # * `group:{emailid}`: An email address that represents a Google group.
9902 # For example, `[email protected]`.
9903 #
9904 #
9905 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
9906 # users of that domain. For example, `google.com` or `example.com`.
9907 #
9908 #
9909 #
9910 #
9911 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
9912 # A single identity in a workforce identity pool.
9913 #
9914 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
9915 # All workforce identities in a group.
9916 #
9917 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
9918 # All workforce identities with a specific attribute value.
9919 #
9920 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
9921 # All identities in a workforce identity pool.
9922 #
9923 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
9924 # A single identity in a workload identity pool.
9925 #
9926 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
9927 # A workload identity pool group.
9928 #
9929 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
9930 # All identities in a workload identity pool with a certain attribute.
9931 #
9932 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
9933 # All identities in a workload identity pool.
9934 #
9935 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
9936 # identifier) representing a user that has been recently deleted. For
9937 # example, `[email protected]?uid=123456789012345678901`. If the user is
9938 # recovered, this value reverts to `user:{emailid}` and the recovered user
9939 # retains the role in the binding.
9940 #
9941 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
9942 # unique identifier) representing a service account that has been recently
9943 # deleted. For example,
9944 # `[email protected]?uid=123456789012345678901`.
9945 # If the service account is undeleted, this value reverts to
9946 # `serviceAccount:{emailid}` and the undeleted service account retains the
9947 # role in the binding.
9948 #
9949 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
9950 # identifier) representing a Google group that has been recently
9951 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
9952 # the group is recovered, this value reverts to `group:{emailid}` and the
9953 # recovered group retains the role in the binding.
9954 #
9955 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
9956 # Deleted single identity in a workforce identity pool. For example,
9957 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
9958 &quot;A String&quot;,
9959 ],
9960 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
9961 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
9962 #
9963 # For an overview of the IAM roles and permissions, see the
9964 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
9965 # a list of the available pre-defined roles, see
9966 # [here](https://cloud.google.com/iam/docs/understanding-roles).
9967 },
9968 ],
9969 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
9970 # prevent simultaneous updates of a policy from overwriting each other.
9971 # It is strongly suggested that systems make use of the `etag` in the
9972 # read-modify-write cycle to perform policy updates in order to avoid race
9973 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
9974 # systems are expected to put that etag in the request to `setIamPolicy` to
9975 # ensure that their change will be applied to the same version of the policy.
9976 #
9977 # **Important:** If you use IAM Conditions, you must include the `etag` field
9978 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9979 # you to overwrite a version `3` policy with a version `1` policy, and all of
9980 # the conditions in the version `3` policy are lost.
9981 &quot;version&quot;: 42, # Specifies the format of the policy.
9982 #
9983 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
9984 # are rejected.
9985 #
9986 # Any operation that affects conditional role bindings must specify version
9987 # `3`. This requirement applies to the following operations:
9988 #
9989 # * Getting a policy that includes a conditional role binding
9990 # * Adding a conditional role binding to a policy
9991 # * Changing a conditional role binding in a policy
9992 # * Removing any role binding, with or without a condition, from a policy
9993 # that includes conditions
9994 #
9995 # **Important:** If you use IAM Conditions, you must include the `etag` field
9996 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9997 # you to overwrite a version `3` policy with a version `1` policy, and all of
9998 # the conditions in the version `3` policy are lost.
9999 #
10000 # If a policy does not include any conditions, operations on that policy may
10001 # specify any valid version or leave the field unset.
10002 #
10003 # To learn which resources support conditions in their IAM policies, see the
10004 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
10005 }</pre>
10006 </div>
10007
10008 <div class="method">
10009 <code class="details" id="getPartnerMetadata">getPartnerMetadata(project, zone, instance, namespaces=None, x__xgafv=None)</code>
10010 <pre>Gets partner metadata of the specified instance and namespaces.
10011
10012 Args:
10013 project: string, Project ID for this request. (required)
10014 zone: string, The name of the zone for this request. (required)
10015 instance: string, Name of the instance scoping this request. (required)
10016 namespaces: string, Comma separated partner metadata namespaces.
10017 x__xgafv: string, V1 error format.
10018 Allowed values
10019 1 - v1 error format
10020 2 - v2 error format
10021
10022 Returns:
10023 An object of the form:
10024
10025 { # Model definition of partner_metadata field.
10026 # To be used in dedicated Partner Metadata methods and to be inlined in
10027 # the Instance and InstanceTemplate resources.
10028 &quot;fingerprint&quot;: &quot;A String&quot;, # Instance-level hash to be used for optimistic
10029 # locking.
10030 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain to
10031 # entries map. Subdomain name must be compliant withRFC1035
10032 # definition. The total size of all keys and values must be less than 2MB.
10033 # Subdomain &#x27;metadata.compute.googleapis.com&#x27; is reserverd for instance&#x27;s
10034 # metadata.
10035 &quot;a_key&quot;: {
10036 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
10037 # It accepts any value including google.protobuf.Struct.
10038 &quot;a_key&quot;: &quot;&quot;,
10039 },
10040 },
10041 },
10042 }</pre>
10043 </div>
10044
10045 <div class="method">
10046 <code class="details" id="getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</code>
10047 <pre>Returns the screenshot from the specified instance.
10048
10049 Args:
10050 project: string, Project ID for this request. (required)
10051 zone: string, The name of the zone for this request. (required)
10052 instance: string, Name of the instance scoping this request. (required)
10053 x__xgafv: string, V1 error format.
10054 Allowed values
10055 1 - v1 error format
10056 2 - v2 error format
10057
10058 Returns:
10059 An object of the form:
10060
10061 { # An instance&#x27;s screenshot.
10062 &quot;contents&quot;: &quot;A String&quot;, # [Output Only] The Base64-encoded screenshot data.
10063 &quot;kind&quot;: &quot;compute#screenshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#screenshot
10064 # for the screenshots.
10065 }</pre>
10066 </div>
10067
10068 <div class="method">
10069 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None, x__xgafv=None)</code>
10070 <pre>Returns the last 1 MB of serial port output from the specified instance.
10071
10072 Args:
10073 project: string, Project ID for this request. (required)
10074 zone: string, The name of the zone for this request. (required)
10075 instance: string, Name of the instance for this request. (required)
10076 port: integer, Specifies which COM or serial port to retrieve data from.
10077 start: string, Specifies the starting byte position of the output to return. To start with
10078 the first byte of output to the specified port, omit this field or set it
10079 to `0`.
10080
10081 If the output for that byte position is available, this field matches the
10082 `start` parameter sent with the request. If the amount of serial console
10083 output exceeds the size of the buffer (1 MB), the oldest output is
10084 discarded and is no longer available. If the requested start position
10085 refers to discarded output, the start position is adjusted to the oldest
10086 output still available, and the adjusted start position is returned as the
10087 `start` property value.
10088
10089 You can also provide a negative start position, which translates to the
10090 most recent number of bytes written to the serial port. For example, -3 is
10091 interpreted as the most recent 3 bytes written to the serial console. Note
10092 that the negative start is bounded by the retained buffer size, and the
10093 returned serial console output will not exceed the max buffer size.
10094 x__xgafv: string, V1 error format.
10095 Allowed values
10096 1 - v1 error format
10097 2 - v2 error format
10098
10099 Returns:
10100 An object of the form:
10101
10102 { # An instance serial console output.
10103 &quot;contents&quot;: &quot;A String&quot;, # [Output Only] The contents of the console output.
10104 &quot;kind&quot;: &quot;compute#serialPortOutput&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#serialPortOutput for serial port output.
10105 &quot;next&quot;: &quot;A String&quot;, # [Output Only] The position of the next byte of content, regardless of
10106 # whether the content exists, following the output returned in the `contents`
10107 # property. Use this value in the next request as the start
10108 # parameter.
10109 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
10110 &quot;start&quot;: &quot;A String&quot;, # The starting byte position of the output that was returned.
10111 # This should match the start parameter sent with the request.
10112 # If the serial console output exceeds the size of the buffer (1 MB), older
10113 # output is overwritten by newer content. The output start value will
10114 # indicate the byte position of the output that was returned, which might be
10115 # different than the `start` value that was specified in the request.
10116 }</pre>
10117 </div>
10118
10119 <div class="method">
10120 <code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance, x__xgafv=None)</code>
10121 <pre>Returns the Shielded Instance Identity of an instance
10122
10123 Args:
10124 project: string, Project ID for this request. (required)
10125 zone: string, The name of the zone for this request. (required)
10126 instance: string, Name or id of the instance scoping this request. (required)
10127 x__xgafv: string, V1 error format.
10128 Allowed values
10129 1 - v1 error format
10130 2 - v2 error format
10131
10132 Returns:
10133 An object of the form:
10134
10135 { # A Shielded Instance Identity.
10136 &quot;eccP256EncryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the ECC P256 algorithm
10137 # issued to the Shielded Instance&#x27;s vTPM.
10138 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
10139 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
10140 },
10141 &quot;eccP256SigningKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the ECC P256 algorithm
10142 # issued to the Shielded Instance&#x27;s vTPM.
10143 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
10144 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
10145 },
10146 &quot;encryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm
10147 # issued to the Shielded Instance&#x27;s vTPM.
10148 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
10149 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
10150 },
10151 &quot;kind&quot;: &quot;compute#shieldedInstanceIdentity&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#shieldedInstanceIdentity for shielded Instance
10152 # identity entry.
10153 &quot;signingKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm
10154 # issued to the Shielded Instance&#x27;s vTPM.
10155 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
10156 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
10157 },
10158 }</pre>
10159 </div>
10160
10161 <div class="method">
10162 <code class="details" id="getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance, x__xgafv=None)</code>
10163 <pre>Returns the Shielded VM Identity of an instance
10164
10165 Args:
10166 project: string, Project ID for this request. (required)
10167 zone: string, The name of the zone for this request. (required)
10168 instance: string, Name of the instance scoping this request. (required)
10169 x__xgafv: string, V1 error format.
10170 Allowed values
10171 1 - v1 error format
10172 2 - v2 error format
10173
10174 Returns:
10175 An object of the form:
10176
10177 { # A Shielded VM Identity.
10178 &quot;encryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM&#x27;s vTPM.
10179 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
10180 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
10181 },
10182 &quot;kind&quot;: &quot;compute#shieldedVmIdentity&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#shieldedVmIdentity for shielded VM identity entry.
10183 &quot;signingKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM&#x27;s vTPM.
10184 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
10185 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
10186 },
10187 }</pre>
10188 </div>
10189
10190 <div class="method">
10191 <code class="details" id="getVmExtensionState">getVmExtensionState(project, zone, instance, extensionName, x__xgafv=None)</code>
10192 <pre>Retrieves details of a specific VM extension state.
10193 This is a read-only API.
10194
10195 Args:
10196 project: string, Project ID for this request. (required)
10197 zone: string, Name of the zone for this request. (required)
10198 instance: string, Name or id of the instance resource. (required)
10199 extensionName: string, The name of the extension to get the state for. (required)
10200 x__xgafv: string, V1 error format.
10201 Allowed values
10202 1 - v1 error format
10203 2 - v2 error format
10204
10205 Returns:
10206 An object of the form:
10207
10208 { # State of an extension on an instance.
10209 &quot;enforcementMsg&quot;: &quot;A String&quot;, # The status message of the extension if the extension fails to enforce.
10210 &quot;enforcementState&quot;: &quot;A String&quot;, # The enforcement state of the extension.
10211 # If the extension is not enforced yet, then the health status will not be
10212 # specified.
10213 &quot;healthMsg&quot;: &quot;A String&quot;, # The health status message of the extension.
10214 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the extension.
10215 &quot;name&quot;: &quot;A String&quot;, # The name of the extension.
10216 &quot;policyId&quot;: &quot;A String&quot;, # The id of the policy that is enforced on the extension.
10217 &quot;version&quot;: &quot;A String&quot;, # The version of the extension.
10218 }</pre>
10219 </div>
10220
10221 <div class="method">
10222 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</code>
10223 <pre>Creates an instance resource in the specified project using the data
10224 included in the request.
10225
10226 Args:
10227 project: string, Project ID for this request. (required)
10228 zone: string, The name of the zone for this request. (required)
10229 body: object, The request body.
10230 The object takes the form of:
10231
10232 { # Represents an Instance resource.
10233 #
10234 # An instance is a virtual machine that is hosted on Google Cloud Platform.
10235 # For more information, readVirtual Machine Instances.
10236 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
10237 # Options that would traditionally be configured in a BIOS belong
10238 # here. Features that require operating system support may have
10239 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
10240 # disabled).
10241 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
10242 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
10243 &quot;enableWatchdogTimer&quot;: True or False, # Whether to enable the watchdog timer.
10244 &quot;numaNodeCount&quot;: 42, # The number of vNUMA nodes.
10245 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
10246 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
10247 # multithreading (SMT) set this to 1. If unset, the maximum number
10248 # of threads supported per core by the underlying processor is
10249 # assumed.
10250 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
10251 # Supported modes include:
10252 # * ALL_CORE_MAX
10253 #
10254 # Using empty string or not setting this field will use the platform-specific
10255 # default turbo mode.
10256 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
10257 # the number of threads per core to compute the total number of virtual
10258 # CPUs to expose to the instance. If unset, the number of cores is
10259 # inferred from the instance&#x27;s nominal CPU count and the underlying
10260 # platform&#x27;s SMT width.
10261 },
10262 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
10263 # destination or source IPs. This is required if you plan to use this
10264 # instance to forward routes. For more information, seeEnabling IP Forwarding.
10265 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
10266 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
10267 &quot;confidentialParavisorConfig&quot;: { # A set of Confidential Paravisor (SVSM) options. # Defines a set of Confidential Paravisor (SVSM) options.
10268 &quot;confidentialTpmType&quot;: &quot;A String&quot;,
10269 &quot;sevSnpIrqMode&quot;: &quot;A String&quot;,
10270 },
10271 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
10272 },
10273 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
10274 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
10275 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
10276 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
10277 # create the resource.
10278 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
10279 # created before you can assign them.
10280 { # An instance-attached disk resource.
10281 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
10282 # or X86_64.
10283 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
10284 # deleted (but not when the disk is detached from the instance).
10285 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
10286 # partition of the disk for its root filesystem.
10287 &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
10288 # running within the instance. This name can be used to reference the device
10289 # for mounting, resizing, and so on, from within the instance.
10290 #
10291 # If not specified, the server chooses a default device name to apply to this
10292 # disk, in the form persistent-disk-x, where x is a number
10293 # assigned by Google Compute Engine. This field is only applicable for
10294 # persistent disks.
10295 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
10296 # encryption key.
10297 #
10298 # If you are creating a new disk, this field encrypts the new disk using
10299 # an encryption key that you provide. If you are attaching an existing
10300 # disk that is already encrypted, this field decrypts the disk using
10301 # the customer-supplied encryption key.
10302 #
10303 # If you encrypt a disk using a customer-supplied key, you must provide the
10304 # same key again when you attempt to use this resource at a later time. For
10305 # example, you must provide the key when you create a snapshot or an image
10306 # from the disk or when you attach the disk to a virtual machine instance.
10307 #
10308 # If you do not provide an encryption key, then the disk will be encrypted
10309 # using an automatically generated key and you do not need to provide a key
10310 # to use the disk later.
10311 #
10312 # Note:
10313 #
10314 # Instance templates do not storecustomer-supplied
10315 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
10316 #
10317 # You cannot create VMs that have disks with customer-supplied keys using
10318 # the bulk
10319 # insert method.
10320 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10321 # For example:
10322 #
10323 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10324 # key_region/cryptoKeys/key
10325 #
10326 # The fully-qualifed key name may be returned for resource GET requests. For
10327 # example:
10328 #
10329 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10330 # key_region/cryptoKeys/key
10331 # /cryptoKeyVersions/1
10332 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10333 # key. If absent, the Compute Engine default service account is used.
10334 # For example:
10335 #
10336 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10337 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10338 # encryption key, encoded in RFC
10339 # 4648 base64 to either encrypt or decrypt this resource. You can
10340 # provide either the rawKey or thersaEncryptedKey.
10341 # For example:
10342 #
10343 # &quot;rawKey&quot;:
10344 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10345 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10346 # customer-supplied encryption key to either encrypt or decrypt this
10347 # resource. You can provide either the rawKey or thersaEncryptedKey.
10348 # For example:
10349 #
10350 # &quot;rsaEncryptedKey&quot;:
10351 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10352 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10353 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10354 #
10355 # The key must meet the following requirements before you can provide it to
10356 # Compute Engine:
10357 #
10358 # 1. The key is wrapped using a RSA public key certificate provided by
10359 # Google.
10360 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10361 # encoding.
10362 #
10363 # Gets the RSA public key certificate provided by Google at:
10364 #
10365 #
10366 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10367 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10368 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10369 # encryption key that protects this resource.
10370 },
10371 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
10372 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
10373 # currently attached to another instance. If you try to force attach a zonal
10374 # disk to an instance, you will receive an error.
10375 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
10376 # only for bootable images. Read
10377 # Enabling guest operating system features to see a list of available
10378 # options.
10379 { # Guest OS features.
10380 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
10381 # separate values. Set to one or more of the following values:
10382 #
10383 # - VIRTIO_SCSI_MULTIQUEUE
10384 # - WINDOWS
10385 # - MULTI_IP_SUBNET
10386 # - UEFI_COMPATIBLE
10387 # - GVNIC
10388 # - SEV_CAPABLE
10389 # - SUSPEND_RESUME_COMPATIBLE
10390 # - SEV_LIVE_MIGRATABLE_V2
10391 # - SEV_SNP_CAPABLE
10392 # - TDX_CAPABLE
10393 # - IDPF
10394 # - SNP_SVSM_CAPABLE
10395 # - CCA_CAPABLE
10396 #
10397 #
10398 # For more information, see
10399 # Enabling guest operating system features.
10400 },
10401 ],
10402 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
10403 # boot disk. If you have many disks attached to an instance, each
10404 # disk would have a unique index number.
10405 &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
10406 # alongside the new instance. Use initialization parameters to create boot
10407 # disks or local SSDs attached to the new instance.
10408 #
10409 # This property is mutually exclusive with the source property;
10410 # you can only define one or the other, but not both.
10411 # alongside the new instance. Use initialization parameters to create boot
10412 # disks or local SSDs attached to the new instance.
10413 #
10414 # This field is persisted and returned for instanceTemplate and not returned
10415 # in the context of instance.
10416 #
10417 # This property is mutually exclusive with the source property;
10418 # you can only define one or the other, but not both.
10419 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
10420 # arm64 or x86_64.
10421 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
10422 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
10423 # of the instance. If a disk with the same name already exists in the given
10424 # region, the existing disk is attached to the new instance and the
10425 # new disk is not created.
10426 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
10427 # 10 GB. If you specify a sourceImage, which is required for
10428 # boot disks, the default size is the size of the sourceImage.
10429 # If you do not specify a sourceImage, the default disk size
10430 # is 500 GB.
10431 &quot;diskType&quot;: &quot;A String&quot;,
10432 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
10433 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
10434 # only for bootable images. Read
10435 # Enabling guest operating system features to see a list of available
10436 # options.
10437 #
10438 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
10439 { # Guest OS features.
10440 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
10441 # separate values. Set to one or more of the following values:
10442 #
10443 # - VIRTIO_SCSI_MULTIQUEUE
10444 # - WINDOWS
10445 # - MULTI_IP_SUBNET
10446 # - UEFI_COMPATIBLE
10447 # - GVNIC
10448 # - SEV_CAPABLE
10449 # - SUSPEND_RESUME_COMPATIBLE
10450 # - SEV_LIVE_MIGRATABLE_V2
10451 # - SEV_SNP_CAPABLE
10452 # - TDX_CAPABLE
10453 # - IDPF
10454 # - SNP_SVSM_CAPABLE
10455 # - CCA_CAPABLE
10456 #
10457 #
10458 # For more information, see
10459 # Enabling guest operating system features.
10460 },
10461 ],
10462 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
10463 # which is either SCSI or NVME. The default isSCSI.
10464 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
10465 # persistent disks.
10466 &quot;a_key&quot;: &quot;A String&quot;,
10467 },
10468 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
10469 # disk.
10470 &quot;A String&quot;,
10471 ],
10472 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
10473 &quot;A String&quot;,
10474 ],
10475 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
10476 # more than one instance.
10477 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
10478 # is to use the existing disk.
10479 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
10480 # of I/O operations per second that the disk can handle. Values must be
10481 # between 10,000 and 120,000. For more details, see theExtreme persistent
10482 # disk documentation.
10483 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
10484 # number of throughput mb per second that the disk can handle. Values must
10485 # greater than or equal to 1.
10486 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
10487 # the URLs of the zones where the disk should be replicated to.
10488 # You must provide exactly two replica zones, and one zone must be the same
10489 # as the instance zone.
10490 &quot;A String&quot;,
10491 ],
10492 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
10493 # have the same definition as resource
10494 # manager tags. Keys and values can be either in numeric format,
10495 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
10496 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
10497 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
10498 # empty.
10499 &quot;a_key&quot;: &quot;A String&quot;,
10500 },
10501 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
10502 # Specified using the full or partial URL. For instance template, specify
10503 # only the resource policy name.
10504 &quot;A String&quot;,
10505 ],
10506 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
10507 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
10508 # is required.
10509 #
10510 # To create a disk with one of the public operating system
10511 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
10512 #
10513 # projects/debian-cloud/global/images/family/debian-9
10514 #
10515 #
10516 # Alternatively, use a specific version of a public operating system image:
10517 #
10518 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
10519 #
10520 #
10521 # To create a disk with a custom image that you created, specify the
10522 # image name in the following format:
10523 #
10524 # global/images/my-custom-image
10525 #
10526 #
10527 # You can also specify a custom image by its image family, which returns
10528 # the latest version of the image in that family. Replace the image name
10529 # with family/family-name:
10530 #
10531 # global/images/family/my-image-family
10532 #
10533 #
10534 # If the source image is deleted later, this field will not be set.
10535 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
10536 # encryption key of the source image. Required if the source image is
10537 # protected by a customer-supplied encryption key.
10538 #
10539 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
10540 # encryption keys, so you cannot create disks for instances in a managed instance group if the
10541 # source images are encrypted with your own keys.
10542 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10543 # For example:
10544 #
10545 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10546 # key_region/cryptoKeys/key
10547 #
10548 # The fully-qualifed key name may be returned for resource GET requests. For
10549 # example:
10550 #
10551 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10552 # key_region/cryptoKeys/key
10553 # /cryptoKeyVersions/1
10554 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10555 # key. If absent, the Compute Engine default service account is used.
10556 # For example:
10557 #
10558 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10559 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10560 # encryption key, encoded in RFC
10561 # 4648 base64 to either encrypt or decrypt this resource. You can
10562 # provide either the rawKey or thersaEncryptedKey.
10563 # For example:
10564 #
10565 # &quot;rawKey&quot;:
10566 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10567 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10568 # customer-supplied encryption key to either encrypt or decrypt this
10569 # resource. You can provide either the rawKey or thersaEncryptedKey.
10570 # For example:
10571 #
10572 # &quot;rsaEncryptedKey&quot;:
10573 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10574 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10575 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10576 #
10577 # The key must meet the following requirements before you can provide it to
10578 # Compute Engine:
10579 #
10580 # 1. The key is wrapped using a RSA public key certificate provided by
10581 # Google.
10582 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10583 # encoding.
10584 #
10585 # Gets the RSA public key certificate provided by Google at:
10586 #
10587 #
10588 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10589 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10590 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10591 # encryption key that protects this resource.
10592 },
10593 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
10594 # instance boot disk, one of initializeParams.sourceSnapshot
10595 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
10596 # is required.
10597 #
10598 # To create a disk with a snapshot that you created, specify the
10599 # snapshot name in the following format:
10600 #
10601 # us-central1-a/instantSnapshots/my-backup
10602 #
10603 #
10604 # If the source instant-snapshot is deleted later, this field will not be
10605 # set.
10606 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
10607 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
10608 # is required.
10609 #
10610 # To create a disk with a snapshot that you created, specify the
10611 # snapshot name in the following format:
10612 #
10613 # global/snapshots/my-backup
10614 #
10615 #
10616 # If the source snapshot is deleted later, this field will not be set.
10617 #
10618 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
10619 # an image instead when you create VMs using
10620 # the bulk
10621 # insert method.
10622 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
10623 # encryption key of the source snapshot.
10624 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10625 # For example:
10626 #
10627 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10628 # key_region/cryptoKeys/key
10629 #
10630 # The fully-qualifed key name may be returned for resource GET requests. For
10631 # example:
10632 #
10633 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10634 # key_region/cryptoKeys/key
10635 # /cryptoKeyVersions/1
10636 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10637 # key. If absent, the Compute Engine default service account is used.
10638 # For example:
10639 #
10640 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10641 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10642 # encryption key, encoded in RFC
10643 # 4648 base64 to either encrypt or decrypt this resource. You can
10644 # provide either the rawKey or thersaEncryptedKey.
10645 # For example:
10646 #
10647 # &quot;rawKey&quot;:
10648 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10649 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10650 # customer-supplied encryption key to either encrypt or decrypt this
10651 # resource. You can provide either the rawKey or thersaEncryptedKey.
10652 # For example:
10653 #
10654 # &quot;rsaEncryptedKey&quot;:
10655 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10656 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10657 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10658 #
10659 # The key must meet the following requirements before you can provide it to
10660 # Compute Engine:
10661 #
10662 # 1. The key is wrapped using a RSA public key certificate provided by
10663 # Google.
10664 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10665 # encoding.
10666 #
10667 # Gets the RSA public key certificate provided by Google at:
10668 #
10669 #
10670 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10671 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10672 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10673 # encryption key that protects this resource.
10674 },
10675 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
10676 # this as a partial or full URL to the resource. For example, the following
10677 # are valid values:
10678 #
10679 #
10680 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
10681 # - projects/project/zones/zone/storagePools/storagePool
10682 # - zones/zone/storagePools/storagePool
10683 },
10684 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
10685 # either SCSI or NVME. For most machine types, the
10686 # default is SCSI. Local SSDs can use either NVME or SCSI.
10687 # In certain configurations, persistent disks can use NVMe. For more
10688 # information, seeAbout
10689 # persistent disks.
10690 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
10691 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
10692 &quot;A String&quot;,
10693 ],
10694 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
10695 # disk is not allowed to be detached from the instance, or to be used as the
10696 # source of the snapshot creation, and the image creation. The instance with
10697 # at least one locked attached disk is not allow to be used as source of
10698 # machine image creation, instant snapshot creation, and not allowed to be
10699 # deleted with --keep-disk parameter set to true for locked disks.
10700 &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
10701 # in READ_WRITE mode.
10702 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
10703 # field is set to PRESERVED if the LocalSSD data has been saved
10704 # to a persistent location by customer request. (see the
10705 # discard_local_ssd option on Stop/Suspend).
10706 # Read-only in the api.
10707 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
10708 # these are public keys which are safe to store in public
10709 &quot;dbs&quot;: [ # The Key Database (db).
10710 {
10711 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10712 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10713 },
10714 ],
10715 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
10716 {
10717 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10718 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10719 },
10720 ],
10721 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
10722 {
10723 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10724 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10725 },
10726 ],
10727 &quot;pk&quot;: { # The Platform Key (PK).
10728 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10729 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10730 },
10731 },
10732 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
10733 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
10734 # is required.
10735 #
10736 # If desired, you can also attach existing non-root persistent disks using
10737 # this property. This field is only applicable for persistent disks.
10738 #
10739 # Note that for InstanceTemplate, specify the disk name for zonal disk,
10740 # and the URL for regional disk.
10741 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
10742 },
10743 ],
10744 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
10745 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
10746 },
10747 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
10748 # machine image should erase Windows specific VSS signature.
10749 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
10750 # the instance&#x27;s contents and used for optimistic locking. The
10751 # fingerprint is initially generated by Compute Engine and changes after
10752 # every request to modify or update the instance. You must always provide an
10753 # up-to-date fingerprint hash in order to update the instance.
10754 #
10755 # To see the latest fingerprint, make get() request to the
10756 # instance.
10757 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
10758 { # A specification of the type and number of accelerator cards attached to the
10759 # instance.
10760 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
10761 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
10762 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
10763 # If you are creating an instance template, specify only the
10764 # accelerator name.
10765 # See GPUs on Compute Engine
10766 # for a full list of accelerator types.
10767 },
10768 ],
10769 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
10770 # RFC1035 compliant. If hostname is not specified, the default hostname is
10771 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
10772 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
10773 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
10774 # defined by the server.
10775 &quot;identity&quot;: &quot;A String&quot;,
10776 &quot;identityCertificate&quot;: True or False,
10777 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
10778 # encryption key.
10779 #
10780 # If you are creating a new instance, this field will encrypt the local SSD
10781 # and in-memory contents of the instance during the suspend operation.
10782 #
10783 # If you do not provide an encryption key when creating the instance, then
10784 # the local SSD and in-memory contents will be encrypted using
10785 # an automatically generated key during the suspend operation.
10786 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10787 # For example:
10788 #
10789 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10790 # key_region/cryptoKeys/key
10791 #
10792 # The fully-qualifed key name may be returned for resource GET requests. For
10793 # example:
10794 #
10795 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10796 # key_region/cryptoKeys/key
10797 # /cryptoKeyVersions/1
10798 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10799 # key. If absent, the Compute Engine default service account is used.
10800 # For example:
10801 #
10802 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10803 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10804 # encryption key, encoded in RFC
10805 # 4648 base64 to either encrypt or decrypt this resource. You can
10806 # provide either the rawKey or thersaEncryptedKey.
10807 # For example:
10808 #
10809 # &quot;rawKey&quot;:
10810 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10811 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10812 # customer-supplied encryption key to either encrypt or decrypt this
10813 # resource. You can provide either the rawKey or thersaEncryptedKey.
10814 # For example:
10815 #
10816 # &quot;rsaEncryptedKey&quot;:
10817 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10818 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10819 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10820 #
10821 # The key must meet the following requirements before you can provide it to
10822 # Compute Engine:
10823 #
10824 # 1. The key is wrapped using a RSA public key certificate provided by
10825 # Google.
10826 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10827 # encoding.
10828 #
10829 # Gets the RSA public key certificate provided by Google at:
10830 #
10831 #
10832 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10833 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10834 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10835 # encryption key that protects this resource.
10836 },
10837 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
10838 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
10839 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
10840 # for instances.
10841 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
10842 # the label&#x27;s contents and used for optimistic locking. The
10843 # fingerprint is initially generated by Compute Engine and changes after
10844 # every request to modify or update labels. You must always provide an
10845 # up-to-date fingerprint hash in order to update or change labels.
10846 #
10847 # To see the latest fingerprint, make get() request to the
10848 # instance.
10849 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
10850 # the setLabels method.
10851 &quot;a_key&quot;: &quot;A String&quot;,
10852 },
10853 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
10854 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
10855 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
10856 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
10857 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
10858 # when the instance is created. For example, the following is a valid partial
10859 # url to a predefined
10860 # machine type:
10861 #
10862 # zones/us-central1-f/machineTypes/n1-standard-1
10863 #
10864 #
10865 # To create acustom
10866 # machine type, provide a URL to a machine type in the following format,
10867 # where CPUS is 1 or an even number up to 32 (2,
10868 # 4, 6, ... 24, etc), and MEMORY is the total
10869 # memory for this instance. Memory must be a multiple of 256 MB and must
10870 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
10871 #
10872 # zones/zone/machineTypes/custom-CPUS-MEMORY
10873 #
10874 #
10875 # For example: zones/us-central1-f/machineTypes/custom-4-5120
10876 # For a full list of restrictions, read theSpecifications
10877 # for custom machine types.
10878 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
10879 # to this instance. This includes metadata keys that were explicitly defined
10880 # for the instance.
10881 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
10882 # the metadata&#x27;s contents and used for optimistic locking. The
10883 # fingerprint is initially generated by Compute Engine and changes after
10884 # every request to modify or update metadata. You must always provide an
10885 # up-to-date fingerprint hash in order to update or change metadata,
10886 # otherwise the request will fail with error412 conditionNotMet.
10887 #
10888 # To see the latest fingerprint, make a get() request to
10889 # retrieve the resource.
10890 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
10891 # less than 512 KB.
10892 { # Metadata
10893 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
10894 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
10895 # This is reflected as part of a URL in the metadata server. Additionally, to
10896 # avoid ambiguity, keys must not conflict with any other metadata keys
10897 # for the project.
10898 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
10899 # have meaning as interpreted by the image running in the instance. The
10900 # only restriction placed on values is that their size must be less than
10901 # or equal to 262144 bytes (256 KiB).
10902 },
10903 ],
10904 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
10905 # for metadata.
10906 },
10907 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
10908 # platform for the VM instance. Applicable values are the friendly names
10909 # of CPU platforms, such as minCpuPlatform: &quot;Intel
10910 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
10911 # Bridge&quot;.
10912 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
10913 # the resource. The resource name must be 1-63 characters long, and comply
10914 # withRFC1035.
10915 # Specifically, the name must be 1-63 characters long and match the regular
10916 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
10917 # character must be a lowercase letter, and all following characters must be
10918 # a dash, lowercase letter, or digit, except the last character, which cannot
10919 # be a dash.
10920 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
10921 # interfaces are configured to interact with other network services, such as
10922 # connecting to the internet. Multiple interfaces are supported
10923 # per instance.
10924 { # A network interface resource attached to an instance.
10925 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
10926 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
10927 # no external internet access.
10928 { # An access configuration attached to an instance&#x27;s network interface.
10929 # Only one access config per instance is supported.
10930 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
10931 # The first IPv6 address of the external IPv6 range associated
10932 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
10933 # use a static external IP address, it must be unused and in the same region
10934 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
10935 # assign an external IPv6 address from the instance&#x27;s subnetwork.
10936 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
10937 # external IPv6 range.
10938 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
10939 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
10940 # (IPv4), the default and recommended name is External NAT, but
10941 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
10942 # recommend name is External IPv6.
10943 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
10944 # address associated with this instance. Specify an unused static
10945 # external IP address available to the project or leave this field undefined
10946 # to use an IP from a shared ephemeral IP address pool. If you specify a
10947 # static external IP address, it must live in the same region as the zone of
10948 # the instance.
10949 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
10950 # configuration and can only take the following values: PREMIUM,STANDARD.
10951 #
10952 # If an AccessConfig is specified without a valid external IP address, an
10953 # ephemeral IP will be created with this networkTier.
10954 #
10955 # If an AccessConfig with a valid external IP address is specified, it must
10956 # match that of the networkTier associated with the Address resource owning
10957 # that IP.
10958 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
10959 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
10960 #
10961 # 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
10962 # first IP in associated external IPv6 range.
10963 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
10964 # config.
10965 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
10966 # external IP address of this access configuration.
10967 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
10968 # external IP address of the instance to a DNS domain name.
10969 #
10970 # This field is not used in ipv6AccessConfig. A default PTR
10971 # record will be created if the VM has external IPv6 range associated.
10972 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
10973 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
10974 },
10975 ],
10976 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
10977 # You can only specify this field for network interfaces in VPC networks.
10978 { # An alias IP range attached to an instance&#x27;s network interface.
10979 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
10980 # must belong to the specified subnetwork and cannot contain IP addresses
10981 # reserved by system or used by other network interfaces. This range may be
10982 # 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).
10983 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
10984 # alias range. If not specified, the primary range of the subnetwork is used.
10985 },
10986 ],
10987 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
10988 # You can only specify this field for network interfaces in VPC networks.
10989 { # An alias IP range attached to an instance&#x27;s network interface.
10990 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
10991 # must belong to the specified subnetwork and cannot contain IP addresses
10992 # reserved by system or used by other network interfaces. This range may be
10993 # 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).
10994 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
10995 # alias range. If not specified, the primary range of the subnetwork is used.
10996 },
10997 ],
10998 &quot;dns64Eligible&quot;: True or False, # If true, this network interface is eligible for DNS64.
10999 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
11000 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
11001 # with network_attachment.
11002 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
11003 # This field will be ignored when inserting an Instance or
11004 # adding a NetworkInterface. An up-to-date
11005 # 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.
11006 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
11007 # or not. If enabled, also indicates the version of IGMP supported.
11008 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
11009 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
11010 # one IPv6 access config, DIRECT_IPV6, is supported. If there
11011 # is no ipv6AccessConfig specified, then this instance will
11012 # have no external IPv6 Internet access.
11013 { # An access configuration attached to an instance&#x27;s network interface.
11014 # Only one access config per instance is supported.
11015 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
11016 # The first IPv6 address of the external IPv6 range associated
11017 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
11018 # use a static external IP address, it must be unused and in the same region
11019 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
11020 # assign an external IPv6 address from the instance&#x27;s subnetwork.
11021 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
11022 # external IPv6 range.
11023 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
11024 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
11025 # (IPv4), the default and recommended name is External NAT, but
11026 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
11027 # recommend name is External IPv6.
11028 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
11029 # address associated with this instance. Specify an unused static
11030 # external IP address available to the project or leave this field undefined
11031 # to use an IP from a shared ephemeral IP address pool. If you specify a
11032 # static external IP address, it must live in the same region as the zone of
11033 # the instance.
11034 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
11035 # configuration and can only take the following values: PREMIUM,STANDARD.
11036 #
11037 # If an AccessConfig is specified without a valid external IP address, an
11038 # ephemeral IP will be created with this networkTier.
11039 #
11040 # If an AccessConfig with a valid external IP address is specified, it must
11041 # match that of the networkTier associated with the Address resource owning
11042 # that IP.
11043 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
11044 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
11045 #
11046 # 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
11047 # first IP in associated external IPv6 range.
11048 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
11049 # config.
11050 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
11051 # external IP address of this access configuration.
11052 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
11053 # external IP address of the instance to a DNS domain name.
11054 #
11055 # This field is not used in ipv6AccessConfig. A default PTR
11056 # record will be created if the VM has external IPv6 range associated.
11057 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
11058 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
11059 },
11060 ],
11061 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
11062 # accessed from the Internet. This field is always inherited from its
11063 # subnetwork.
11064 #
11065 # Valid only if stackType is IPV4_IPV6.
11066 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
11067 # use a static internal IP address, it must be unused and in the same region
11068 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
11069 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
11070 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
11071 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
11072 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
11073 # server. For a VM, the network interface uses the nicN naming
11074 # format. Where N is a value between 0 and7. The default interface value is nic0.
11075 &quot;nat64Eligible&quot;: True or False, # If true, this network interface is eligible for NAT64.
11076 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
11077 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
11078 # instance, if neither the network nor the subnetwork is specified, the
11079 # default network global/networks/default is used. If the
11080 # selected project doesn&#x27;t have the default network, you must specify a
11081 # network or subnet. If the network is not specified but the subnetwork is
11082 # specified, the network is inferred.
11083 #
11084 # If you specify this property, you can specify the network as
11085 # a full or partial URL. For example, the following are all valid URLs:
11086 #
11087 #
11088 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
11089 # - projects/project/global/networks/network
11090 # - global/networks/default
11091 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
11092 # to in the following format:
11093 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
11094 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
11095 # interface. If not specified by the user, an unused internal IP is
11096 # assigned by the system.
11097 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
11098 # VirtioNet.
11099 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
11100 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
11101 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
11102 # if not specified by the users.
11103 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
11104 # interface. Can only be used with network_attachment. It is not possible to
11105 # use on its own however, network_attachment can be used without
11106 # service_class_id.
11107 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
11108 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
11109 #
11110 # This field can be both set at instance creation and update network
11111 # interface operations.
11112 &quot;subinterfaces&quot;: [ # SubInterfaces help enable L2 communication for the instance over
11113 # subnetworks that support L2. Every network interface will get a default
11114 # untagged (vlan not specified) subinterface. Users can specify additional
11115 # tagged subinterfaces which are sub-fields to the Network Interface.
11116 {
11117 &quot;ipAddress&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this
11118 # subinterface. If specified, ip_allocation_mode should be set to
11119 # ALLOCATE_IP.
11120 &quot;ipAllocationMode&quot;: &quot;A String&quot;,
11121 &quot;subnetwork&quot;: &quot;A String&quot;, # If specified, this subnetwork must belong to the same network
11122 # as that of the network interface.
11123 # If not specified the subnet of network interface will be used.
11124 # If you specify this property, you can specify the subnetwork as a full
11125 # or partial URL. For example, the following are all valid URLs:
11126 #
11127 #
11128 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
11129 # - regions/region/subnetworks/subnetwork
11130 &quot;vlan&quot;: 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which
11131 # this subinterface is connecting.
11132 },
11133 ],
11134 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
11135 # resource is inlegacy
11136 # mode, do not specify this field. If the network is in auto subnet
11137 # mode, specifying the subnetwork is optional. If the network is in custom
11138 # subnet mode, specifying the subnetwork is required. If you specify this
11139 # field, you can specify the subnetwork as a full or partial URL. For
11140 # example, the following are all valid URLs:
11141 #
11142 #
11143 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
11144 # - regions/region/subnetworks/subnetwork
11145 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
11146 # from 2 to 255 inclusively.
11147 },
11148 ],
11149 &quot;networkPerformanceConfig&quot;: {
11150 &quot;externalIpEgressBandwidthTier&quot;: &quot;A String&quot;,
11151 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
11152 },
11153 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
11154 # as part of resource payload.
11155 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
11156 # Instances.Insert API.
11157 # as a count of seconds and fractions of seconds at nanosecond
11158 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11159 # or &quot;month&quot;. Range is approximately 10,000 years.
11160 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11161 # Durations less than one second are represented with a 0
11162 # `seconds` field and a positive `nanos` field. Must be from 0
11163 # to 999,999,999 inclusive.
11164 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11165 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11166 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11167 },
11168 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
11169 # have the same definition as resource
11170 # manager tags. Keys and values can be either in numeric format,
11171 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
11172 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
11173 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
11174 # PATCH) when empty.
11175 &quot;a_key&quot;: &quot;A String&quot;,
11176 },
11177 },
11178 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
11179 # (namespace) to entries map.
11180 &quot;a_key&quot;: {
11181 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
11182 # It accepts any value including google.protobuf.Struct.
11183 &quot;a_key&quot;: &quot;&quot;,
11184 },
11185 },
11186 },
11187 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
11188 &quot;preservedStateSizeGb&quot;: &quot;A String&quot;, # Output only. Total amount of preserved state for SUSPENDED instances.
11189 # Read-only in the api.
11190 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
11191 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
11192 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
11193 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
11194 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
11195 # Consuming reserved instances for examples.
11196 &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
11197 # the name of your reservation as its value.
11198 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
11199 # either a name to a reservation in the same project or
11200 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
11201 # shared reservation in the same zone but in a different project.
11202 &quot;A String&quot;,
11203 ],
11204 },
11205 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
11206 &quot;A String&quot;,
11207 ],
11208 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
11209 # compared to the values requested by user in the corresponding input only
11210 # field.
11211 # Use this sub-message for actual values set on Instance attributes as compared
11212 # to the value requested by the user (intent) in their instance CRUD calls.
11213 &quot;acceleratorStatus&quot;: [ # Output only. [Output Only] Accelerators status show results of GPU scans. These scans
11214 # are specialized diagnostic tests designed to uncover latent manufacturing
11215 # defects or other issues that could potentially lead to data corruption or
11216 # impede the customer&#x27;s ability to efficiently execute GPU workloads.
11217 { # The status of an individual accelerator resource.
11218 &quot;passedScans&quot;: [ # The details of scans that passed for an accelerator.
11219 {
11220 &quot;endTime&quot;: &quot;A String&quot;, # The end time of the passed scan inRFC3339 text format.
11221 &quot;name&quot;: &quot;A String&quot;,
11222 &quot;startTime&quot;: &quot;A String&quot;, # The start time of the passed scan inRFC3339 text format.
11223 &quot;version&quot;: &quot;A String&quot;,
11224 },
11225 ],
11226 &quot;recommendedScans&quot;: [ # The details of recommended scans for an accelerator.
11227 {
11228 &quot;estimatedDuration&quot;: { # A Duration represents a fixed-length span of time represented
11229 # as a count of seconds and fractions of seconds at nanosecond
11230 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11231 # or &quot;month&quot;. Range is approximately 10,000 years.
11232 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11233 # Durations less than one second are represented with a 0
11234 # `seconds` field and a positive `nanos` field. Must be from 0
11235 # to 999,999,999 inclusive.
11236 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11237 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11238 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11239 },
11240 &quot;name&quot;: &quot;A String&quot;,
11241 &quot;version&quot;: &quot;A String&quot;,
11242 },
11243 ],
11244 &quot;serialNumber&quot;: &quot;A String&quot;, # The serial number of the accelerator.
11245 &quot;uuid&quot;: &quot;A String&quot;, # The UUID of the accelerator.
11246 },
11247 ],
11248 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this instance
11249 # is consuming from.
11250 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
11251 # instance is consuming from.
11252 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
11253 # zonal instance settings, and instance-level predefined metadata keys to
11254 # provide the overridden value for those metadata keys at the instance level.
11255 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
11256 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
11257 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
11258 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
11259 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
11260 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
11261 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
11262 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
11263 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
11264 },
11265 &quot;lastInstanceTerminationDetails&quot;: { # Output only. [Output Only] Contains last termination details why the instance was
11266 # terminated.
11267 &quot;terminationReason&quot;: &quot;A String&quot;, # Reason for termination
11268 },
11269 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
11270 # center, including the block, sub-block, and host. The field is formatted as
11271 # follows: blockId/subBlockId/hostId.
11272 &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
11273 # Engine cluster, as well as the ID of the block, sub-block, and host on
11274 # which the running instance is located.
11275 # running.
11276 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
11277 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
11278 # example
11279 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
11280 # the location ID of the topologies.
11281 &quot;a_key&quot;: &quot;A String&quot;,
11282 },
11283 },
11284 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
11285 # located. Instances within the same block experience low network latency.
11286 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
11287 # running instance is located.
11288 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
11289 # Instances on the same host experience the lowest possible network
11290 # latency.
11291 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
11292 # located. Instances in the same sub-block experience lower network latency
11293 # than instances in the same block.
11294 },
11295 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
11296 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
11297 # instance is consuming from.
11298 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
11299 # instance is consuming from.
11300 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
11301 # this instance is consuming from.
11302 },
11303 &quot;scheduling&quot;: {
11304 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
11305 # must be a number between 1 and the number of availability domains
11306 # specified in the spread placement policy attached to the instance.
11307 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
11308 },
11309 &quot;serviceIntegrationStatuses&quot;: { # [Output Only] Represents the status of the service integration specs
11310 # defined by the user in instance.serviceIntegrationSpecs.
11311 &quot;a_key&quot;: { # Represents the status of integration between instance and another service.
11312 # See go/gce-backupdr-design for more details.
11313 &quot;backupDr&quot;: { # Message defining compute perspective of the result of integration with
11314 # Backup and DR. FAILED status indicates that the operation specified did
11315 # not complete correctly and should be retried with the same value.
11316 &quot;integrationDetails&quot;: &quot;A String&quot;, # The PlanReference object created by Backup and DR to maintain the
11317 # actual status of backups. May still be present if removing the backup
11318 # plan fails.
11319 &quot;state&quot;: &quot;A String&quot;, # Enum representing the registration state of a Backup and DR backup plan
11320 # for the instance.
11321 },
11322 },
11323 },
11324 &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.
11325 # programmed stop scheduled.
11326 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
11327 # `stop_state=PENDING_STOP`.
11328 # as a count of seconds and fractions of seconds at nanosecond
11329 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11330 # or &quot;month&quot;. Range is approximately 10,000 years.
11331 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11332 # Durations less than one second are represented with a 0
11333 # `seconds` field and a positive `nanos` field. Must be from 0
11334 # to 999,999,999 inclusive.
11335 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11336 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11337 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11338 },
11339 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
11340 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
11341 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
11342 },
11343 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
11344 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
11345 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
11346 # This value is inRFC3339
11347 # text format.
11348 # DEPRECATED: Use window_start_time instead.
11349 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
11350 # This timestamp value is in RFC3339 text format.
11351 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
11352 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
11353 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
11354 &quot;A String&quot;,
11355 ],
11356 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
11357 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
11358 # DEPRECATED: Use window_start_time instead.
11359 # TimeWindow is a container for two strings that represent timestamps in
11360 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
11361 &quot;earliest&quot;: &quot;A String&quot;,
11362 &quot;latest&quot;: &quot;A String&quot;,
11363 },
11364 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
11365 # This value is inRFC3339
11366 # text format.
11367 # DEPRECATED: Use window_start_time instead.
11368 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
11369 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
11370 # This timestamp value is in RFC3339 text format.
11371 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
11372 # This timestamp value is in RFC3339 text format.
11373 },
11374 },
11375 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
11376 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
11377 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
11378 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
11379 # terminated by Compute Engine (not terminated by a user). You can only set
11380 # the automatic restart option for standard instances.Preemptible instances
11381 # cannot be automatically restarted.
11382 #
11383 # By default, this is set to true so an instance is
11384 # automatically restarted if it is terminated by Compute Engine.
11385 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
11386 # must be a number between 1 and the number of availability domains
11387 # specified in the spread placement policy attached to the instance.
11388 &quot;currentCpus&quot;: 42, # Current number of vCPUs available for VM.
11389 # 0 or unset means default vCPUs of the current machine type.
11390 &quot;currentMemoryMb&quot;: &quot;A String&quot;, # Current amount of memory (in MB) available for VM.
11391 # 0 or unset means default amount of memory of the current machine type.
11392 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
11393 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
11394 &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
11395 # graceful shutdown isn&#x27;t complete after this time, then the instance
11396 # transitions to the STOPPING state.
11397 # as a count of seconds and fractions of seconds at nanosecond
11398 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11399 # or &quot;month&quot;. Range is approximately 10,000 years.
11400 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11401 # Durations less than one second are represented with a 0
11402 # `seconds` field and a positive `nanos` field. Must be from 0
11403 # to 999,999,999 inclusive.
11404 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11405 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11406 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11407 },
11408 },
11409 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
11410 # within the range of [90, 330] with the increment of 30, if unset, the
11411 # default behavior of host error recovery will be used.
11412 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
11413 &quot;latencyTolerant&quot;: True or False, # Defines whether the instance is tolerant of higher cpu latency. This can
11414 # only be set during instance creation, or when the instance is not currently
11415 # running. It must not be set if thepreemptible option is
11416 # also set.
11417 &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
11418 # recovery of the Local Ssd state is attempted. Its value should be in
11419 # between 0 and 168 hours with hour granularity and the default value being 1
11420 # hour.
11421 # as a count of seconds and fractions of seconds at nanosecond
11422 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11423 # or &quot;month&quot;. Range is approximately 10,000 years.
11424 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11425 # Durations less than one second are represented with a 0
11426 # `seconds` field and a positive `nanos` field. Must be from 0
11427 # to 999,999,999 inclusive.
11428 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11429 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11430 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11431 },
11432 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
11433 # resources.
11434 # This field is for use by internal tools that use the public API.
11435 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
11436 # be scheduled for maintenance.
11437 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
11438 # are: `PERIODIC`.
11439 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
11440 # the instance termination action will be performed at the end of the run
11441 # duration.
11442 # as a count of seconds and fractions of seconds at nanosecond
11443 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11444 # or &quot;month&quot;. Range is approximately 10,000 years.
11445 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11446 # Durations less than one second are represented with a 0
11447 # `seconds` field and a positive `nanos` field. Must be from 0
11448 # to 999,999,999 inclusive.
11449 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11450 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11451 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11452 },
11453 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
11454 # on a sole-tenant node.
11455 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
11456 # affinity for more information.
11457 # Overrides reservationAffinity.
11458 { # Node Affinity: the configuration of desired nodes onto which this Instance
11459 # could be scheduled.
11460 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
11461 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
11462 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
11463 &quot;A String&quot;,
11464 ],
11465 },
11466 ],
11467 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
11468 # the default behavior is MIGRATE. Forpreemptible instances,
11469 # the default and only possible behavior is TERMINATE. For more
11470 # information, see
11471 # Set
11472 # VM host maintenance policy.
11473 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
11474 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
11475 # else, the Local SSD data will be preserved when the instance is stopped
11476 # at the end of the run duration/termination time.
11477 },
11478 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
11479 # instance creation or while the instance isstopped and
11480 # therefore, in a `TERMINATED` state. SeeInstance Life
11481 # Cycle for more information on the possible instance states.
11482 &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
11483 # Off signal is triggered for Spot
11484 # VMs only. If not specified, there will be no wait before the G2 Soft
11485 # Off signal is triggered.
11486 # as a count of seconds and fractions of seconds at nanosecond
11487 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11488 # or &quot;month&quot;. Range is approximately 10,000 years.
11489 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11490 # Durations less than one second are represented with a 0
11491 # `seconds` field and a positive `nanos` field. Must be from 0
11492 # to 999,999,999 inclusive.
11493 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11494 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11495 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11496 },
11497 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
11498 &quot;shutdownTimeout&quot;: { # A Duration represents a fixed-length span of time represented # DEPRECATED: please use skipGuestOsShutdown.
11499 # Timeout between GCE ACPI G2 Soft
11500 # Off and ACPI G3 Mechanical
11501 # Off during shutdown operation of VM.
11502 #
11503 # For Standard VMs values between 0s and 120s are allowed. For Spot and
11504 # Preemptible VMs supported values are between 0s and 30s.
11505 #
11506 # If no value is specified for shutdownDuration, default values are 90s for
11507 # Standard VMs and 30s for Spot/Preemptible VMs.
11508 # as a count of seconds and fractions of seconds at nanosecond
11509 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11510 # or &quot;month&quot;. Range is approximately 10,000 years.
11511 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11512 # Durations less than one second are represented with a 0
11513 # `seconds` field and a positive `nanos` field. Must be from 0
11514 # to 999,999,999 inclusive.
11515 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11516 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11517 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11518 },
11519 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
11520 # Off and ACPI G3 Mechanical
11521 # Off for Standard VMs and 30 seconds for Spot VMs.
11522 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
11523 # termination action will be performed at the termination time.
11524 &quot;vsockMode&quot;: { # Message to control the enablement of the vsock device. # The vsock mode of the instance.
11525 &quot;mode&quot;: &quot;A String&quot;,
11526 },
11527 &quot;windowsLicenseOptimizationMode&quot;: &quot;A String&quot;, # Represents the Windows Server License Optimization Mode of the VM. If
11528 # unspecified, the default mode is `OFF`.
11529 },
11530 &quot;secureTags&quot;: [ # [Input Only] Secure tags to apply to this instance. These can be later
11531 # modified by the update method.
11532 # Maximum number of secure tags allowed is 50.
11533 &quot;A String&quot;,
11534 ],
11535 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
11536 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
11537 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
11538 # this instance. Only one service account per VM instance is supported.
11539 #
11540 # Service accounts generate access tokens that can be accessed
11541 # through the metadata server and used to authenticate applications on the
11542 # instance. SeeService Accounts
11543 # for more information.
11544 { # A service account.
11545 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
11546 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
11547 &quot;A String&quot;,
11548 ],
11549 },
11550 ],
11551 &quot;serviceIntegrationSpecs&quot;: { # Mapping of user-defined keys to specifications for service integrations.
11552 # Currently only a single key-value pair is supported.
11553 &quot;a_key&quot;: { # Specifies the parameters to configure an integration with instances.
11554 &quot;backupDr&quot;: { # Specifies parameters to Backup and DR to attach a BackupPlan to a compute
11555 # instance for managed VM backup.
11556 &quot;plan&quot;: &quot;A String&quot;, # The BackupPlan resource to attach to the instance. Specified as a
11557 # resource reference in instances, and regional instance templates, and as
11558 # just the plan name in global instance templates
11559 },
11560 },
11561 },
11562 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
11563 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
11564 # default.
11565 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
11566 # default.
11567 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
11568 # default.
11569 },
11570 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
11571 # Instance boot integrity is measured.
11572 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
11573 # measurements from the VM instance&#x27;s most recent boot.
11574 },
11575 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
11576 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
11577 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
11578 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
11579 },
11580 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
11581 # VM instance boot integrity is measured.
11582 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
11583 # measurements from the VM instance&#x27;s most recent boot.
11584 },
11585 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
11586 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
11587 # machine image.
11588 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
11589 # For example:
11590 #
11591 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11592 # key_region/cryptoKeys/key
11593 #
11594 # The fully-qualifed key name may be returned for resource GET requests. For
11595 # example:
11596 #
11597 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11598 # key_region/cryptoKeys/key
11599 # /cryptoKeyVersions/1
11600 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
11601 # key. If absent, the Compute Engine default service account is used.
11602 # For example:
11603 #
11604 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
11605 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
11606 # encryption key, encoded in RFC
11607 # 4648 base64 to either encrypt or decrypt this resource. You can
11608 # provide either the rawKey or thersaEncryptedKey.
11609 # For example:
11610 #
11611 # &quot;rawKey&quot;:
11612 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
11613 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
11614 # customer-supplied encryption key to either encrypt or decrypt this
11615 # resource. You can provide either the rawKey or thersaEncryptedKey.
11616 # For example:
11617 #
11618 # &quot;rsaEncryptedKey&quot;:
11619 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
11620 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
11621 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
11622 #
11623 # The key must meet the following requirements before you can provide it to
11624 # Compute Engine:
11625 #
11626 # 1. The key is wrapped using a RSA public key certificate provided by
11627 # Google.
11628 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
11629 # encoding.
11630 #
11631 # Gets the RSA public key certificate provided by Google at:
11632 #
11633 #
11634 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
11635 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
11636 # 4648 base64 encoded SHA-256 hash of the customer-supplied
11637 # encryption key that protects this resource.
11638 },
11639 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
11640 # Engine has detected suspicious activity.
11641 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
11642 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
11643 # instance, see
11644 # Instance life cycle.
11645 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
11646 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
11647 # sources or targets for network firewalls and are specified by the client
11648 # during instance creation. The tags can be later modified by the setTags
11649 # method. Each tag within the list must comply withRFC1035.
11650 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
11651 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
11652 # the tags&#x27; contents and used for optimistic locking. The
11653 # fingerprint is initially generated by Compute Engine and changes after
11654 # every request to modify or update tags. You must always provide an
11655 # up-to-date fingerprint hash in order to update or change tags.
11656 #
11657 # To see the latest fingerprint, make get() request to the
11658 # instance.
11659 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
11660 # with RFC1035.
11661 &quot;A String&quot;,
11662 ],
11663 },
11664 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. [Output Only] DEPRECATED: Please useresource_status.upcoming_maintenance instead. Specifies
11665 # upcoming maintenance for the instance.
11666 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
11667 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
11668 # This value is inRFC3339
11669 # text format.
11670 # DEPRECATED: Use window_start_time instead.
11671 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
11672 # This timestamp value is in RFC3339 text format.
11673 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
11674 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
11675 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
11676 &quot;A String&quot;,
11677 ],
11678 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
11679 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
11680 # DEPRECATED: Use window_start_time instead.
11681 # TimeWindow is a container for two strings that represent timestamps in
11682 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
11683 &quot;earliest&quot;: &quot;A String&quot;,
11684 &quot;latest&quot;: &quot;A String&quot;,
11685 },
11686 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
11687 # This value is inRFC3339
11688 # text format.
11689 # DEPRECATED: Use window_start_time instead.
11690 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
11691 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
11692 # This timestamp value is in RFC3339 text format.
11693 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
11694 # This timestamp value is in RFC3339 text format.
11695 },
11696 &quot;workloadIdentityConfig&quot;: {
11697 &quot;identity&quot;: &quot;A String&quot;,
11698 &quot;identityCertificateEnabled&quot;: True or False,
11699 },
11700 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
11701 # You must specify this field as part of the HTTP request URL. It is
11702 # not settable as a field in the request body.
11703 }
11704
11705 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
11706 that if you must retry your request, the server will know to ignore the
11707 request if it has already been completed.
11708
11709 For example, consider a situation where you make an initial request and
11710 the request times out. If you make the request again with the same
11711 request ID, the server can check if original operation with the same
11712 request ID was received, and if so, will ignore the second request. This
11713 prevents clients from accidentally creating duplicate commitments.
11714
11715 The request ID must be
11716 a valid UUID with the exception that zero UUID is not supported
11717 (00000000-0000-0000-0000-000000000000).
11718 sourceInstanceTemplate: string, Specifies instance template to create the instance.
11719
11720 This field is optional. It can be a full or partial URL. For example, the
11721 following are all valid URLs to an instance template:
11722
11723
11724 - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
11725 - projects/project/global/instanceTemplates/instanceTemplate
11726 - global/instanceTemplates/instanceTemplate
11727 sourceMachineImage: string, Specifies the machine image to use to create the instance.
11728
11729 This field is optional. It can be a full or partial URL. For example, the
11730 following are all valid URLs to a machine image:
11731
11732
11733 - https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage
11734 - projects/project/global/global/machineImages/machineImage
11735 - global/machineImages/machineImage
11736 x__xgafv: string, V1 error format.
11737 Allowed values
11738 1 - v1 error format
11739 2 - v2 error format
11740
11741 Returns:
11742 An object of the form:
11743
11744 { # Represents an Operation resource.
11745 #
11746 # Google Compute Engine has three Operation resources:
11747 #
11748 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
11749 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
11750 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
11751 #
11752 # You can use an operation resource to manage asynchronous API requests.
11753 # For more information, readHandling
11754 # API responses.
11755 #
11756 # Operations can be global, regional or zonal.
11757 #
11758 # - For global operations, use the `globalOperations`
11759 # resource.
11760 # - For regional operations, use the
11761 # `regionOperations` resource.
11762 # - For zonal operations, use
11763 # the `zoneOperations` resource.
11764 #
11765 #
11766 #
11767 # For more information, read
11768 # Global, Regional, and Zonal Resources.
11769 #
11770 # Note that completed Operation resources have a limited
11771 # retention period.
11772 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
11773 # Not present otherwise.
11774 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
11775 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
11776 # set when the operation is created.
11777 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
11778 # text format.
11779 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
11780 # this field will be populated.
11781 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
11782 # operation.
11783 {
11784 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
11785 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
11786 # details. There is a set of defined message types to use for providing
11787 # details.The syntax depends on the error code. For example,
11788 # QuotaExceededInfo will have details when the error code is
11789 # QUOTA_EXCEEDED.
11790 {
11791 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
11792 #
11793 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
11794 # is not enabled:
11795 #
11796 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
11797 # &quot;domain&quot;: &quot;googleapis.com&quot;
11798 # &quot;metadata&quot;: {
11799 # &quot;resource&quot;: &quot;projects/123&quot;,
11800 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
11801 # }
11802 # }
11803 #
11804 # This response indicates that the pubsub.googleapis.com API is not enabled.
11805 #
11806 # Example of an error that is returned when attempting to create a Spanner
11807 # instance in a region that is out of stock:
11808 #
11809 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
11810 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
11811 # &quot;metadata&quot;: {
11812 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
11813 # }
11814 # }
11815 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
11816 # is typically the registered service name of the tool or product that
11817 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
11818 # generated by some common infrastructure, the error domain must be a
11819 # globally unique value that identifies the infrastructure. For Google API
11820 # infrastructure, the error domain is &quot;googleapis.com&quot;.
11821 &quot;metadatas&quot;: { # Additional structured details about this error.
11822 #
11823 # Keys must match a regular expression of `a-z+` but should
11824 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
11825 # length. When identifying the current value of an exceeded limit, the units
11826 # should be contained in the key, not the value. For example, rather than
11827 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
11828 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
11829 # instances that can be created in a single (batch) request.
11830 &quot;a_key&quot;: &quot;A String&quot;,
11831 },
11832 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
11833 # proximate cause of the error. Error reasons are unique within a particular
11834 # domain of errors. This should be at most 63 characters and match a
11835 # regular expression of `A-Z+[A-Z0-9]`, which represents
11836 # UPPER_SNAKE_CASE.
11837 },
11838 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
11839 #
11840 # For example, if a quota check failed with an error indicating the calling
11841 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
11842 # directly to the right place in the developer console to flip the bit.
11843 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
11844 { # Describes a URL link.
11845 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
11846 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
11847 },
11848 ],
11849 },
11850 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
11851 # which can be attached to an RPC error.
11852 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
11853 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
11854 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
11855 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
11856 },
11857 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
11858 &quot;dimensions&quot;: { # The map holding related quota dimensions.
11859 &quot;a_key&quot;: &quot;A String&quot;,
11860 },
11861 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
11862 # type or metric.
11863 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
11864 # or metric.
11865 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
11866 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
11867 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
11868 },
11869 },
11870 ],
11871 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
11872 # This property is optional.
11873 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
11874 },
11875 ],
11876 },
11877 &quot;getVersionOperationMetadata&quot;: {
11878 &quot;inlineSbomInfo&quot;: {
11879 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
11880 # appropriate identifiers.
11881 &quot;a_key&quot;: &quot;A String&quot;,
11882 },
11883 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
11884 # identifiers.
11885 &quot;a_key&quot;: &quot;A String&quot;,
11886 },
11887 },
11888 },
11889 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
11890 # message that was returned, such as `NOT FOUND`.
11891 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
11892 # status code that was returned. For example, a `404` means the
11893 # resource was not found.
11894 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
11895 # defined by the server.
11896 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
11897 # This value is inRFC3339
11898 # text format.
11899 &quot;instancesBulkInsertOperationMetadata&quot;: {
11900 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
11901 # Example key: zones/us-central1-a
11902 &quot;a_key&quot;: {
11903 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
11904 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
11905 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
11906 # error.
11907 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
11908 # if the flow is rolling forward or rolling back.
11909 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
11910 },
11911 },
11912 },
11913 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
11914 # Operation resources.
11915 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
11916 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
11917 # group of operations results from a `bulkInsert` API request.
11918 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
11919 # `update`, or `delete`, and so on.
11920 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
11921 # There is no requirement that this be linear or support any granularity of
11922 # operations. This should not be used to guess when the operation will be
11923 # complete. This number should monotonically increase as the operation
11924 # progresses.
11925 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
11926 # applicable when performing regional operations.
11927 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11928 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
11929 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
11930 # this field will contain information on all underlying zonal actions and
11931 # their state.
11932 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
11933 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
11934 # Example key: zones/us-central1-a
11935 &quot;a_key&quot;: {
11936 &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
11937 # populated.
11938 # different programming environments, including REST APIs and RPC APIs. It is
11939 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
11940 # three pieces of data: error code, error message, and error details.
11941 #
11942 # You can find out more about this error model and how to work with it in the
11943 # [API Design Guide](https://cloud.google.com/apis/design/errors).
11944 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
11945 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
11946 # message types for APIs to use.
11947 {
11948 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
11949 },
11950 ],
11951 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
11952 # user-facing error message should be localized and sent in the
11953 # google.rpc.Status.details field, or localized by the client.
11954 },
11955 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
11956 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
11957 },
11958 },
11959 },
11960 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
11961 # This value is inRFC3339
11962 # text format.
11963 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
11964 # following:
11965 # `PENDING`, `RUNNING`, or `DONE`.
11966 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
11967 # operation.
11968 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
11969 # of the target resource.
11970 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
11971 # operations related to creating a snapshot, this points to the disk
11972 # that the snapshot was created from.
11973 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
11974 # `[email protected]` or
11975 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
11976 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
11977 # operation, this field will be populated.
11978 {
11979 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11980 # Engine returns NO_RESULTS_ON_PAGE if there
11981 # are no results in the response.
11982 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11983 # value format. For example:
11984 #
11985 # &quot;data&quot;: [
11986 # {
11987 # &quot;key&quot;: &quot;scope&quot;,
11988 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11989 # }
11990 {
11991 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11992 # returned. For example, for warnings where there are no results in a list
11993 # request for a particular zone, this key might be scope and
11994 # the key value might be the zone name. Other examples might be a key
11995 # indicating a deprecated resource and a suggested replacement, or a
11996 # warning about invalid network settings (for example, if an instance
11997 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11998 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11999 },
12000 ],
12001 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
12002 },
12003 ],
12004 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
12005 # applicable when performing per-zone operations.
12006 }</pre>
12007 </div>
12008
12009 <div class="method">
12010 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)</code>
12011 <pre>Retrieves the list of instances contained within
12012 the specified zone.
12013
12014 Args:
12015 project: string, Project ID for this request. (required)
12016 zone: string, The name of the zone for this request. (required)
12017 filter: string, A filter expression that filters resources listed in the response. Most
12018 Compute resources support two types of filter expressions:
12019 expressions that support regular expressions and expressions that follow
12020 API improvement proposal AIP-160.
12021 These two types of filter expressions cannot be mixed in one request.
12022
12023 If you want to use AIP-160, your expression must specify the field name, an
12024 operator, and the value that you want to use for filtering. The value
12025 must be a string, a number, or a boolean. The operator
12026 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
12027
12028 For example, if you are filtering Compute Engine instances, you can
12029 exclude instances named `example-instance` by specifying
12030 `name != example-instance`.
12031
12032 The `:*` comparison can be used to test whether a key has been defined.
12033 For example, to find all objects with `owner` label use:
12034 ```
12035 labels.owner:*
12036 ```
12037
12038 You can also filter nested fields. For example, you could specify
12039 `scheduling.automaticRestart = false` to include instances only
12040 if they are not scheduled for automatic restarts. You can use filtering
12041 on nested fields to filter based onresource labels.
12042
12043 To filter on multiple expressions, provide each separate expression within
12044 parentheses. For example:
12045 ```
12046 (scheduling.automaticRestart = true)
12047 (cpuPlatform = &quot;Intel Skylake&quot;)
12048 ```
12049 By default, each expression is an `AND` expression. However, you
12050 can include `AND` and `OR` expressions explicitly.
12051 For example:
12052 ```
12053 (cpuPlatform = &quot;Intel Skylake&quot;) OR
12054 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
12055 (scheduling.automaticRestart = true)
12056 ```
12057
12058 If you want to use a regular expression, use the `eq` (equal) or `ne`
12059 (not equal) operator against a single un-parenthesized expression with or
12060 without quotes or against multiple parenthesized expressions. Examples:
12061
12062 `fieldname eq unquoted literal`
12063 `fieldname eq &#x27;single quoted literal&#x27;`
12064 `fieldname eq &quot;double quoted literal&quot;`
12065 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
12066
12067 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
12068 The literal value must match the entire field.
12069
12070 For example, to filter for instances that do not end with name &quot;instance&quot;,
12071 you would use `name ne .*instance`.
12072
12073 You cannot combine constraints on multiple fields using regular
12074 expressions.
12075 maxResults: integer, The maximum number of results per page that should be returned.
12076 If the number of available results is larger than `maxResults`,
12077 Compute Engine returns a `nextPageToken` that can be used to get
12078 the next page of results in subsequent list requests. Acceptable values are
12079 `0` to `500`, inclusive. (Default: `500`)
12080 orderBy: string, Sorts list results by a certain order. By default, results
12081 are returned in alphanumerical order based on the resource name.
12082
12083 You can also sort results in descending order based on the creation
12084 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
12085 results based on the `creationTimestamp` field in
12086 reverse chronological order (newest result first). Use this to sort
12087 resources like operations so that the newest operation is returned first.
12088
12089 Currently, only sorting by `name` or
12090 `creationTimestamp desc` is supported.
12091 pageToken: string, Specifies a page token to use. Set `pageToken` to the
12092 `nextPageToken` returned by a previous list request to get
12093 the next page of results.
12094 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
12095 of failure. The default value is false.
12096
12097 For example, when partial success behavior is enabled, aggregatedList for a
12098 single zone scope either returns all resources in the zone or no resources,
12099 with an error code.
12100 view: string, View of the instance.
12101 Allowed values
12102 BASIC - Include everything except Partner Metadata.
12103 FULL - Include everything.
12104 INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
12105 x__xgafv: string, V1 error format.
12106 Allowed values
12107 1 - v1 error format
12108 2 - v2 error format
12109
12110 Returns:
12111 An object of the form:
12112
12113 { # Contains a list of instances.
12114 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
12115 &quot;items&quot;: [ # A list of Instance resources.
12116 { # Represents an Instance resource.
12117 #
12118 # An instance is a virtual machine that is hosted on Google Cloud Platform.
12119 # For more information, readVirtual Machine Instances.
12120 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
12121 # Options that would traditionally be configured in a BIOS belong
12122 # here. Features that require operating system support may have
12123 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
12124 # disabled).
12125 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
12126 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
12127 &quot;enableWatchdogTimer&quot;: True or False, # Whether to enable the watchdog timer.
12128 &quot;numaNodeCount&quot;: 42, # The number of vNUMA nodes.
12129 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
12130 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
12131 # multithreading (SMT) set this to 1. If unset, the maximum number
12132 # of threads supported per core by the underlying processor is
12133 # assumed.
12134 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
12135 # Supported modes include:
12136 # * ALL_CORE_MAX
12137 #
12138 # Using empty string or not setting this field will use the platform-specific
12139 # default turbo mode.
12140 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
12141 # the number of threads per core to compute the total number of virtual
12142 # CPUs to expose to the instance. If unset, the number of cores is
12143 # inferred from the instance&#x27;s nominal CPU count and the underlying
12144 # platform&#x27;s SMT width.
12145 },
12146 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
12147 # destination or source IPs. This is required if you plan to use this
12148 # instance to forward routes. For more information, seeEnabling IP Forwarding.
12149 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
12150 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
12151 &quot;confidentialParavisorConfig&quot;: { # A set of Confidential Paravisor (SVSM) options. # Defines a set of Confidential Paravisor (SVSM) options.
12152 &quot;confidentialTpmType&quot;: &quot;A String&quot;,
12153 &quot;sevSnpIrqMode&quot;: &quot;A String&quot;,
12154 },
12155 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
12156 },
12157 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
12158 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
12159 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
12160 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
12161 # create the resource.
12162 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
12163 # created before you can assign them.
12164 { # An instance-attached disk resource.
12165 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
12166 # or X86_64.
12167 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
12168 # deleted (but not when the disk is detached from the instance).
12169 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
12170 # partition of the disk for its root filesystem.
12171 &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
12172 # running within the instance. This name can be used to reference the device
12173 # for mounting, resizing, and so on, from within the instance.
12174 #
12175 # If not specified, the server chooses a default device name to apply to this
12176 # disk, in the form persistent-disk-x, where x is a number
12177 # assigned by Google Compute Engine. This field is only applicable for
12178 # persistent disks.
12179 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
12180 # encryption key.
12181 #
12182 # If you are creating a new disk, this field encrypts the new disk using
12183 # an encryption key that you provide. If you are attaching an existing
12184 # disk that is already encrypted, this field decrypts the disk using
12185 # the customer-supplied encryption key.
12186 #
12187 # If you encrypt a disk using a customer-supplied key, you must provide the
12188 # same key again when you attempt to use this resource at a later time. For
12189 # example, you must provide the key when you create a snapshot or an image
12190 # from the disk or when you attach the disk to a virtual machine instance.
12191 #
12192 # If you do not provide an encryption key, then the disk will be encrypted
12193 # using an automatically generated key and you do not need to provide a key
12194 # to use the disk later.
12195 #
12196 # Note:
12197 #
12198 # Instance templates do not storecustomer-supplied
12199 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
12200 #
12201 # You cannot create VMs that have disks with customer-supplied keys using
12202 # the bulk
12203 # insert method.
12204 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
12205 # For example:
12206 #
12207 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12208 # key_region/cryptoKeys/key
12209 #
12210 # The fully-qualifed key name may be returned for resource GET requests. For
12211 # example:
12212 #
12213 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12214 # key_region/cryptoKeys/key
12215 # /cryptoKeyVersions/1
12216 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
12217 # key. If absent, the Compute Engine default service account is used.
12218 # For example:
12219 #
12220 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
12221 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
12222 # encryption key, encoded in RFC
12223 # 4648 base64 to either encrypt or decrypt this resource. You can
12224 # provide either the rawKey or thersaEncryptedKey.
12225 # For example:
12226 #
12227 # &quot;rawKey&quot;:
12228 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
12229 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
12230 # customer-supplied encryption key to either encrypt or decrypt this
12231 # resource. You can provide either the rawKey or thersaEncryptedKey.
12232 # For example:
12233 #
12234 # &quot;rsaEncryptedKey&quot;:
12235 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
12236 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
12237 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
12238 #
12239 # The key must meet the following requirements before you can provide it to
12240 # Compute Engine:
12241 #
12242 # 1. The key is wrapped using a RSA public key certificate provided by
12243 # Google.
12244 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
12245 # encoding.
12246 #
12247 # Gets the RSA public key certificate provided by Google at:
12248 #
12249 #
12250 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
12251 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
12252 # 4648 base64 encoded SHA-256 hash of the customer-supplied
12253 # encryption key that protects this resource.
12254 },
12255 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
12256 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
12257 # currently attached to another instance. If you try to force attach a zonal
12258 # disk to an instance, you will receive an error.
12259 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
12260 # only for bootable images. Read
12261 # Enabling guest operating system features to see a list of available
12262 # options.
12263 { # Guest OS features.
12264 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
12265 # separate values. Set to one or more of the following values:
12266 #
12267 # - VIRTIO_SCSI_MULTIQUEUE
12268 # - WINDOWS
12269 # - MULTI_IP_SUBNET
12270 # - UEFI_COMPATIBLE
12271 # - GVNIC
12272 # - SEV_CAPABLE
12273 # - SUSPEND_RESUME_COMPATIBLE
12274 # - SEV_LIVE_MIGRATABLE_V2
12275 # - SEV_SNP_CAPABLE
12276 # - TDX_CAPABLE
12277 # - IDPF
12278 # - SNP_SVSM_CAPABLE
12279 # - CCA_CAPABLE
12280 #
12281 #
12282 # For more information, see
12283 # Enabling guest operating system features.
12284 },
12285 ],
12286 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
12287 # boot disk. If you have many disks attached to an instance, each
12288 # disk would have a unique index number.
12289 &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
12290 # alongside the new instance. Use initialization parameters to create boot
12291 # disks or local SSDs attached to the new instance.
12292 #
12293 # This property is mutually exclusive with the source property;
12294 # you can only define one or the other, but not both.
12295 # alongside the new instance. Use initialization parameters to create boot
12296 # disks or local SSDs attached to the new instance.
12297 #
12298 # This field is persisted and returned for instanceTemplate and not returned
12299 # in the context of instance.
12300 #
12301 # This property is mutually exclusive with the source property;
12302 # you can only define one or the other, but not both.
12303 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
12304 # arm64 or x86_64.
12305 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
12306 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
12307 # of the instance. If a disk with the same name already exists in the given
12308 # region, the existing disk is attached to the new instance and the
12309 # new disk is not created.
12310 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
12311 # 10 GB. If you specify a sourceImage, which is required for
12312 # boot disks, the default size is the size of the sourceImage.
12313 # If you do not specify a sourceImage, the default disk size
12314 # is 500 GB.
12315 &quot;diskType&quot;: &quot;A String&quot;,
12316 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
12317 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
12318 # only for bootable images. Read
12319 # Enabling guest operating system features to see a list of available
12320 # options.
12321 #
12322 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
12323 { # Guest OS features.
12324 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
12325 # separate values. Set to one or more of the following values:
12326 #
12327 # - VIRTIO_SCSI_MULTIQUEUE
12328 # - WINDOWS
12329 # - MULTI_IP_SUBNET
12330 # - UEFI_COMPATIBLE
12331 # - GVNIC
12332 # - SEV_CAPABLE
12333 # - SUSPEND_RESUME_COMPATIBLE
12334 # - SEV_LIVE_MIGRATABLE_V2
12335 # - SEV_SNP_CAPABLE
12336 # - TDX_CAPABLE
12337 # - IDPF
12338 # - SNP_SVSM_CAPABLE
12339 # - CCA_CAPABLE
12340 #
12341 #
12342 # For more information, see
12343 # Enabling guest operating system features.
12344 },
12345 ],
12346 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
12347 # which is either SCSI or NVME. The default isSCSI.
12348 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
12349 # persistent disks.
12350 &quot;a_key&quot;: &quot;A String&quot;,
12351 },
12352 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
12353 # disk.
12354 &quot;A String&quot;,
12355 ],
12356 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
12357 &quot;A String&quot;,
12358 ],
12359 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
12360 # more than one instance.
12361 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
12362 # is to use the existing disk.
12363 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
12364 # of I/O operations per second that the disk can handle. Values must be
12365 # between 10,000 and 120,000. For more details, see theExtreme persistent
12366 # disk documentation.
12367 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
12368 # number of throughput mb per second that the disk can handle. Values must
12369 # greater than or equal to 1.
12370 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
12371 # the URLs of the zones where the disk should be replicated to.
12372 # You must provide exactly two replica zones, and one zone must be the same
12373 # as the instance zone.
12374 &quot;A String&quot;,
12375 ],
12376 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
12377 # have the same definition as resource
12378 # manager tags. Keys and values can be either in numeric format,
12379 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
12380 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
12381 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
12382 # empty.
12383 &quot;a_key&quot;: &quot;A String&quot;,
12384 },
12385 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
12386 # Specified using the full or partial URL. For instance template, specify
12387 # only the resource policy name.
12388 &quot;A String&quot;,
12389 ],
12390 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
12391 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
12392 # is required.
12393 #
12394 # To create a disk with one of the public operating system
12395 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
12396 #
12397 # projects/debian-cloud/global/images/family/debian-9
12398 #
12399 #
12400 # Alternatively, use a specific version of a public operating system image:
12401 #
12402 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
12403 #
12404 #
12405 # To create a disk with a custom image that you created, specify the
12406 # image name in the following format:
12407 #
12408 # global/images/my-custom-image
12409 #
12410 #
12411 # You can also specify a custom image by its image family, which returns
12412 # the latest version of the image in that family. Replace the image name
12413 # with family/family-name:
12414 #
12415 # global/images/family/my-image-family
12416 #
12417 #
12418 # If the source image is deleted later, this field will not be set.
12419 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
12420 # encryption key of the source image. Required if the source image is
12421 # protected by a customer-supplied encryption key.
12422 #
12423 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
12424 # encryption keys, so you cannot create disks for instances in a managed instance group if the
12425 # source images are encrypted with your own keys.
12426 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
12427 # For example:
12428 #
12429 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12430 # key_region/cryptoKeys/key
12431 #
12432 # The fully-qualifed key name may be returned for resource GET requests. For
12433 # example:
12434 #
12435 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12436 # key_region/cryptoKeys/key
12437 # /cryptoKeyVersions/1
12438 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
12439 # key. If absent, the Compute Engine default service account is used.
12440 # For example:
12441 #
12442 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
12443 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
12444 # encryption key, encoded in RFC
12445 # 4648 base64 to either encrypt or decrypt this resource. You can
12446 # provide either the rawKey or thersaEncryptedKey.
12447 # For example:
12448 #
12449 # &quot;rawKey&quot;:
12450 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
12451 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
12452 # customer-supplied encryption key to either encrypt or decrypt this
12453 # resource. You can provide either the rawKey or thersaEncryptedKey.
12454 # For example:
12455 #
12456 # &quot;rsaEncryptedKey&quot;:
12457 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
12458 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
12459 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
12460 #
12461 # The key must meet the following requirements before you can provide it to
12462 # Compute Engine:
12463 #
12464 # 1. The key is wrapped using a RSA public key certificate provided by
12465 # Google.
12466 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
12467 # encoding.
12468 #
12469 # Gets the RSA public key certificate provided by Google at:
12470 #
12471 #
12472 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
12473 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
12474 # 4648 base64 encoded SHA-256 hash of the customer-supplied
12475 # encryption key that protects this resource.
12476 },
12477 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
12478 # instance boot disk, one of initializeParams.sourceSnapshot
12479 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
12480 # is required.
12481 #
12482 # To create a disk with a snapshot that you created, specify the
12483 # snapshot name in the following format:
12484 #
12485 # us-central1-a/instantSnapshots/my-backup
12486 #
12487 #
12488 # If the source instant-snapshot is deleted later, this field will not be
12489 # set.
12490 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
12491 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
12492 # is required.
12493 #
12494 # To create a disk with a snapshot that you created, specify the
12495 # snapshot name in the following format:
12496 #
12497 # global/snapshots/my-backup
12498 #
12499 #
12500 # If the source snapshot is deleted later, this field will not be set.
12501 #
12502 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
12503 # an image instead when you create VMs using
12504 # the bulk
12505 # insert method.
12506 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
12507 # encryption key of the source snapshot.
12508 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
12509 # For example:
12510 #
12511 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12512 # key_region/cryptoKeys/key
12513 #
12514 # The fully-qualifed key name may be returned for resource GET requests. For
12515 # example:
12516 #
12517 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12518 # key_region/cryptoKeys/key
12519 # /cryptoKeyVersions/1
12520 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
12521 # key. If absent, the Compute Engine default service account is used.
12522 # For example:
12523 #
12524 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
12525 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
12526 # encryption key, encoded in RFC
12527 # 4648 base64 to either encrypt or decrypt this resource. You can
12528 # provide either the rawKey or thersaEncryptedKey.
12529 # For example:
12530 #
12531 # &quot;rawKey&quot;:
12532 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
12533 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
12534 # customer-supplied encryption key to either encrypt or decrypt this
12535 # resource. You can provide either the rawKey or thersaEncryptedKey.
12536 # For example:
12537 #
12538 # &quot;rsaEncryptedKey&quot;:
12539 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
12540 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
12541 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
12542 #
12543 # The key must meet the following requirements before you can provide it to
12544 # Compute Engine:
12545 #
12546 # 1. The key is wrapped using a RSA public key certificate provided by
12547 # Google.
12548 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
12549 # encoding.
12550 #
12551 # Gets the RSA public key certificate provided by Google at:
12552 #
12553 #
12554 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
12555 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
12556 # 4648 base64 encoded SHA-256 hash of the customer-supplied
12557 # encryption key that protects this resource.
12558 },
12559 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
12560 # this as a partial or full URL to the resource. For example, the following
12561 # are valid values:
12562 #
12563 #
12564 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
12565 # - projects/project/zones/zone/storagePools/storagePool
12566 # - zones/zone/storagePools/storagePool
12567 },
12568 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
12569 # either SCSI or NVME. For most machine types, the
12570 # default is SCSI. Local SSDs can use either NVME or SCSI.
12571 # In certain configurations, persistent disks can use NVMe. For more
12572 # information, seeAbout
12573 # persistent disks.
12574 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
12575 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
12576 &quot;A String&quot;,
12577 ],
12578 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
12579 # disk is not allowed to be detached from the instance, or to be used as the
12580 # source of the snapshot creation, and the image creation. The instance with
12581 # at least one locked attached disk is not allow to be used as source of
12582 # machine image creation, instant snapshot creation, and not allowed to be
12583 # deleted with --keep-disk parameter set to true for locked disks.
12584 &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
12585 # in READ_WRITE mode.
12586 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
12587 # field is set to PRESERVED if the LocalSSD data has been saved
12588 # to a persistent location by customer request. (see the
12589 # discard_local_ssd option on Stop/Suspend).
12590 # Read-only in the api.
12591 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
12592 # these are public keys which are safe to store in public
12593 &quot;dbs&quot;: [ # The Key Database (db).
12594 {
12595 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
12596 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
12597 },
12598 ],
12599 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
12600 {
12601 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
12602 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
12603 },
12604 ],
12605 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
12606 {
12607 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
12608 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
12609 },
12610 ],
12611 &quot;pk&quot;: { # The Platform Key (PK).
12612 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
12613 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
12614 },
12615 },
12616 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
12617 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
12618 # is required.
12619 #
12620 # If desired, you can also attach existing non-root persistent disks using
12621 # this property. This field is only applicable for persistent disks.
12622 #
12623 # Note that for InstanceTemplate, specify the disk name for zonal disk,
12624 # and the URL for regional disk.
12625 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
12626 },
12627 ],
12628 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
12629 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
12630 },
12631 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
12632 # machine image should erase Windows specific VSS signature.
12633 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
12634 # the instance&#x27;s contents and used for optimistic locking. The
12635 # fingerprint is initially generated by Compute Engine and changes after
12636 # every request to modify or update the instance. You must always provide an
12637 # up-to-date fingerprint hash in order to update the instance.
12638 #
12639 # To see the latest fingerprint, make get() request to the
12640 # instance.
12641 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
12642 { # A specification of the type and number of accelerator cards attached to the
12643 # instance.
12644 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
12645 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
12646 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
12647 # If you are creating an instance template, specify only the
12648 # accelerator name.
12649 # See GPUs on Compute Engine
12650 # for a full list of accelerator types.
12651 },
12652 ],
12653 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
12654 # RFC1035 compliant. If hostname is not specified, the default hostname is
12655 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
12656 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
12657 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
12658 # defined by the server.
12659 &quot;identity&quot;: &quot;A String&quot;,
12660 &quot;identityCertificate&quot;: True or False,
12661 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
12662 # encryption key.
12663 #
12664 # If you are creating a new instance, this field will encrypt the local SSD
12665 # and in-memory contents of the instance during the suspend operation.
12666 #
12667 # If you do not provide an encryption key when creating the instance, then
12668 # the local SSD and in-memory contents will be encrypted using
12669 # an automatically generated key during the suspend operation.
12670 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
12671 # For example:
12672 #
12673 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12674 # key_region/cryptoKeys/key
12675 #
12676 # The fully-qualifed key name may be returned for resource GET requests. For
12677 # example:
12678 #
12679 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
12680 # key_region/cryptoKeys/key
12681 # /cryptoKeyVersions/1
12682 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
12683 # key. If absent, the Compute Engine default service account is used.
12684 # For example:
12685 #
12686 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
12687 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
12688 # encryption key, encoded in RFC
12689 # 4648 base64 to either encrypt or decrypt this resource. You can
12690 # provide either the rawKey or thersaEncryptedKey.
12691 # For example:
12692 #
12693 # &quot;rawKey&quot;:
12694 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
12695 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
12696 # customer-supplied encryption key to either encrypt or decrypt this
12697 # resource. You can provide either the rawKey or thersaEncryptedKey.
12698 # For example:
12699 #
12700 # &quot;rsaEncryptedKey&quot;:
12701 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
12702 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
12703 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
12704 #
12705 # The key must meet the following requirements before you can provide it to
12706 # Compute Engine:
12707 #
12708 # 1. The key is wrapped using a RSA public key certificate provided by
12709 # Google.
12710 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
12711 # encoding.
12712 #
12713 # Gets the RSA public key certificate provided by Google at:
12714 #
12715 #
12716 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
12717 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
12718 # 4648 base64 encoded SHA-256 hash of the customer-supplied
12719 # encryption key that protects this resource.
12720 },
12721 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
12722 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
12723 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
12724 # for instances.
12725 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
12726 # the label&#x27;s contents and used for optimistic locking. The
12727 # fingerprint is initially generated by Compute Engine and changes after
12728 # every request to modify or update labels. You must always provide an
12729 # up-to-date fingerprint hash in order to update or change labels.
12730 #
12731 # To see the latest fingerprint, make get() request to the
12732 # instance.
12733 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
12734 # the setLabels method.
12735 &quot;a_key&quot;: &quot;A String&quot;,
12736 },
12737 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
12738 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
12739 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
12740 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
12741 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
12742 # when the instance is created. For example, the following is a valid partial
12743 # url to a predefined
12744 # machine type:
12745 #
12746 # zones/us-central1-f/machineTypes/n1-standard-1
12747 #
12748 #
12749 # To create acustom
12750 # machine type, provide a URL to a machine type in the following format,
12751 # where CPUS is 1 or an even number up to 32 (2,
12752 # 4, 6, ... 24, etc), and MEMORY is the total
12753 # memory for this instance. Memory must be a multiple of 256 MB and must
12754 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
12755 #
12756 # zones/zone/machineTypes/custom-CPUS-MEMORY
12757 #
12758 #
12759 # For example: zones/us-central1-f/machineTypes/custom-4-5120
12760 # For a full list of restrictions, read theSpecifications
12761 # for custom machine types.
12762 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
12763 # to this instance. This includes metadata keys that were explicitly defined
12764 # for the instance.
12765 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
12766 # the metadata&#x27;s contents and used for optimistic locking. The
12767 # fingerprint is initially generated by Compute Engine and changes after
12768 # every request to modify or update metadata. You must always provide an
12769 # up-to-date fingerprint hash in order to update or change metadata,
12770 # otherwise the request will fail with error412 conditionNotMet.
12771 #
12772 # To see the latest fingerprint, make a get() request to
12773 # retrieve the resource.
12774 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
12775 # less than 512 KB.
12776 { # Metadata
12777 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
12778 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
12779 # This is reflected as part of a URL in the metadata server. Additionally, to
12780 # avoid ambiguity, keys must not conflict with any other metadata keys
12781 # for the project.
12782 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
12783 # have meaning as interpreted by the image running in the instance. The
12784 # only restriction placed on values is that their size must be less than
12785 # or equal to 262144 bytes (256 KiB).
12786 },
12787 ],
12788 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
12789 # for metadata.
12790 },
12791 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
12792 # platform for the VM instance. Applicable values are the friendly names
12793 # of CPU platforms, such as minCpuPlatform: &quot;Intel
12794 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
12795 # Bridge&quot;.
12796 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
12797 # the resource. The resource name must be 1-63 characters long, and comply
12798 # withRFC1035.
12799 # Specifically, the name must be 1-63 characters long and match the regular
12800 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
12801 # character must be a lowercase letter, and all following characters must be
12802 # a dash, lowercase letter, or digit, except the last character, which cannot
12803 # be a dash.
12804 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
12805 # interfaces are configured to interact with other network services, such as
12806 # connecting to the internet. Multiple interfaces are supported
12807 # per instance.
12808 { # A network interface resource attached to an instance.
12809 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
12810 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
12811 # no external internet access.
12812 { # An access configuration attached to an instance&#x27;s network interface.
12813 # Only one access config per instance is supported.
12814 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
12815 # The first IPv6 address of the external IPv6 range associated
12816 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
12817 # use a static external IP address, it must be unused and in the same region
12818 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
12819 # assign an external IPv6 address from the instance&#x27;s subnetwork.
12820 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
12821 # external IPv6 range.
12822 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
12823 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
12824 # (IPv4), the default and recommended name is External NAT, but
12825 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
12826 # recommend name is External IPv6.
12827 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
12828 # address associated with this instance. Specify an unused static
12829 # external IP address available to the project or leave this field undefined
12830 # to use an IP from a shared ephemeral IP address pool. If you specify a
12831 # static external IP address, it must live in the same region as the zone of
12832 # the instance.
12833 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
12834 # configuration and can only take the following values: PREMIUM,STANDARD.
12835 #
12836 # If an AccessConfig is specified without a valid external IP address, an
12837 # ephemeral IP will be created with this networkTier.
12838 #
12839 # If an AccessConfig with a valid external IP address is specified, it must
12840 # match that of the networkTier associated with the Address resource owning
12841 # that IP.
12842 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
12843 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
12844 #
12845 # 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
12846 # first IP in associated external IPv6 range.
12847 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
12848 # config.
12849 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
12850 # external IP address of this access configuration.
12851 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
12852 # external IP address of the instance to a DNS domain name.
12853 #
12854 # This field is not used in ipv6AccessConfig. A default PTR
12855 # record will be created if the VM has external IPv6 range associated.
12856 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
12857 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
12858 },
12859 ],
12860 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
12861 # You can only specify this field for network interfaces in VPC networks.
12862 { # An alias IP range attached to an instance&#x27;s network interface.
12863 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
12864 # must belong to the specified subnetwork and cannot contain IP addresses
12865 # reserved by system or used by other network interfaces. This range may be
12866 # 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).
12867 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
12868 # alias range. If not specified, the primary range of the subnetwork is used.
12869 },
12870 ],
12871 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
12872 # You can only specify this field for network interfaces in VPC networks.
12873 { # An alias IP range attached to an instance&#x27;s network interface.
12874 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
12875 # must belong to the specified subnetwork and cannot contain IP addresses
12876 # reserved by system or used by other network interfaces. This range may be
12877 # 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).
12878 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
12879 # alias range. If not specified, the primary range of the subnetwork is used.
12880 },
12881 ],
12882 &quot;dns64Eligible&quot;: True or False, # If true, this network interface is eligible for DNS64.
12883 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
12884 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
12885 # with network_attachment.
12886 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
12887 # This field will be ignored when inserting an Instance or
12888 # adding a NetworkInterface. An up-to-date
12889 # 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.
12890 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
12891 # or not. If enabled, also indicates the version of IGMP supported.
12892 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
12893 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
12894 # one IPv6 access config, DIRECT_IPV6, is supported. If there
12895 # is no ipv6AccessConfig specified, then this instance will
12896 # have no external IPv6 Internet access.
12897 { # An access configuration attached to an instance&#x27;s network interface.
12898 # Only one access config per instance is supported.
12899 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
12900 # The first IPv6 address of the external IPv6 range associated
12901 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
12902 # use a static external IP address, it must be unused and in the same region
12903 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
12904 # assign an external IPv6 address from the instance&#x27;s subnetwork.
12905 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
12906 # external IPv6 range.
12907 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
12908 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
12909 # (IPv4), the default and recommended name is External NAT, but
12910 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
12911 # recommend name is External IPv6.
12912 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
12913 # address associated with this instance. Specify an unused static
12914 # external IP address available to the project or leave this field undefined
12915 # to use an IP from a shared ephemeral IP address pool. If you specify a
12916 # static external IP address, it must live in the same region as the zone of
12917 # the instance.
12918 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
12919 # configuration and can only take the following values: PREMIUM,STANDARD.
12920 #
12921 # If an AccessConfig is specified without a valid external IP address, an
12922 # ephemeral IP will be created with this networkTier.
12923 #
12924 # If an AccessConfig with a valid external IP address is specified, it must
12925 # match that of the networkTier associated with the Address resource owning
12926 # that IP.
12927 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
12928 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
12929 #
12930 # 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
12931 # first IP in associated external IPv6 range.
12932 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
12933 # config.
12934 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
12935 # external IP address of this access configuration.
12936 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
12937 # external IP address of the instance to a DNS domain name.
12938 #
12939 # This field is not used in ipv6AccessConfig. A default PTR
12940 # record will be created if the VM has external IPv6 range associated.
12941 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
12942 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
12943 },
12944 ],
12945 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
12946 # accessed from the Internet. This field is always inherited from its
12947 # subnetwork.
12948 #
12949 # Valid only if stackType is IPV4_IPV6.
12950 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
12951 # use a static internal IP address, it must be unused and in the same region
12952 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
12953 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
12954 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
12955 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
12956 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
12957 # server. For a VM, the network interface uses the nicN naming
12958 # format. Where N is a value between 0 and7. The default interface value is nic0.
12959 &quot;nat64Eligible&quot;: True or False, # If true, this network interface is eligible for NAT64.
12960 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
12961 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
12962 # instance, if neither the network nor the subnetwork is specified, the
12963 # default network global/networks/default is used. If the
12964 # selected project doesn&#x27;t have the default network, you must specify a
12965 # network or subnet. If the network is not specified but the subnetwork is
12966 # specified, the network is inferred.
12967 #
12968 # If you specify this property, you can specify the network as
12969 # a full or partial URL. For example, the following are all valid URLs:
12970 #
12971 #
12972 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
12973 # - projects/project/global/networks/network
12974 # - global/networks/default
12975 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
12976 # to in the following format:
12977 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
12978 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
12979 # interface. If not specified by the user, an unused internal IP is
12980 # assigned by the system.
12981 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
12982 # VirtioNet.
12983 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
12984 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
12985 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
12986 # if not specified by the users.
12987 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
12988 # interface. Can only be used with network_attachment. It is not possible to
12989 # use on its own however, network_attachment can be used without
12990 # service_class_id.
12991 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
12992 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
12993 #
12994 # This field can be both set at instance creation and update network
12995 # interface operations.
12996 &quot;subinterfaces&quot;: [ # SubInterfaces help enable L2 communication for the instance over
12997 # subnetworks that support L2. Every network interface will get a default
12998 # untagged (vlan not specified) subinterface. Users can specify additional
12999 # tagged subinterfaces which are sub-fields to the Network Interface.
13000 {
13001 &quot;ipAddress&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this
13002 # subinterface. If specified, ip_allocation_mode should be set to
13003 # ALLOCATE_IP.
13004 &quot;ipAllocationMode&quot;: &quot;A String&quot;,
13005 &quot;subnetwork&quot;: &quot;A String&quot;, # If specified, this subnetwork must belong to the same network
13006 # as that of the network interface.
13007 # If not specified the subnet of network interface will be used.
13008 # If you specify this property, you can specify the subnetwork as a full
13009 # or partial URL. For example, the following are all valid URLs:
13010 #
13011 #
13012 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
13013 # - regions/region/subnetworks/subnetwork
13014 &quot;vlan&quot;: 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which
13015 # this subinterface is connecting.
13016 },
13017 ],
13018 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
13019 # resource is inlegacy
13020 # mode, do not specify this field. If the network is in auto subnet
13021 # mode, specifying the subnetwork is optional. If the network is in custom
13022 # subnet mode, specifying the subnetwork is required. If you specify this
13023 # field, you can specify the subnetwork as a full or partial URL. For
13024 # example, the following are all valid URLs:
13025 #
13026 #
13027 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
13028 # - regions/region/subnetworks/subnetwork
13029 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
13030 # from 2 to 255 inclusively.
13031 },
13032 ],
13033 &quot;networkPerformanceConfig&quot;: {
13034 &quot;externalIpEgressBandwidthTier&quot;: &quot;A String&quot;,
13035 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
13036 },
13037 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
13038 # as part of resource payload.
13039 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
13040 # Instances.Insert API.
13041 # as a count of seconds and fractions of seconds at nanosecond
13042 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13043 # or &quot;month&quot;. Range is approximately 10,000 years.
13044 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13045 # Durations less than one second are represented with a 0
13046 # `seconds` field and a positive `nanos` field. Must be from 0
13047 # to 999,999,999 inclusive.
13048 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13049 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13050 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13051 },
13052 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
13053 # have the same definition as resource
13054 # manager tags. Keys and values can be either in numeric format,
13055 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
13056 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
13057 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
13058 # PATCH) when empty.
13059 &quot;a_key&quot;: &quot;A String&quot;,
13060 },
13061 },
13062 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
13063 # (namespace) to entries map.
13064 &quot;a_key&quot;: {
13065 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
13066 # It accepts any value including google.protobuf.Struct.
13067 &quot;a_key&quot;: &quot;&quot;,
13068 },
13069 },
13070 },
13071 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
13072 &quot;preservedStateSizeGb&quot;: &quot;A String&quot;, # Output only. Total amount of preserved state for SUSPENDED instances.
13073 # Read-only in the api.
13074 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
13075 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
13076 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
13077 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
13078 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
13079 # Consuming reserved instances for examples.
13080 &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
13081 # the name of your reservation as its value.
13082 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
13083 # either a name to a reservation in the same project or
13084 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
13085 # shared reservation in the same zone but in a different project.
13086 &quot;A String&quot;,
13087 ],
13088 },
13089 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
13090 &quot;A String&quot;,
13091 ],
13092 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
13093 # compared to the values requested by user in the corresponding input only
13094 # field.
13095 # Use this sub-message for actual values set on Instance attributes as compared
13096 # to the value requested by the user (intent) in their instance CRUD calls.
13097 &quot;acceleratorStatus&quot;: [ # Output only. [Output Only] Accelerators status show results of GPU scans. These scans
13098 # are specialized diagnostic tests designed to uncover latent manufacturing
13099 # defects or other issues that could potentially lead to data corruption or
13100 # impede the customer&#x27;s ability to efficiently execute GPU workloads.
13101 { # The status of an individual accelerator resource.
13102 &quot;passedScans&quot;: [ # The details of scans that passed for an accelerator.
13103 {
13104 &quot;endTime&quot;: &quot;A String&quot;, # The end time of the passed scan inRFC3339 text format.
13105 &quot;name&quot;: &quot;A String&quot;,
13106 &quot;startTime&quot;: &quot;A String&quot;, # The start time of the passed scan inRFC3339 text format.
13107 &quot;version&quot;: &quot;A String&quot;,
13108 },
13109 ],
13110 &quot;recommendedScans&quot;: [ # The details of recommended scans for an accelerator.
13111 {
13112 &quot;estimatedDuration&quot;: { # A Duration represents a fixed-length span of time represented
13113 # as a count of seconds and fractions of seconds at nanosecond
13114 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13115 # or &quot;month&quot;. Range is approximately 10,000 years.
13116 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13117 # Durations less than one second are represented with a 0
13118 # `seconds` field and a positive `nanos` field. Must be from 0
13119 # to 999,999,999 inclusive.
13120 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13121 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13122 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13123 },
13124 &quot;name&quot;: &quot;A String&quot;,
13125 &quot;version&quot;: &quot;A String&quot;,
13126 },
13127 ],
13128 &quot;serialNumber&quot;: &quot;A String&quot;, # The serial number of the accelerator.
13129 &quot;uuid&quot;: &quot;A String&quot;, # The UUID of the accelerator.
13130 },
13131 ],
13132 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this instance
13133 # is consuming from.
13134 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
13135 # instance is consuming from.
13136 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
13137 # zonal instance settings, and instance-level predefined metadata keys to
13138 # provide the overridden value for those metadata keys at the instance level.
13139 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
13140 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
13141 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
13142 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
13143 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
13144 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
13145 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
13146 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
13147 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
13148 },
13149 &quot;lastInstanceTerminationDetails&quot;: { # Output only. [Output Only] Contains last termination details why the instance was
13150 # terminated.
13151 &quot;terminationReason&quot;: &quot;A String&quot;, # Reason for termination
13152 },
13153 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
13154 # center, including the block, sub-block, and host. The field is formatted as
13155 # follows: blockId/subBlockId/hostId.
13156 &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
13157 # Engine cluster, as well as the ID of the block, sub-block, and host on
13158 # which the running instance is located.
13159 # running.
13160 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
13161 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
13162 # example
13163 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
13164 # the location ID of the topologies.
13165 &quot;a_key&quot;: &quot;A String&quot;,
13166 },
13167 },
13168 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
13169 # located. Instances within the same block experience low network latency.
13170 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
13171 # running instance is located.
13172 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
13173 # Instances on the same host experience the lowest possible network
13174 # latency.
13175 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
13176 # located. Instances in the same sub-block experience lower network latency
13177 # than instances in the same block.
13178 },
13179 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
13180 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
13181 # instance is consuming from.
13182 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
13183 # instance is consuming from.
13184 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
13185 # this instance is consuming from.
13186 },
13187 &quot;scheduling&quot;: {
13188 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
13189 # must be a number between 1 and the number of availability domains
13190 # specified in the spread placement policy attached to the instance.
13191 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
13192 },
13193 &quot;serviceIntegrationStatuses&quot;: { # [Output Only] Represents the status of the service integration specs
13194 # defined by the user in instance.serviceIntegrationSpecs.
13195 &quot;a_key&quot;: { # Represents the status of integration between instance and another service.
13196 # See go/gce-backupdr-design for more details.
13197 &quot;backupDr&quot;: { # Message defining compute perspective of the result of integration with
13198 # Backup and DR. FAILED status indicates that the operation specified did
13199 # not complete correctly and should be retried with the same value.
13200 &quot;integrationDetails&quot;: &quot;A String&quot;, # The PlanReference object created by Backup and DR to maintain the
13201 # actual status of backups. May still be present if removing the backup
13202 # plan fails.
13203 &quot;state&quot;: &quot;A String&quot;, # Enum representing the registration state of a Backup and DR backup plan
13204 # for the instance.
13205 },
13206 },
13207 },
13208 &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.
13209 # programmed stop scheduled.
13210 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
13211 # `stop_state=PENDING_STOP`.
13212 # as a count of seconds and fractions of seconds at nanosecond
13213 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13214 # or &quot;month&quot;. Range is approximately 10,000 years.
13215 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13216 # Durations less than one second are represented with a 0
13217 # `seconds` field and a positive `nanos` field. Must be from 0
13218 # to 999,999,999 inclusive.
13219 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13220 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13221 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13222 },
13223 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
13224 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
13225 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
13226 },
13227 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
13228 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
13229 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
13230 # This value is inRFC3339
13231 # text format.
13232 # DEPRECATED: Use window_start_time instead.
13233 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
13234 # This timestamp value is in RFC3339 text format.
13235 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
13236 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
13237 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
13238 &quot;A String&quot;,
13239 ],
13240 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
13241 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
13242 # DEPRECATED: Use window_start_time instead.
13243 # TimeWindow is a container for two strings that represent timestamps in
13244 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
13245 &quot;earliest&quot;: &quot;A String&quot;,
13246 &quot;latest&quot;: &quot;A String&quot;,
13247 },
13248 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
13249 # This value is inRFC3339
13250 # text format.
13251 # DEPRECATED: Use window_start_time instead.
13252 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
13253 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
13254 # This timestamp value is in RFC3339 text format.
13255 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
13256 # This timestamp value is in RFC3339 text format.
13257 },
13258 },
13259 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
13260 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
13261 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
13262 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
13263 # terminated by Compute Engine (not terminated by a user). You can only set
13264 # the automatic restart option for standard instances.Preemptible instances
13265 # cannot be automatically restarted.
13266 #
13267 # By default, this is set to true so an instance is
13268 # automatically restarted if it is terminated by Compute Engine.
13269 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
13270 # must be a number between 1 and the number of availability domains
13271 # specified in the spread placement policy attached to the instance.
13272 &quot;currentCpus&quot;: 42, # Current number of vCPUs available for VM.
13273 # 0 or unset means default vCPUs of the current machine type.
13274 &quot;currentMemoryMb&quot;: &quot;A String&quot;, # Current amount of memory (in MB) available for VM.
13275 # 0 or unset means default amount of memory of the current machine type.
13276 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
13277 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
13278 &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
13279 # graceful shutdown isn&#x27;t complete after this time, then the instance
13280 # transitions to the STOPPING state.
13281 # as a count of seconds and fractions of seconds at nanosecond
13282 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13283 # or &quot;month&quot;. Range is approximately 10,000 years.
13284 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13285 # Durations less than one second are represented with a 0
13286 # `seconds` field and a positive `nanos` field. Must be from 0
13287 # to 999,999,999 inclusive.
13288 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13289 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13290 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13291 },
13292 },
13293 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
13294 # within the range of [90, 330] with the increment of 30, if unset, the
13295 # default behavior of host error recovery will be used.
13296 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
13297 &quot;latencyTolerant&quot;: True or False, # Defines whether the instance is tolerant of higher cpu latency. This can
13298 # only be set during instance creation, or when the instance is not currently
13299 # running. It must not be set if thepreemptible option is
13300 # also set.
13301 &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
13302 # recovery of the Local Ssd state is attempted. Its value should be in
13303 # between 0 and 168 hours with hour granularity and the default value being 1
13304 # hour.
13305 # as a count of seconds and fractions of seconds at nanosecond
13306 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13307 # or &quot;month&quot;. Range is approximately 10,000 years.
13308 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13309 # Durations less than one second are represented with a 0
13310 # `seconds` field and a positive `nanos` field. Must be from 0
13311 # to 999,999,999 inclusive.
13312 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13313 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13314 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13315 },
13316 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
13317 # resources.
13318 # This field is for use by internal tools that use the public API.
13319 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
13320 # be scheduled for maintenance.
13321 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
13322 # are: `PERIODIC`.
13323 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
13324 # the instance termination action will be performed at the end of the run
13325 # duration.
13326 # as a count of seconds and fractions of seconds at nanosecond
13327 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13328 # or &quot;month&quot;. Range is approximately 10,000 years.
13329 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13330 # Durations less than one second are represented with a 0
13331 # `seconds` field and a positive `nanos` field. Must be from 0
13332 # to 999,999,999 inclusive.
13333 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13334 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13335 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13336 },
13337 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
13338 # on a sole-tenant node.
13339 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
13340 # affinity for more information.
13341 # Overrides reservationAffinity.
13342 { # Node Affinity: the configuration of desired nodes onto which this Instance
13343 # could be scheduled.
13344 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
13345 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
13346 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
13347 &quot;A String&quot;,
13348 ],
13349 },
13350 ],
13351 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
13352 # the default behavior is MIGRATE. Forpreemptible instances,
13353 # the default and only possible behavior is TERMINATE. For more
13354 # information, see
13355 # Set
13356 # VM host maintenance policy.
13357 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
13358 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
13359 # else, the Local SSD data will be preserved when the instance is stopped
13360 # at the end of the run duration/termination time.
13361 },
13362 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
13363 # instance creation or while the instance isstopped and
13364 # therefore, in a `TERMINATED` state. SeeInstance Life
13365 # Cycle for more information on the possible instance states.
13366 &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
13367 # Off signal is triggered for Spot
13368 # VMs only. If not specified, there will be no wait before the G2 Soft
13369 # Off signal is triggered.
13370 # as a count of seconds and fractions of seconds at nanosecond
13371 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13372 # or &quot;month&quot;. Range is approximately 10,000 years.
13373 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13374 # Durations less than one second are represented with a 0
13375 # `seconds` field and a positive `nanos` field. Must be from 0
13376 # to 999,999,999 inclusive.
13377 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13378 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13379 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13380 },
13381 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
13382 &quot;shutdownTimeout&quot;: { # A Duration represents a fixed-length span of time represented # DEPRECATED: please use skipGuestOsShutdown.
13383 # Timeout between GCE ACPI G2 Soft
13384 # Off and ACPI G3 Mechanical
13385 # Off during shutdown operation of VM.
13386 #
13387 # For Standard VMs values between 0s and 120s are allowed. For Spot and
13388 # Preemptible VMs supported values are between 0s and 30s.
13389 #
13390 # If no value is specified for shutdownDuration, default values are 90s for
13391 # Standard VMs and 30s for Spot/Preemptible VMs.
13392 # as a count of seconds and fractions of seconds at nanosecond
13393 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13394 # or &quot;month&quot;. Range is approximately 10,000 years.
13395 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13396 # Durations less than one second are represented with a 0
13397 # `seconds` field and a positive `nanos` field. Must be from 0
13398 # to 999,999,999 inclusive.
13399 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13400 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13401 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13402 },
13403 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
13404 # Off and ACPI G3 Mechanical
13405 # Off for Standard VMs and 30 seconds for Spot VMs.
13406 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
13407 # termination action will be performed at the termination time.
13408 &quot;vsockMode&quot;: { # Message to control the enablement of the vsock device. # The vsock mode of the instance.
13409 &quot;mode&quot;: &quot;A String&quot;,
13410 },
13411 &quot;windowsLicenseOptimizationMode&quot;: &quot;A String&quot;, # Represents the Windows Server License Optimization Mode of the VM. If
13412 # unspecified, the default mode is `OFF`.
13413 },
13414 &quot;secureTags&quot;: [ # [Input Only] Secure tags to apply to this instance. These can be later
13415 # modified by the update method.
13416 # Maximum number of secure tags allowed is 50.
13417 &quot;A String&quot;,
13418 ],
13419 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
13420 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
13421 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
13422 # this instance. Only one service account per VM instance is supported.
13423 #
13424 # Service accounts generate access tokens that can be accessed
13425 # through the metadata server and used to authenticate applications on the
13426 # instance. SeeService Accounts
13427 # for more information.
13428 { # A service account.
13429 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
13430 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
13431 &quot;A String&quot;,
13432 ],
13433 },
13434 ],
13435 &quot;serviceIntegrationSpecs&quot;: { # Mapping of user-defined keys to specifications for service integrations.
13436 # Currently only a single key-value pair is supported.
13437 &quot;a_key&quot;: { # Specifies the parameters to configure an integration with instances.
13438 &quot;backupDr&quot;: { # Specifies parameters to Backup and DR to attach a BackupPlan to a compute
13439 # instance for managed VM backup.
13440 &quot;plan&quot;: &quot;A String&quot;, # The BackupPlan resource to attach to the instance. Specified as a
13441 # resource reference in instances, and regional instance templates, and as
13442 # just the plan name in global instance templates
13443 },
13444 },
13445 },
13446 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
13447 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
13448 # default.
13449 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
13450 # default.
13451 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
13452 # default.
13453 },
13454 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
13455 # Instance boot integrity is measured.
13456 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
13457 # measurements from the VM instance&#x27;s most recent boot.
13458 },
13459 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
13460 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
13461 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
13462 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
13463 },
13464 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
13465 # VM instance boot integrity is measured.
13466 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
13467 # measurements from the VM instance&#x27;s most recent boot.
13468 },
13469 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
13470 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
13471 # machine image.
13472 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
13473 # For example:
13474 #
13475 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
13476 # key_region/cryptoKeys/key
13477 #
13478 # The fully-qualifed key name may be returned for resource GET requests. For
13479 # example:
13480 #
13481 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
13482 # key_region/cryptoKeys/key
13483 # /cryptoKeyVersions/1
13484 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
13485 # key. If absent, the Compute Engine default service account is used.
13486 # For example:
13487 #
13488 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
13489 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
13490 # encryption key, encoded in RFC
13491 # 4648 base64 to either encrypt or decrypt this resource. You can
13492 # provide either the rawKey or thersaEncryptedKey.
13493 # For example:
13494 #
13495 # &quot;rawKey&quot;:
13496 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
13497 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
13498 # customer-supplied encryption key to either encrypt or decrypt this
13499 # resource. You can provide either the rawKey or thersaEncryptedKey.
13500 # For example:
13501 #
13502 # &quot;rsaEncryptedKey&quot;:
13503 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
13504 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
13505 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
13506 #
13507 # The key must meet the following requirements before you can provide it to
13508 # Compute Engine:
13509 #
13510 # 1. The key is wrapped using a RSA public key certificate provided by
13511 # Google.
13512 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
13513 # encoding.
13514 #
13515 # Gets the RSA public key certificate provided by Google at:
13516 #
13517 #
13518 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
13519 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
13520 # 4648 base64 encoded SHA-256 hash of the customer-supplied
13521 # encryption key that protects this resource.
13522 },
13523 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
13524 # Engine has detected suspicious activity.
13525 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
13526 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
13527 # instance, see
13528 # Instance life cycle.
13529 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
13530 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
13531 # sources or targets for network firewalls and are specified by the client
13532 # during instance creation. The tags can be later modified by the setTags
13533 # method. Each tag within the list must comply withRFC1035.
13534 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
13535 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
13536 # the tags&#x27; contents and used for optimistic locking. The
13537 # fingerprint is initially generated by Compute Engine and changes after
13538 # every request to modify or update tags. You must always provide an
13539 # up-to-date fingerprint hash in order to update or change tags.
13540 #
13541 # To see the latest fingerprint, make get() request to the
13542 # instance.
13543 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
13544 # with RFC1035.
13545 &quot;A String&quot;,
13546 ],
13547 },
13548 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. [Output Only] DEPRECATED: Please useresource_status.upcoming_maintenance instead. Specifies
13549 # upcoming maintenance for the instance.
13550 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
13551 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
13552 # This value is inRFC3339
13553 # text format.
13554 # DEPRECATED: Use window_start_time instead.
13555 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
13556 # This timestamp value is in RFC3339 text format.
13557 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
13558 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
13559 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
13560 &quot;A String&quot;,
13561 ],
13562 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
13563 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
13564 # DEPRECATED: Use window_start_time instead.
13565 # TimeWindow is a container for two strings that represent timestamps in
13566 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
13567 &quot;earliest&quot;: &quot;A String&quot;,
13568 &quot;latest&quot;: &quot;A String&quot;,
13569 },
13570 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
13571 # This value is inRFC3339
13572 # text format.
13573 # DEPRECATED: Use window_start_time instead.
13574 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
13575 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
13576 # This timestamp value is in RFC3339 text format.
13577 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
13578 # This timestamp value is in RFC3339 text format.
13579 },
13580 &quot;workloadIdentityConfig&quot;: {
13581 &quot;identity&quot;: &quot;A String&quot;,
13582 &quot;identityCertificateEnabled&quot;: True or False,
13583 },
13584 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
13585 # You must specify this field as part of the HTTP request URL. It is
13586 # not settable as a field in the request body.
13587 },
13588 ],
13589 &quot;kind&quot;: &quot;compute#instanceList&quot;, # Output only. [Output Only] Type of resource. Always compute#instanceList
13590 # for lists of Instance resources.
13591 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
13592 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
13593 # the query parameter pageToken in the next list request.
13594 # Subsequent list requests will have their own nextPageToken to
13595 # continue paging through the results.
13596 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
13597 &quot;warning&quot;: { # [Output Only] Informational warning message.
13598 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13599 # Engine returns NO_RESULTS_ON_PAGE if there
13600 # are no results in the response.
13601 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13602 # value format. For example:
13603 #
13604 # &quot;data&quot;: [
13605 # {
13606 # &quot;key&quot;: &quot;scope&quot;,
13607 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13608 # }
13609 {
13610 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13611 # returned. For example, for warnings where there are no results in a list
13612 # request for a particular zone, this key might be scope and
13613 # the key value might be the zone name. Other examples might be a key
13614 # indicating a deprecated resource and a suggested replacement, or a
13615 # warning about invalid network settings (for example, if an instance
13616 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13617 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13618 },
13619 ],
13620 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13621 },
13622 }</pre>
13623 </div>
13624
13625 <div class="method">
13626 <code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
13627 <pre>Retrieves a list of resources that refer to the VM instance specified in
13628 the request. For example, if the VM instance is part of a managed or
13629 unmanaged instance group, the referrers list includes the instance group.
13630 For more information, readViewing
13631 referrers to VM instances.
13632
13633 Args:
13634 project: string, Project ID for this request. (required)
13635 zone: string, The name of the zone for this request. (required)
13636 instance: string, Name of the target instance scoping this request, or &#x27;-&#x27; if the
13637 request should span over all instances in the container. (required)
13638 filter: string, A filter expression that filters resources listed in the response. Most
13639 Compute resources support two types of filter expressions:
13640 expressions that support regular expressions and expressions that follow
13641 API improvement proposal AIP-160.
13642 These two types of filter expressions cannot be mixed in one request.
13643
13644 If you want to use AIP-160, your expression must specify the field name, an
13645 operator, and the value that you want to use for filtering. The value
13646 must be a string, a number, or a boolean. The operator
13647 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
13648
13649 For example, if you are filtering Compute Engine instances, you can
13650 exclude instances named `example-instance` by specifying
13651 `name != example-instance`.
13652
13653 The `:*` comparison can be used to test whether a key has been defined.
13654 For example, to find all objects with `owner` label use:
13655 ```
13656 labels.owner:*
13657 ```
13658
13659 You can also filter nested fields. For example, you could specify
13660 `scheduling.automaticRestart = false` to include instances only
13661 if they are not scheduled for automatic restarts. You can use filtering
13662 on nested fields to filter based onresource labels.
13663
13664 To filter on multiple expressions, provide each separate expression within
13665 parentheses. For example:
13666 ```
13667 (scheduling.automaticRestart = true)
13668 (cpuPlatform = &quot;Intel Skylake&quot;)
13669 ```
13670 By default, each expression is an `AND` expression. However, you
13671 can include `AND` and `OR` expressions explicitly.
13672 For example:
13673 ```
13674 (cpuPlatform = &quot;Intel Skylake&quot;) OR
13675 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
13676 (scheduling.automaticRestart = true)
13677 ```
13678
13679 If you want to use a regular expression, use the `eq` (equal) or `ne`
13680 (not equal) operator against a single un-parenthesized expression with or
13681 without quotes or against multiple parenthesized expressions. Examples:
13682
13683 `fieldname eq unquoted literal`
13684 `fieldname eq &#x27;single quoted literal&#x27;`
13685 `fieldname eq &quot;double quoted literal&quot;`
13686 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
13687
13688 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
13689 The literal value must match the entire field.
13690
13691 For example, to filter for instances that do not end with name &quot;instance&quot;,
13692 you would use `name ne .*instance`.
13693
13694 You cannot combine constraints on multiple fields using regular
13695 expressions.
13696 maxResults: integer, The maximum number of results per page that should be returned.
13697 If the number of available results is larger than `maxResults`,
13698 Compute Engine returns a `nextPageToken` that can be used to get
13699 the next page of results in subsequent list requests. Acceptable values are
13700 `0` to `500`, inclusive. (Default: `500`)
13701 orderBy: string, Sorts list results by a certain order. By default, results
13702 are returned in alphanumerical order based on the resource name.
13703
13704 You can also sort results in descending order based on the creation
13705 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
13706 results based on the `creationTimestamp` field in
13707 reverse chronological order (newest result first). Use this to sort
13708 resources like operations so that the newest operation is returned first.
13709
13710 Currently, only sorting by `name` or
13711 `creationTimestamp desc` is supported.
13712 pageToken: string, Specifies a page token to use. Set `pageToken` to the
13713 `nextPageToken` returned by a previous list request to get
13714 the next page of results.
13715 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
13716 of failure. The default value is false.
13717
13718 For example, when partial success behavior is enabled, aggregatedList for a
13719 single zone scope either returns all resources in the zone or no resources,
13720 with an error code.
13721 x__xgafv: string, V1 error format.
13722 Allowed values
13723 1 - v1 error format
13724 2 - v2 error format
13725
13726 Returns:
13727 An object of the form:
13728
13729 { # Contains a list of instance referrers.
13730 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
13731 &quot;items&quot;: [ # A list of Reference resources.
13732 { # Represents a reference to a resource.
13733 &quot;kind&quot;: &quot;compute#reference&quot;, # Output only. [Output Only] Type of the resource. Always compute#reference
13734 # for references.
13735 &quot;referenceType&quot;: &quot;A String&quot;, # A description of the reference type with no implied semantics. Possible
13736 # values include:
13737 #
13738 #
13739 # 1. MEMBER_OF
13740 &quot;referrer&quot;: &quot;A String&quot;, # URL of the resource which refers to the target.
13741 &quot;target&quot;: &quot;A String&quot;, # URL of the resource to which this reference points.
13742 },
13743 ],
13744 &quot;kind&quot;: &quot;compute#instanceListReferrers&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#instanceListReferrers for lists of Instance referrers.
13745 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
13746 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
13747 # the query parameter pageToken in the next list request.
13748 # Subsequent list requests will have their own nextPageToken to
13749 # continue paging through the results.
13750 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
13751 &quot;warning&quot;: { # [Output Only] Informational warning message.
13752 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13753 # Engine returns NO_RESULTS_ON_PAGE if there
13754 # are no results in the response.
13755 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13756 # value format. For example:
13757 #
13758 # &quot;data&quot;: [
13759 # {
13760 # &quot;key&quot;: &quot;scope&quot;,
13761 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13762 # }
13763 {
13764 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13765 # returned. For example, for warnings where there are no results in a list
13766 # request for a particular zone, this key might be scope and
13767 # the key value might be the zone name. Other examples might be a key
13768 # indicating a deprecated resource and a suggested replacement, or a
13769 # warning about invalid network settings (for example, if an instance
13770 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13771 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13772 },
13773 ],
13774 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13775 },
13776 }</pre>
13777 </div>
13778
13779 <div class="method">
13780 <code class="details" id="listReferrers_next">listReferrers_next()</code>
13781 <pre>Retrieves the next page of results.
13782
13783 Args:
13784 previous_request: The request for the previous page. (required)
13785 previous_response: The response from the request for the previous page. (required)
13786
13787 Returns:
13788 A request object that you can call &#x27;execute()&#x27; on to request the next
13789 page. Returns None if there are no more items in the collection.
13790 </pre>
13791 </div>
13792
13793 <div class="method">
13794 <code class="details" id="listVmExtensionStates">listVmExtensionStates(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
13795 <pre>Lists all VM extensions states for a specific instance.
13796 This is a read-only API.
13797
13798 Args:
13799 project: string, Project ID for this request. (required)
13800 zone: string, Required. Name of the zone for this request. (required)
13801 instance: string, Name of the target instance scoping this request. (required)
13802 filter: string, A filter expression that filters resources listed in the response. Most
13803 Compute resources support two types of filter expressions:
13804 expressions that support regular expressions and expressions that follow
13805 API improvement proposal AIP-160.
13806 These two types of filter expressions cannot be mixed in one request.
13807
13808 If you want to use AIP-160, your expression must specify the field name, an
13809 operator, and the value that you want to use for filtering. The value
13810 must be a string, a number, or a boolean. The operator
13811 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
13812
13813 For example, if you are filtering Compute Engine instances, you can
13814 exclude instances named `example-instance` by specifying
13815 `name != example-instance`.
13816
13817 The `:*` comparison can be used to test whether a key has been defined.
13818 For example, to find all objects with `owner` label use:
13819 ```
13820 labels.owner:*
13821 ```
13822
13823 You can also filter nested fields. For example, you could specify
13824 `scheduling.automaticRestart = false` to include instances only
13825 if they are not scheduled for automatic restarts. You can use filtering
13826 on nested fields to filter based onresource labels.
13827
13828 To filter on multiple expressions, provide each separate expression within
13829 parentheses. For example:
13830 ```
13831 (scheduling.automaticRestart = true)
13832 (cpuPlatform = &quot;Intel Skylake&quot;)
13833 ```
13834 By default, each expression is an `AND` expression. However, you
13835 can include `AND` and `OR` expressions explicitly.
13836 For example:
13837 ```
13838 (cpuPlatform = &quot;Intel Skylake&quot;) OR
13839 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
13840 (scheduling.automaticRestart = true)
13841 ```
13842
13843 If you want to use a regular expression, use the `eq` (equal) or `ne`
13844 (not equal) operator against a single un-parenthesized expression with or
13845 without quotes or against multiple parenthesized expressions. Examples:
13846
13847 `fieldname eq unquoted literal`
13848 `fieldname eq &#x27;single quoted literal&#x27;`
13849 `fieldname eq &quot;double quoted literal&quot;`
13850 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
13851
13852 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
13853 The literal value must match the entire field.
13854
13855 For example, to filter for instances that do not end with name &quot;instance&quot;,
13856 you would use `name ne .*instance`.
13857
13858 You cannot combine constraints on multiple fields using regular
13859 expressions.
13860 maxResults: integer, The maximum number of results per page that should be returned.
13861 If the number of available results is larger than `maxResults`,
13862 Compute Engine returns a `nextPageToken` that can be used to get
13863 the next page of results in subsequent list requests. Acceptable values are
13864 `0` to `500`, inclusive. (Default: `500`)
13865 orderBy: string, Sorts list results by a certain order. By default, results
13866 are returned in alphanumerical order based on the resource name.
13867
13868 You can also sort results in descending order based on the creation
13869 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
13870 results based on the `creationTimestamp` field in
13871 reverse chronological order (newest result first). Use this to sort
13872 resources like operations so that the newest operation is returned first.
13873
13874 Currently, only sorting by `name` or
13875 `creationTimestamp desc` is supported.
13876 pageToken: string, Specifies a page token to use. Set `pageToken` to the
13877 `nextPageToken` returned by a previous list request to get
13878 the next page of results.
13879 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
13880 of failure. The default value is false.
13881
13882 For example, when partial success behavior is enabled, aggregatedList for a
13883 single zone scope either returns all resources in the zone or no resources,
13884 with an error code.
13885 x__xgafv: string, V1 error format.
13886 Allowed values
13887 1 - v1 error format
13888 2 - v2 error format
13889
13890 Returns:
13891 An object of the form:
13892
13893 {
13894 &quot;etag&quot;: &quot;A String&quot;, # Output only. Fingerprint of this resource. A hash of the contents stored
13895 # in this object. This field is used in optimistic locking. This field will
13896 # be ignored when inserting a VmExtensionPolicy. An up-to-date
13897 # fingerprint must be provided in order to update the VmExtensionPolicy.
13898 #
13899 # To see the latest value of the fingerprint, make a get() request to
13900 # retrieve a VmExtensionPolicy.
13901 &quot;id&quot;: &quot;A String&quot;, # Output only. Unique identifier for the resource; defined by the server.
13902 &quot;items&quot;: [ # Output only. A list of VM extension policy resources.
13903 { # State of an extension on an instance.
13904 &quot;enforcementMsg&quot;: &quot;A String&quot;, # The status message of the extension if the extension fails to enforce.
13905 &quot;enforcementState&quot;: &quot;A String&quot;, # The enforcement state of the extension.
13906 # If the extension is not enforced yet, then the health status will not be
13907 # specified.
13908 &quot;healthMsg&quot;: &quot;A String&quot;, # The health status message of the extension.
13909 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the extension.
13910 &quot;name&quot;: &quot;A String&quot;, # The name of the extension.
13911 &quot;policyId&quot;: &quot;A String&quot;, # The id of the policy that is enforced on the extension.
13912 &quot;version&quot;: &quot;A String&quot;, # The version of the extension.
13913 },
13914 ],
13915 &quot;kind&quot;: &quot;compute#vmExtensionStatesList&quot;, # Output only. Type of resource.
13916 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. This token allows you to get the next page of results for
13917 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
13918 # the query parameter pageToken in the next list request.
13919 # Subsequent list requests will have their own nextPageToken to
13920 # continue paging through the results.
13921 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server-defined URL for this resource.
13922 &quot;unreachables&quot;: [ # Output only. Unreachable resources.
13923 &quot;A String&quot;,
13924 ],
13925 &quot;warning&quot;: { # Output only. Informational warning message.
13926 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13927 # Engine returns NO_RESULTS_ON_PAGE if there
13928 # are no results in the response.
13929 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13930 # value format. For example:
13931 #
13932 # &quot;data&quot;: [
13933 # {
13934 # &quot;key&quot;: &quot;scope&quot;,
13935 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13936 # }
13937 {
13938 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13939 # returned. For example, for warnings where there are no results in a list
13940 # request for a particular zone, this key might be scope and
13941 # the key value might be the zone name. Other examples might be a key
13942 # indicating a deprecated resource and a suggested replacement, or a
13943 # warning about invalid network settings (for example, if an instance
13944 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13945 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13946 },
13947 ],
13948 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13949 },
13950 }</pre>
13951 </div>
13952
13953 <div class="method">
13954 <code class="details" id="listVmExtensionStates_next">listVmExtensionStates_next()</code>
13955 <pre>Retrieves the next page of results.
13956
13957 Args:
13958 previous_request: The request for the previous page. (required)
13959 previous_response: The response from the request for the previous page. (required)
13960
13961 Returns:
13962 A request object that you can call &#x27;execute()&#x27; on to request the next
13963 page. Returns None if there are no more items in the collection.
13964 </pre>
13965 </div>
13966
13967 <div class="method">
13968 <code class="details" id="list_next">list_next()</code>
13969 <pre>Retrieves the next page of results.
13970
13971 Args:
13972 previous_request: The request for the previous page. (required)
13973 previous_response: The response from the request for the previous page. (required)
13974
13975 Returns:
13976 A request object that you can call &#x27;execute()&#x27; on to request the next
13977 page. Returns None if there are no more items in the collection.
13978 </pre>
13979 </div>
13980
13981 <div class="method">
13982 <code class="details" id="patchPartnerMetadata">patchPartnerMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
13983 <pre>Patches partner metadata of the specified instance.
13984
13985 Args:
13986 project: string, Project ID for this request. (required)
13987 zone: string, The name of the zone for this request. (required)
13988 instance: string, Name of the instance scoping this request. (required)
13989 body: object, The request body.
13990 The object takes the form of:
13991
13992 { # Model definition of partner_metadata field.
13993 # To be used in dedicated Partner Metadata methods and to be inlined in
13994 # the Instance and InstanceTemplate resources.
13995 &quot;fingerprint&quot;: &quot;A String&quot;, # Instance-level hash to be used for optimistic
13996 # locking.
13997 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain to
13998 # entries map. Subdomain name must be compliant withRFC1035
13999 # definition. The total size of all keys and values must be less than 2MB.
14000 # Subdomain &#x27;metadata.compute.googleapis.com&#x27; is reserverd for instance&#x27;s
14001 # metadata.
14002 &quot;a_key&quot;: {
14003 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
14004 # It accepts any value including google.protobuf.Struct.
14005 &quot;a_key&quot;: &quot;&quot;,
14006 },
14007 },
14008 },
14009 }
14010
14011 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
14012 that if you must retry your request, the server will know to ignore the
14013 request if it has already been completed.
14014
14015 For example, consider a situation where you make an initial request and
14016 the request times out. If you make the request again with the same
14017 request ID, the server can check if original operation with the same
14018 request ID was received, and if so, will ignore the second request. This
14019 prevents clients from accidentally creating duplicate commitments.
14020
14021 The request ID must be
14022 a valid UUID with the exception that zero UUID is not supported
14023 (00000000-0000-0000-0000-000000000000).
14024 x__xgafv: string, V1 error format.
14025 Allowed values
14026 1 - v1 error format
14027 2 - v2 error format
14028
14029 Returns:
14030 An object of the form:
14031
14032 { # Represents an Operation resource.
14033 #
14034 # Google Compute Engine has three Operation resources:
14035 #
14036 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
14037 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
14038 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
14039 #
14040 # You can use an operation resource to manage asynchronous API requests.
14041 # For more information, readHandling
14042 # API responses.
14043 #
14044 # Operations can be global, regional or zonal.
14045 #
14046 # - For global operations, use the `globalOperations`
14047 # resource.
14048 # - For regional operations, use the
14049 # `regionOperations` resource.
14050 # - For zonal operations, use
14051 # the `zoneOperations` resource.
14052 #
14053 #
14054 #
14055 # For more information, read
14056 # Global, Regional, and Zonal Resources.
14057 #
14058 # Note that completed Operation resources have a limited
14059 # retention period.
14060 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14061 # Not present otherwise.
14062 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14063 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14064 # set when the operation is created.
14065 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14066 # text format.
14067 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14068 # this field will be populated.
14069 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14070 # operation.
14071 {
14072 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14073 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14074 # details. There is a set of defined message types to use for providing
14075 # details.The syntax depends on the error code. For example,
14076 # QuotaExceededInfo will have details when the error code is
14077 # QUOTA_EXCEEDED.
14078 {
14079 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14080 #
14081 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14082 # is not enabled:
14083 #
14084 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14085 # &quot;domain&quot;: &quot;googleapis.com&quot;
14086 # &quot;metadata&quot;: {
14087 # &quot;resource&quot;: &quot;projects/123&quot;,
14088 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14089 # }
14090 # }
14091 #
14092 # This response indicates that the pubsub.googleapis.com API is not enabled.
14093 #
14094 # Example of an error that is returned when attempting to create a Spanner
14095 # instance in a region that is out of stock:
14096 #
14097 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14098 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14099 # &quot;metadata&quot;: {
14100 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14101 # }
14102 # }
14103 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14104 # is typically the registered service name of the tool or product that
14105 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14106 # generated by some common infrastructure, the error domain must be a
14107 # globally unique value that identifies the infrastructure. For Google API
14108 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14109 &quot;metadatas&quot;: { # Additional structured details about this error.
14110 #
14111 # Keys must match a regular expression of `a-z+` but should
14112 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14113 # length. When identifying the current value of an exceeded limit, the units
14114 # should be contained in the key, not the value. For example, rather than
14115 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14116 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14117 # instances that can be created in a single (batch) request.
14118 &quot;a_key&quot;: &quot;A String&quot;,
14119 },
14120 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14121 # proximate cause of the error. Error reasons are unique within a particular
14122 # domain of errors. This should be at most 63 characters and match a
14123 # regular expression of `A-Z+[A-Z0-9]`, which represents
14124 # UPPER_SNAKE_CASE.
14125 },
14126 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14127 #
14128 # For example, if a quota check failed with an error indicating the calling
14129 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14130 # directly to the right place in the developer console to flip the bit.
14131 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14132 { # Describes a URL link.
14133 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14134 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14135 },
14136 ],
14137 },
14138 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14139 # which can be attached to an RPC error.
14140 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14141 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14142 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14143 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14144 },
14145 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14146 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14147 &quot;a_key&quot;: &quot;A String&quot;,
14148 },
14149 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14150 # type or metric.
14151 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14152 # or metric.
14153 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14154 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14155 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14156 },
14157 },
14158 ],
14159 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14160 # This property is optional.
14161 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14162 },
14163 ],
14164 },
14165 &quot;getVersionOperationMetadata&quot;: {
14166 &quot;inlineSbomInfo&quot;: {
14167 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14168 # appropriate identifiers.
14169 &quot;a_key&quot;: &quot;A String&quot;,
14170 },
14171 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14172 # identifiers.
14173 &quot;a_key&quot;: &quot;A String&quot;,
14174 },
14175 },
14176 },
14177 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14178 # message that was returned, such as `NOT FOUND`.
14179 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14180 # status code that was returned. For example, a `404` means the
14181 # resource was not found.
14182 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14183 # defined by the server.
14184 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14185 # This value is inRFC3339
14186 # text format.
14187 &quot;instancesBulkInsertOperationMetadata&quot;: {
14188 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14189 # Example key: zones/us-central1-a
14190 &quot;a_key&quot;: {
14191 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14192 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14193 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14194 # error.
14195 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14196 # if the flow is rolling forward or rolling back.
14197 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14198 },
14199 },
14200 },
14201 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14202 # Operation resources.
14203 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14204 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14205 # group of operations results from a `bulkInsert` API request.
14206 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14207 # `update`, or `delete`, and so on.
14208 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14209 # There is no requirement that this be linear or support any granularity of
14210 # operations. This should not be used to guess when the operation will be
14211 # complete. This number should monotonically increase as the operation
14212 # progresses.
14213 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14214 # applicable when performing regional operations.
14215 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14216 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
14217 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14218 # this field will contain information on all underlying zonal actions and
14219 # their state.
14220 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14221 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14222 # Example key: zones/us-central1-a
14223 &quot;a_key&quot;: {
14224 &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
14225 # populated.
14226 # different programming environments, including REST APIs and RPC APIs. It is
14227 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14228 # three pieces of data: error code, error message, and error details.
14229 #
14230 # You can find out more about this error model and how to work with it in the
14231 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14232 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14233 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14234 # message types for APIs to use.
14235 {
14236 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14237 },
14238 ],
14239 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14240 # user-facing error message should be localized and sent in the
14241 # google.rpc.Status.details field, or localized by the client.
14242 },
14243 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14244 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14245 },
14246 },
14247 },
14248 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14249 # This value is inRFC3339
14250 # text format.
14251 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14252 # following:
14253 # `PENDING`, `RUNNING`, or `DONE`.
14254 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14255 # operation.
14256 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14257 # of the target resource.
14258 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14259 # operations related to creating a snapshot, this points to the disk
14260 # that the snapshot was created from.
14261 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14262 # `[email protected]` or
14263 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14264 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14265 # operation, this field will be populated.
14266 {
14267 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14268 # Engine returns NO_RESULTS_ON_PAGE if there
14269 # are no results in the response.
14270 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14271 # value format. For example:
14272 #
14273 # &quot;data&quot;: [
14274 # {
14275 # &quot;key&quot;: &quot;scope&quot;,
14276 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
14277 # }
14278 {
14279 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
14280 # returned. For example, for warnings where there are no results in a list
14281 # request for a particular zone, this key might be scope and
14282 # the key value might be the zone name. Other examples might be a key
14283 # indicating a deprecated resource and a suggested replacement, or a
14284 # warning about invalid network settings (for example, if an instance
14285 # attempts to perform IP forwarding but is not enabled for IP forwarding).
14286 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
14287 },
14288 ],
14289 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
14290 },
14291 ],
14292 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
14293 # applicable when performing per-zone operations.
14294 }</pre>
14295 </div>
14296
14297 <div class="method">
14298 <code class="details" id="performMaintenance">performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)</code>
14299 <pre>Perform a manual maintenance on the instance.
14300
14301 Args:
14302 project: string, Project ID for this request. (required)
14303 zone: string, The name of the zone for this request. (required)
14304 instance: string, Name of the instance scoping this request. (required)
14305 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
14306 that if you must retry your request, the server will know to ignore the
14307 request if it has already been completed.
14308
14309 For example, consider a situation where you make an initial request and
14310 the request times out. If you make the request again with the same
14311 request ID, the server can check if original operation with the same
14312 request ID was received, and if so, will ignore the second request. This
14313 prevents clients from accidentally creating duplicate commitments.
14314
14315 The request ID must be
14316 a valid UUID with the exception that zero UUID is not supported
14317 (00000000-0000-0000-0000-000000000000).
14318 x__xgafv: string, V1 error format.
14319 Allowed values
14320 1 - v1 error format
14321 2 - v2 error format
14322
14323 Returns:
14324 An object of the form:
14325
14326 { # Represents an Operation resource.
14327 #
14328 # Google Compute Engine has three Operation resources:
14329 #
14330 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
14331 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
14332 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
14333 #
14334 # You can use an operation resource to manage asynchronous API requests.
14335 # For more information, readHandling
14336 # API responses.
14337 #
14338 # Operations can be global, regional or zonal.
14339 #
14340 # - For global operations, use the `globalOperations`
14341 # resource.
14342 # - For regional operations, use the
14343 # `regionOperations` resource.
14344 # - For zonal operations, use
14345 # the `zoneOperations` resource.
14346 #
14347 #
14348 #
14349 # For more information, read
14350 # Global, Regional, and Zonal Resources.
14351 #
14352 # Note that completed Operation resources have a limited
14353 # retention period.
14354 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14355 # Not present otherwise.
14356 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14357 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14358 # set when the operation is created.
14359 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14360 # text format.
14361 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14362 # this field will be populated.
14363 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14364 # operation.
14365 {
14366 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14367 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14368 # details. There is a set of defined message types to use for providing
14369 # details.The syntax depends on the error code. For example,
14370 # QuotaExceededInfo will have details when the error code is
14371 # QUOTA_EXCEEDED.
14372 {
14373 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14374 #
14375 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14376 # is not enabled:
14377 #
14378 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14379 # &quot;domain&quot;: &quot;googleapis.com&quot;
14380 # &quot;metadata&quot;: {
14381 # &quot;resource&quot;: &quot;projects/123&quot;,
14382 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14383 # }
14384 # }
14385 #
14386 # This response indicates that the pubsub.googleapis.com API is not enabled.
14387 #
14388 # Example of an error that is returned when attempting to create a Spanner
14389 # instance in a region that is out of stock:
14390 #
14391 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14392 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14393 # &quot;metadata&quot;: {
14394 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14395 # }
14396 # }
14397 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14398 # is typically the registered service name of the tool or product that
14399 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14400 # generated by some common infrastructure, the error domain must be a
14401 # globally unique value that identifies the infrastructure. For Google API
14402 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14403 &quot;metadatas&quot;: { # Additional structured details about this error.
14404 #
14405 # Keys must match a regular expression of `a-z+` but should
14406 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14407 # length. When identifying the current value of an exceeded limit, the units
14408 # should be contained in the key, not the value. For example, rather than
14409 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14410 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14411 # instances that can be created in a single (batch) request.
14412 &quot;a_key&quot;: &quot;A String&quot;,
14413 },
14414 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14415 # proximate cause of the error. Error reasons are unique within a particular
14416 # domain of errors. This should be at most 63 characters and match a
14417 # regular expression of `A-Z+[A-Z0-9]`, which represents
14418 # UPPER_SNAKE_CASE.
14419 },
14420 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14421 #
14422 # For example, if a quota check failed with an error indicating the calling
14423 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14424 # directly to the right place in the developer console to flip the bit.
14425 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14426 { # Describes a URL link.
14427 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14428 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14429 },
14430 ],
14431 },
14432 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14433 # which can be attached to an RPC error.
14434 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14435 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14436 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14437 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14438 },
14439 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14440 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14441 &quot;a_key&quot;: &quot;A String&quot;,
14442 },
14443 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14444 # type or metric.
14445 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14446 # or metric.
14447 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14448 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14449 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14450 },
14451 },
14452 ],
14453 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14454 # This property is optional.
14455 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14456 },
14457 ],
14458 },
14459 &quot;getVersionOperationMetadata&quot;: {
14460 &quot;inlineSbomInfo&quot;: {
14461 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14462 # appropriate identifiers.
14463 &quot;a_key&quot;: &quot;A String&quot;,
14464 },
14465 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14466 # identifiers.
14467 &quot;a_key&quot;: &quot;A String&quot;,
14468 },
14469 },
14470 },
14471 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14472 # message that was returned, such as `NOT FOUND`.
14473 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14474 # status code that was returned. For example, a `404` means the
14475 # resource was not found.
14476 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14477 # defined by the server.
14478 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14479 # This value is inRFC3339
14480 # text format.
14481 &quot;instancesBulkInsertOperationMetadata&quot;: {
14482 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14483 # Example key: zones/us-central1-a
14484 &quot;a_key&quot;: {
14485 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14486 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14487 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14488 # error.
14489 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14490 # if the flow is rolling forward or rolling back.
14491 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14492 },
14493 },
14494 },
14495 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14496 # Operation resources.
14497 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14498 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14499 # group of operations results from a `bulkInsert` API request.
14500 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14501 # `update`, or `delete`, and so on.
14502 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14503 # There is no requirement that this be linear or support any granularity of
14504 # operations. This should not be used to guess when the operation will be
14505 # complete. This number should monotonically increase as the operation
14506 # progresses.
14507 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14508 # applicable when performing regional operations.
14509 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14510 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
14511 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14512 # this field will contain information on all underlying zonal actions and
14513 # their state.
14514 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14515 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14516 # Example key: zones/us-central1-a
14517 &quot;a_key&quot;: {
14518 &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
14519 # populated.
14520 # different programming environments, including REST APIs and RPC APIs. It is
14521 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14522 # three pieces of data: error code, error message, and error details.
14523 #
14524 # You can find out more about this error model and how to work with it in the
14525 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14526 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14527 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14528 # message types for APIs to use.
14529 {
14530 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14531 },
14532 ],
14533 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14534 # user-facing error message should be localized and sent in the
14535 # google.rpc.Status.details field, or localized by the client.
14536 },
14537 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14538 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14539 },
14540 },
14541 },
14542 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14543 # This value is inRFC3339
14544 # text format.
14545 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14546 # following:
14547 # `PENDING`, `RUNNING`, or `DONE`.
14548 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14549 # operation.
14550 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14551 # of the target resource.
14552 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14553 # operations related to creating a snapshot, this points to the disk
14554 # that the snapshot was created from.
14555 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14556 # `[email protected]` or
14557 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14558 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14559 # operation, this field will be populated.
14560 {
14561 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14562 # Engine returns NO_RESULTS_ON_PAGE if there
14563 # are no results in the response.
14564 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14565 # value format. For example:
14566 #
14567 # &quot;data&quot;: [
14568 # {
14569 # &quot;key&quot;: &quot;scope&quot;,
14570 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
14571 # }
14572 {
14573 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
14574 # returned. For example, for warnings where there are no results in a list
14575 # request for a particular zone, this key might be scope and
14576 # the key value might be the zone name. Other examples might be a key
14577 # indicating a deprecated resource and a suggested replacement, or a
14578 # warning about invalid network settings (for example, if an instance
14579 # attempts to perform IP forwarding but is not enabled for IP forwarding).
14580 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
14581 },
14582 ],
14583 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
14584 },
14585 ],
14586 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
14587 # applicable when performing per-zone operations.
14588 }</pre>
14589 </div>
14590
14591 <div class="method">
14592 <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
14593 <pre>Removes resource policies from an instance.
14594
14595 Args:
14596 project: string, Project ID for this request. (required)
14597 zone: string, The name of the zone for this request. (required)
14598 instance: string, The instance name for this request. (required)
14599 body: object, The request body.
14600 The object takes the form of:
14601
14602 {
14603 &quot;resourcePolicies&quot;: [ # Resource policies to be removed from this instance.
14604 &quot;A String&quot;,
14605 ],
14606 }
14607
14608 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
14609 that if you must retry your request, the server will know to ignore the
14610 request if it has already been completed.
14611
14612 For example, consider a situation where you make an initial request and
14613 the request times out. If you make the request again with the same
14614 request ID, the server can check if original operation with the same
14615 request ID was received, and if so, will ignore the second request. This
14616 prevents clients from accidentally creating duplicate commitments.
14617
14618 The request ID must be
14619 a valid UUID with the exception that zero UUID is not supported
14620 (00000000-0000-0000-0000-000000000000).
14621 x__xgafv: string, V1 error format.
14622 Allowed values
14623 1 - v1 error format
14624 2 - v2 error format
14625
14626 Returns:
14627 An object of the form:
14628
14629 { # Represents an Operation resource.
14630 #
14631 # Google Compute Engine has three Operation resources:
14632 #
14633 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
14634 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
14635 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
14636 #
14637 # You can use an operation resource to manage asynchronous API requests.
14638 # For more information, readHandling
14639 # API responses.
14640 #
14641 # Operations can be global, regional or zonal.
14642 #
14643 # - For global operations, use the `globalOperations`
14644 # resource.
14645 # - For regional operations, use the
14646 # `regionOperations` resource.
14647 # - For zonal operations, use
14648 # the `zoneOperations` resource.
14649 #
14650 #
14651 #
14652 # For more information, read
14653 # Global, Regional, and Zonal Resources.
14654 #
14655 # Note that completed Operation resources have a limited
14656 # retention period.
14657 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14658 # Not present otherwise.
14659 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14660 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14661 # set when the operation is created.
14662 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14663 # text format.
14664 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14665 # this field will be populated.
14666 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14667 # operation.
14668 {
14669 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14670 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14671 # details. There is a set of defined message types to use for providing
14672 # details.The syntax depends on the error code. For example,
14673 # QuotaExceededInfo will have details when the error code is
14674 # QUOTA_EXCEEDED.
14675 {
14676 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14677 #
14678 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14679 # is not enabled:
14680 #
14681 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14682 # &quot;domain&quot;: &quot;googleapis.com&quot;
14683 # &quot;metadata&quot;: {
14684 # &quot;resource&quot;: &quot;projects/123&quot;,
14685 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14686 # }
14687 # }
14688 #
14689 # This response indicates that the pubsub.googleapis.com API is not enabled.
14690 #
14691 # Example of an error that is returned when attempting to create a Spanner
14692 # instance in a region that is out of stock:
14693 #
14694 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14695 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14696 # &quot;metadata&quot;: {
14697 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14698 # }
14699 # }
14700 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14701 # is typically the registered service name of the tool or product that
14702 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14703 # generated by some common infrastructure, the error domain must be a
14704 # globally unique value that identifies the infrastructure. For Google API
14705 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14706 &quot;metadatas&quot;: { # Additional structured details about this error.
14707 #
14708 # Keys must match a regular expression of `a-z+` but should
14709 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14710 # length. When identifying the current value of an exceeded limit, the units
14711 # should be contained in the key, not the value. For example, rather than
14712 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14713 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14714 # instances that can be created in a single (batch) request.
14715 &quot;a_key&quot;: &quot;A String&quot;,
14716 },
14717 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14718 # proximate cause of the error. Error reasons are unique within a particular
14719 # domain of errors. This should be at most 63 characters and match a
14720 # regular expression of `A-Z+[A-Z0-9]`, which represents
14721 # UPPER_SNAKE_CASE.
14722 },
14723 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14724 #
14725 # For example, if a quota check failed with an error indicating the calling
14726 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14727 # directly to the right place in the developer console to flip the bit.
14728 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14729 { # Describes a URL link.
14730 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14731 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14732 },
14733 ],
14734 },
14735 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14736 # which can be attached to an RPC error.
14737 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14738 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14739 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14740 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14741 },
14742 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14743 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14744 &quot;a_key&quot;: &quot;A String&quot;,
14745 },
14746 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14747 # type or metric.
14748 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14749 # or metric.
14750 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14751 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14752 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14753 },
14754 },
14755 ],
14756 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14757 # This property is optional.
14758 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14759 },
14760 ],
14761 },
14762 &quot;getVersionOperationMetadata&quot;: {
14763 &quot;inlineSbomInfo&quot;: {
14764 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14765 # appropriate identifiers.
14766 &quot;a_key&quot;: &quot;A String&quot;,
14767 },
14768 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14769 # identifiers.
14770 &quot;a_key&quot;: &quot;A String&quot;,
14771 },
14772 },
14773 },
14774 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14775 # message that was returned, such as `NOT FOUND`.
14776 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14777 # status code that was returned. For example, a `404` means the
14778 # resource was not found.
14779 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14780 # defined by the server.
14781 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14782 # This value is inRFC3339
14783 # text format.
14784 &quot;instancesBulkInsertOperationMetadata&quot;: {
14785 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14786 # Example key: zones/us-central1-a
14787 &quot;a_key&quot;: {
14788 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14789 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14790 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14791 # error.
14792 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14793 # if the flow is rolling forward or rolling back.
14794 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14795 },
14796 },
14797 },
14798 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14799 # Operation resources.
14800 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14801 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14802 # group of operations results from a `bulkInsert` API request.
14803 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14804 # `update`, or `delete`, and so on.
14805 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14806 # There is no requirement that this be linear or support any granularity of
14807 # operations. This should not be used to guess when the operation will be
14808 # complete. This number should monotonically increase as the operation
14809 # progresses.
14810 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14811 # applicable when performing regional operations.
14812 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14813 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
14814 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14815 # this field will contain information on all underlying zonal actions and
14816 # their state.
14817 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14818 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14819 # Example key: zones/us-central1-a
14820 &quot;a_key&quot;: {
14821 &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
14822 # populated.
14823 # different programming environments, including REST APIs and RPC APIs. It is
14824 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14825 # three pieces of data: error code, error message, and error details.
14826 #
14827 # You can find out more about this error model and how to work with it in the
14828 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14829 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14830 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14831 # message types for APIs to use.
14832 {
14833 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14834 },
14835 ],
14836 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14837 # user-facing error message should be localized and sent in the
14838 # google.rpc.Status.details field, or localized by the client.
14839 },
14840 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14841 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14842 },
14843 },
14844 },
14845 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14846 # This value is inRFC3339
14847 # text format.
14848 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14849 # following:
14850 # `PENDING`, `RUNNING`, or `DONE`.
14851 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14852 # operation.
14853 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14854 # of the target resource.
14855 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14856 # operations related to creating a snapshot, this points to the disk
14857 # that the snapshot was created from.
14858 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14859 # `[email protected]` or
14860 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14861 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14862 # operation, this field will be populated.
14863 {
14864 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14865 # Engine returns NO_RESULTS_ON_PAGE if there
14866 # are no results in the response.
14867 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14868 # value format. For example:
14869 #
14870 # &quot;data&quot;: [
14871 # {
14872 # &quot;key&quot;: &quot;scope&quot;,
14873 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
14874 # }
14875 {
14876 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
14877 # returned. For example, for warnings where there are no results in a list
14878 # request for a particular zone, this key might be scope and
14879 # the key value might be the zone name. Other examples might be a key
14880 # indicating a deprecated resource and a suggested replacement, or a
14881 # warning about invalid network settings (for example, if an instance
14882 # attempts to perform IP forwarding but is not enabled for IP forwarding).
14883 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
14884 },
14885 ],
14886 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
14887 },
14888 ],
14889 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
14890 # applicable when performing per-zone operations.
14891 }</pre>
14892 </div>
14893
14894 <div class="method">
14895 <code class="details" id="reportHostAsFaulty">reportHostAsFaulty(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
14896 <pre>Mark the host as faulty and try to restart the instance on a new host.
14897
14898 Args:
14899 project: string, Project ID for this request. (required)
14900 zone: string, The name of the zone for this request. (required)
14901 instance: string, Name of the instance scoping this request. (required)
14902 body: object, The request body.
14903 The object takes the form of:
14904
14905 {
14906 &quot;actionHint&quot;: &quot;A String&quot;, # The action hint to report the host as faulty.
14907 &quot;disruptionSchedule&quot;: &quot;A String&quot;, # The disruption schedule for the VM. Required field, only allows IMMEDIATE.
14908 &quot;faultReasons&quot;: [
14909 {
14910 &quot;behavior&quot;: &quot;A String&quot;,
14911 &quot;description&quot;: &quot;A String&quot;,
14912 },
14913 ],
14914 }
14915
14916 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
14917 that if you must retry your request, the server will know to ignore the
14918 request if it has already been completed.
14919
14920 For example, consider a situation where you make an initial request and
14921 the request times out. If you make the request again with the same
14922 request ID, the server can check if original operation with the same
14923 request ID was received, and if so, will ignore the second request. This
14924 prevents clients from accidentally creating duplicate commitments.
14925
14926 The request ID must be
14927 a valid UUID with the exception that zero UUID is not supported
14928 (00000000-0000-0000-0000-000000000000).
14929 x__xgafv: string, V1 error format.
14930 Allowed values
14931 1 - v1 error format
14932 2 - v2 error format
14933
14934 Returns:
14935 An object of the form:
14936
14937 { # Represents an Operation resource.
14938 #
14939 # Google Compute Engine has three Operation resources:
14940 #
14941 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
14942 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
14943 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
14944 #
14945 # You can use an operation resource to manage asynchronous API requests.
14946 # For more information, readHandling
14947 # API responses.
14948 #
14949 # Operations can be global, regional or zonal.
14950 #
14951 # - For global operations, use the `globalOperations`
14952 # resource.
14953 # - For regional operations, use the
14954 # `regionOperations` resource.
14955 # - For zonal operations, use
14956 # the `zoneOperations` resource.
14957 #
14958 #
14959 #
14960 # For more information, read
14961 # Global, Regional, and Zonal Resources.
14962 #
14963 # Note that completed Operation resources have a limited
14964 # retention period.
14965 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14966 # Not present otherwise.
14967 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14968 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14969 # set when the operation is created.
14970 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14971 # text format.
14972 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14973 # this field will be populated.
14974 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14975 # operation.
14976 {
14977 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14978 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14979 # details. There is a set of defined message types to use for providing
14980 # details.The syntax depends on the error code. For example,
14981 # QuotaExceededInfo will have details when the error code is
14982 # QUOTA_EXCEEDED.
14983 {
14984 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14985 #
14986 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14987 # is not enabled:
14988 #
14989 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14990 # &quot;domain&quot;: &quot;googleapis.com&quot;
14991 # &quot;metadata&quot;: {
14992 # &quot;resource&quot;: &quot;projects/123&quot;,
14993 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14994 # }
14995 # }
14996 #
14997 # This response indicates that the pubsub.googleapis.com API is not enabled.
14998 #
14999 # Example of an error that is returned when attempting to create a Spanner
15000 # instance in a region that is out of stock:
15001 #
15002 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
15003 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
15004 # &quot;metadata&quot;: {
15005 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
15006 # }
15007 # }
15008 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
15009 # is typically the registered service name of the tool or product that
15010 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
15011 # generated by some common infrastructure, the error domain must be a
15012 # globally unique value that identifies the infrastructure. For Google API
15013 # infrastructure, the error domain is &quot;googleapis.com&quot;.
15014 &quot;metadatas&quot;: { # Additional structured details about this error.
15015 #
15016 # Keys must match a regular expression of `a-z+` but should
15017 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
15018 # length. When identifying the current value of an exceeded limit, the units
15019 # should be contained in the key, not the value. For example, rather than
15020 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
15021 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
15022 # instances that can be created in a single (batch) request.
15023 &quot;a_key&quot;: &quot;A String&quot;,
15024 },
15025 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
15026 # proximate cause of the error. Error reasons are unique within a particular
15027 # domain of errors. This should be at most 63 characters and match a
15028 # regular expression of `A-Z+[A-Z0-9]`, which represents
15029 # UPPER_SNAKE_CASE.
15030 },
15031 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
15032 #
15033 # For example, if a quota check failed with an error indicating the calling
15034 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
15035 # directly to the right place in the developer console to flip the bit.
15036 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
15037 { # Describes a URL link.
15038 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
15039 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
15040 },
15041 ],
15042 },
15043 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
15044 # which can be attached to an RPC error.
15045 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
15046 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
15047 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
15048 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
15049 },
15050 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
15051 &quot;dimensions&quot;: { # The map holding related quota dimensions.
15052 &quot;a_key&quot;: &quot;A String&quot;,
15053 },
15054 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
15055 # type or metric.
15056 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
15057 # or metric.
15058 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
15059 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
15060 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
15061 },
15062 },
15063 ],
15064 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
15065 # This property is optional.
15066 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
15067 },
15068 ],
15069 },
15070 &quot;getVersionOperationMetadata&quot;: {
15071 &quot;inlineSbomInfo&quot;: {
15072 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
15073 # appropriate identifiers.
15074 &quot;a_key&quot;: &quot;A String&quot;,
15075 },
15076 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
15077 # identifiers.
15078 &quot;a_key&quot;: &quot;A String&quot;,
15079 },
15080 },
15081 },
15082 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
15083 # message that was returned, such as `NOT FOUND`.
15084 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
15085 # status code that was returned. For example, a `404` means the
15086 # resource was not found.
15087 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
15088 # defined by the server.
15089 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
15090 # This value is inRFC3339
15091 # text format.
15092 &quot;instancesBulkInsertOperationMetadata&quot;: {
15093 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
15094 # Example key: zones/us-central1-a
15095 &quot;a_key&quot;: {
15096 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
15097 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
15098 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
15099 # error.
15100 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
15101 # if the flow is rolling forward or rolling back.
15102 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
15103 },
15104 },
15105 },
15106 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
15107 # Operation resources.
15108 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
15109 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
15110 # group of operations results from a `bulkInsert` API request.
15111 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
15112 # `update`, or `delete`, and so on.
15113 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
15114 # There is no requirement that this be linear or support any granularity of
15115 # operations. This should not be used to guess when the operation will be
15116 # complete. This number should monotonically increase as the operation
15117 # progresses.
15118 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
15119 # applicable when performing regional operations.
15120 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
15121 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
15122 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
15123 # this field will contain information on all underlying zonal actions and
15124 # their state.
15125 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
15126 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
15127 # Example key: zones/us-central1-a
15128 &quot;a_key&quot;: {
15129 &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
15130 # populated.
15131 # different programming environments, including REST APIs and RPC APIs. It is
15132 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
15133 # three pieces of data: error code, error message, and error details.
15134 #
15135 # You can find out more about this error model and how to work with it in the
15136 # [API Design Guide](https://cloud.google.com/apis/design/errors).
15137 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
15138 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
15139 # message types for APIs to use.
15140 {
15141 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
15142 },
15143 ],
15144 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
15145 # user-facing error message should be localized and sent in the
15146 # google.rpc.Status.details field, or localized by the client.
15147 },
15148 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
15149 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
15150 },
15151 },
15152 },
15153 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
15154 # This value is inRFC3339
15155 # text format.
15156 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
15157 # following:
15158 # `PENDING`, `RUNNING`, or `DONE`.
15159 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
15160 # operation.
15161 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
15162 # of the target resource.
15163 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
15164 # operations related to creating a snapshot, this points to the disk
15165 # that the snapshot was created from.
15166 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
15167 # `[email protected]` or
15168 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
15169 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
15170 # operation, this field will be populated.
15171 {
15172 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
15173 # Engine returns NO_RESULTS_ON_PAGE if there
15174 # are no results in the response.
15175 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
15176 # value format. For example:
15177 #
15178 # &quot;data&quot;: [
15179 # {
15180 # &quot;key&quot;: &quot;scope&quot;,
15181 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
15182 # }
15183 {
15184 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
15185 # returned. For example, for warnings where there are no results in a list
15186 # request for a particular zone, this key might be scope and
15187 # the key value might be the zone name. Other examples might be a key
15188 # indicating a deprecated resource and a suggested replacement, or a
15189 # warning about invalid network settings (for example, if an instance
15190 # attempts to perform IP forwarding but is not enabled for IP forwarding).
15191 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
15192 },
15193 ],
15194 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
15195 },
15196 ],
15197 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
15198 # applicable when performing per-zone operations.
15199 }</pre>
15200 </div>
15201
15202 <div class="method">
15203 <code class="details" id="reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</code>
15204 <pre>Performs a reset on the instance. This is a hard reset. The VM
15205 does not do a graceful shutdown. For more information, seeResetting
15206 an instance.
15207
15208 Args:
15209 project: string, Project ID for this request. (required)
15210 zone: string, The name of the zone for this request. (required)
15211 instance: string, Name of the instance scoping this request. (required)
15212 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
15213 that if you must retry your request, the server will know to ignore the
15214 request if it has already been completed.
15215
15216 For example, consider a situation where you make an initial request and
15217 the request times out. If you make the request again with the same
15218 request ID, the server can check if original operation with the same
15219 request ID was received, and if so, will ignore the second request. This
15220 prevents clients from accidentally creating duplicate commitments.
15221
15222 The request ID must be
15223 a valid UUID with the exception that zero UUID is not supported
15224 (00000000-0000-0000-0000-000000000000).
15225 x__xgafv: string, V1 error format.
15226 Allowed values
15227 1 - v1 error format
15228 2 - v2 error format
15229
15230 Returns:
15231 An object of the form:
15232
15233 { # Represents an Operation resource.
15234 #
15235 # Google Compute Engine has three Operation resources:
15236 #
15237 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
15238 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
15239 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
15240 #
15241 # You can use an operation resource to manage asynchronous API requests.
15242 # For more information, readHandling
15243 # API responses.
15244 #
15245 # Operations can be global, regional or zonal.
15246 #
15247 # - For global operations, use the `globalOperations`
15248 # resource.
15249 # - For regional operations, use the
15250 # `regionOperations` resource.
15251 # - For zonal operations, use
15252 # the `zoneOperations` resource.
15253 #
15254 #
15255 #
15256 # For more information, read
15257 # Global, Regional, and Zonal Resources.
15258 #
15259 # Note that completed Operation resources have a limited
15260 # retention period.
15261 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
15262 # Not present otherwise.
15263 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
15264 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
15265 # set when the operation is created.
15266 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
15267 # text format.
15268 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
15269 # this field will be populated.
15270 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
15271 # operation.
15272 {
15273 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
15274 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
15275 # details. There is a set of defined message types to use for providing
15276 # details.The syntax depends on the error code. For example,
15277 # QuotaExceededInfo will have details when the error code is
15278 # QUOTA_EXCEEDED.
15279 {
15280 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
15281 #
15282 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
15283 # is not enabled:
15284 #
15285 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
15286 # &quot;domain&quot;: &quot;googleapis.com&quot;
15287 # &quot;metadata&quot;: {
15288 # &quot;resource&quot;: &quot;projects/123&quot;,
15289 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
15290 # }
15291 # }
15292 #
15293 # This response indicates that the pubsub.googleapis.com API is not enabled.
15294 #
15295 # Example of an error that is returned when attempting to create a Spanner
15296 # instance in a region that is out of stock:
15297 #
15298 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
15299 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
15300 # &quot;metadata&quot;: {
15301 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
15302 # }
15303 # }
15304 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
15305 # is typically the registered service name of the tool or product that
15306 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
15307 # generated by some common infrastructure, the error domain must be a
15308 # globally unique value that identifies the infrastructure. For Google API
15309 # infrastructure, the error domain is &quot;googleapis.com&quot;.
15310 &quot;metadatas&quot;: { # Additional structured details about this error.
15311 #
15312 # Keys must match a regular expression of `a-z+` but should
15313 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
15314 # length. When identifying the current value of an exceeded limit, the units
15315 # should be contained in the key, not the value. For example, rather than
15316 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
15317 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
15318 # instances that can be created in a single (batch) request.
15319 &quot;a_key&quot;: &quot;A String&quot;,
15320 },
15321 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
15322 # proximate cause of the error. Error reasons are unique within a particular
15323 # domain of errors. This should be at most 63 characters and match a
15324 # regular expression of `A-Z+[A-Z0-9]`, which represents
15325 # UPPER_SNAKE_CASE.
15326 },
15327 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
15328 #
15329 # For example, if a quota check failed with an error indicating the calling
15330 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
15331 # directly to the right place in the developer console to flip the bit.
15332 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
15333 { # Describes a URL link.
15334 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
15335 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
15336 },
15337 ],
15338 },
15339 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
15340 # which can be attached to an RPC error.
15341 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
15342 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
15343 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
15344 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
15345 },
15346 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
15347 &quot;dimensions&quot;: { # The map holding related quota dimensions.
15348 &quot;a_key&quot;: &quot;A String&quot;,
15349 },
15350 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
15351 # type or metric.
15352 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
15353 # or metric.
15354 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
15355 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
15356 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
15357 },
15358 },
15359 ],
15360 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
15361 # This property is optional.
15362 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
15363 },
15364 ],
15365 },
15366 &quot;getVersionOperationMetadata&quot;: {
15367 &quot;inlineSbomInfo&quot;: {
15368 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
15369 # appropriate identifiers.
15370 &quot;a_key&quot;: &quot;A String&quot;,
15371 },
15372 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
15373 # identifiers.
15374 &quot;a_key&quot;: &quot;A String&quot;,
15375 },
15376 },
15377 },
15378 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
15379 # message that was returned, such as `NOT FOUND`.
15380 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
15381 # status code that was returned. For example, a `404` means the
15382 # resource was not found.
15383 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
15384 # defined by the server.
15385 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
15386 # This value is inRFC3339
15387 # text format.
15388 &quot;instancesBulkInsertOperationMetadata&quot;: {
15389 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
15390 # Example key: zones/us-central1-a
15391 &quot;a_key&quot;: {
15392 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
15393 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
15394 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
15395 # error.
15396 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
15397 # if the flow is rolling forward or rolling back.
15398 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
15399 },
15400 },
15401 },
15402 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
15403 # Operation resources.
15404 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
15405 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
15406 # group of operations results from a `bulkInsert` API request.
15407 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
15408 # `update`, or `delete`, and so on.
15409 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
15410 # There is no requirement that this be linear or support any granularity of
15411 # operations. This should not be used to guess when the operation will be
15412 # complete. This number should monotonically increase as the operation
15413 # progresses.
15414 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
15415 # applicable when performing regional operations.
15416 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
15417 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
15418 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
15419 # this field will contain information on all underlying zonal actions and
15420 # their state.
15421 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
15422 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
15423 # Example key: zones/us-central1-a
15424 &quot;a_key&quot;: {
15425 &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
15426 # populated.
15427 # different programming environments, including REST APIs and RPC APIs. It is
15428 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
15429 # three pieces of data: error code, error message, and error details.
15430 #
15431 # You can find out more about this error model and how to work with it in the
15432 # [API Design Guide](https://cloud.google.com/apis/design/errors).
15433 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
15434 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
15435 # message types for APIs to use.
15436 {
15437 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
15438 },
15439 ],
15440 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
15441 # user-facing error message should be localized and sent in the
15442 # google.rpc.Status.details field, or localized by the client.
15443 },
15444 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
15445 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
15446 },
15447 },
15448 },
15449 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
15450 # This value is inRFC3339
15451 # text format.
15452 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
15453 # following:
15454 # `PENDING`, `RUNNING`, or `DONE`.
15455 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
15456 # operation.
15457 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
15458 # of the target resource.
15459 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
15460 # operations related to creating a snapshot, this points to the disk
15461 # that the snapshot was created from.
15462 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
15463 # `[email protected]` or
15464 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
15465 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
15466 # operation, this field will be populated.
15467 {
15468 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
15469 # Engine returns NO_RESULTS_ON_PAGE if there
15470 # are no results in the response.
15471 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
15472 # value format. For example:
15473 #
15474 # &quot;data&quot;: [
15475 # {
15476 # &quot;key&quot;: &quot;scope&quot;,
15477 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
15478 # }
15479 {
15480 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
15481 # returned. For example, for warnings where there are no results in a list
15482 # request for a particular zone, this key might be scope and
15483 # the key value might be the zone name. Other examples might be a key
15484 # indicating a deprecated resource and a suggested replacement, or a
15485 # warning about invalid network settings (for example, if an instance
15486 # attempts to perform IP forwarding but is not enabled for IP forwarding).
15487 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
15488 },
15489 ],
15490 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
15491 },
15492 ],
15493 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
15494 # applicable when performing per-zone operations.
15495 }</pre>
15496 </div>
15497
15498 <div class="method">
15499 <code class="details" id="resume">resume(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
15500 <pre>Resumes an instance that was suspended using theinstances().suspend
15501 method.
15502
15503 Args:
15504 project: string, Project ID for this request. (required)
15505 zone: string, The name of the zone for this request. (required)
15506 instance: string, Name of the instance resource to resume. (required)
15507 body: object, The request body.
15508 The object takes the form of:
15509
15510 {
15511 &quot;disks&quot;: [ # Array of disks associated with this instance that are protected with acustomer-supplied
15512 # encryption key.
15513 #
15514 # In order to resume the instance, the disk url and its corresponding key
15515 # must be provided.
15516 #
15517 # If the disk is not protected with a customer-supplied encryption key it
15518 # should not be specified.
15519 {
15520 &quot;diskEncryptionKey&quot;: { # Decrypts data associated with the disk with acustomer-supplied
15521 # encryption key.
15522 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
15523 # For example:
15524 #
15525 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
15526 # key_region/cryptoKeys/key
15527 #
15528 # The fully-qualifed key name may be returned for resource GET requests. For
15529 # example:
15530 #
15531 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
15532 # key_region/cryptoKeys/key
15533 # /cryptoKeyVersions/1
15534 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
15535 # key. If absent, the Compute Engine default service account is used.
15536 # For example:
15537 #
15538 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
15539 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
15540 # encryption key, encoded in RFC
15541 # 4648 base64 to either encrypt or decrypt this resource. You can
15542 # provide either the rawKey or thersaEncryptedKey.
15543 # For example:
15544 #
15545 # &quot;rawKey&quot;:
15546 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
15547 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
15548 # customer-supplied encryption key to either encrypt or decrypt this
15549 # resource. You can provide either the rawKey or thersaEncryptedKey.
15550 # For example:
15551 #
15552 # &quot;rsaEncryptedKey&quot;:
15553 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
15554 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
15555 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
15556 #
15557 # The key must meet the following requirements before you can provide it to
15558 # Compute Engine:
15559 #
15560 # 1. The key is wrapped using a RSA public key certificate provided by
15561 # Google.
15562 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
15563 # encoding.
15564 #
15565 # Gets the RSA public key certificate provided by Google at:
15566 #
15567 #
15568 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
15569 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
15570 # 4648 base64 encoded SHA-256 hash of the customer-supplied
15571 # encryption key that protects this resource.
15572 },
15573 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
15574 # resource. This field is only applicable for persistent disks.
15575 # For example:
15576 #
15577 # &quot;source&quot;: &quot;/compute/v1/projects/project_id/zones/zone/disks/
15578 # disk_name
15579 },
15580 ],
15581 &quot;instanceEncryptionKey&quot;: { # Decrypts data associated with an instance that is protected with acustomer-supplied
15582 # encryption key.
15583 #
15584 # If the instance you are starting is protected with a customer-supplied
15585 # encryption key, the correct key must be provided otherwise the
15586 # instance resume will not succeed.
15587 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
15588 # For example:
15589 #
15590 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
15591 # key_region/cryptoKeys/key
15592 #
15593 # The fully-qualifed key name may be returned for resource GET requests. For
15594 # example:
15595 #
15596 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
15597 # key_region/cryptoKeys/key
15598 # /cryptoKeyVersions/1
15599 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
15600 # key. If absent, the Compute Engine default service account is used.
15601 # For example:
15602 #
15603 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
15604 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
15605 # encryption key, encoded in RFC
15606 # 4648 base64 to either encrypt or decrypt this resource. You can
15607 # provide either the rawKey or thersaEncryptedKey.
15608 # For example:
15609 #
15610 # &quot;rawKey&quot;:
15611 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
15612 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
15613 # customer-supplied encryption key to either encrypt or decrypt this
15614 # resource. You can provide either the rawKey or thersaEncryptedKey.
15615 # For example:
15616 #
15617 # &quot;rsaEncryptedKey&quot;:
15618 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
15619 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
15620 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
15621 #
15622 # The key must meet the following requirements before you can provide it to
15623 # Compute Engine:
15624 #
15625 # 1. The key is wrapped using a RSA public key certificate provided by
15626 # Google.
15627 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
15628 # encoding.
15629 #
15630 # Gets the RSA public key certificate provided by Google at:
15631 #
15632 #
15633 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
15634 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
15635 # 4648 base64 encoded SHA-256 hash of the customer-supplied
15636 # encryption key that protects this resource.
15637 },
15638 }
15639
15640 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
15641 that if you must retry your request, the server will know to ignore the
15642 request if it has already been completed.
15643
15644 For example, consider a situation where you make an initial request and
15645 the request times out. If you make the request again with the same
15646 request ID, the server can check if original operation with the same
15647 request ID was received, and if so, will ignore the second request. This
15648 prevents clients from accidentally creating duplicate commitments.
15649
15650 The request ID must be
15651 a valid UUID with the exception that zero UUID is not supported
15652 (00000000-0000-0000-0000-000000000000).
15653 x__xgafv: string, V1 error format.
15654 Allowed values
15655 1 - v1 error format
15656 2 - v2 error format
15657
15658 Returns:
15659 An object of the form:
15660
15661 { # Represents an Operation resource.
15662 #
15663 # Google Compute Engine has three Operation resources:
15664 #
15665 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
15666 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
15667 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
15668 #
15669 # You can use an operation resource to manage asynchronous API requests.
15670 # For more information, readHandling
15671 # API responses.
15672 #
15673 # Operations can be global, regional or zonal.
15674 #
15675 # - For global operations, use the `globalOperations`
15676 # resource.
15677 # - For regional operations, use the
15678 # `regionOperations` resource.
15679 # - For zonal operations, use
15680 # the `zoneOperations` resource.
15681 #
15682 #
15683 #
15684 # For more information, read
15685 # Global, Regional, and Zonal Resources.
15686 #
15687 # Note that completed Operation resources have a limited
15688 # retention period.
15689 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
15690 # Not present otherwise.
15691 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
15692 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
15693 # set when the operation is created.
15694 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
15695 # text format.
15696 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
15697 # this field will be populated.
15698 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
15699 # operation.
15700 {
15701 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
15702 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
15703 # details. There is a set of defined message types to use for providing
15704 # details.The syntax depends on the error code. For example,
15705 # QuotaExceededInfo will have details when the error code is
15706 # QUOTA_EXCEEDED.
15707 {
15708 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
15709 #
15710 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
15711 # is not enabled:
15712 #
15713 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
15714 # &quot;domain&quot;: &quot;googleapis.com&quot;
15715 # &quot;metadata&quot;: {
15716 # &quot;resource&quot;: &quot;projects/123&quot;,
15717 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
15718 # }
15719 # }
15720 #
15721 # This response indicates that the pubsub.googleapis.com API is not enabled.
15722 #
15723 # Example of an error that is returned when attempting to create a Spanner
15724 # instance in a region that is out of stock:
15725 #
15726 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
15727 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
15728 # &quot;metadata&quot;: {
15729 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
15730 # }
15731 # }
15732 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
15733 # is typically the registered service name of the tool or product that
15734 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
15735 # generated by some common infrastructure, the error domain must be a
15736 # globally unique value that identifies the infrastructure. For Google API
15737 # infrastructure, the error domain is &quot;googleapis.com&quot;.
15738 &quot;metadatas&quot;: { # Additional structured details about this error.
15739 #
15740 # Keys must match a regular expression of `a-z+` but should
15741 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
15742 # length. When identifying the current value of an exceeded limit, the units
15743 # should be contained in the key, not the value. For example, rather than
15744 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
15745 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
15746 # instances that can be created in a single (batch) request.
15747 &quot;a_key&quot;: &quot;A String&quot;,
15748 },
15749 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
15750 # proximate cause of the error. Error reasons are unique within a particular
15751 # domain of errors. This should be at most 63 characters and match a
15752 # regular expression of `A-Z+[A-Z0-9]`, which represents
15753 # UPPER_SNAKE_CASE.
15754 },
15755 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
15756 #
15757 # For example, if a quota check failed with an error indicating the calling
15758 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
15759 # directly to the right place in the developer console to flip the bit.
15760 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
15761 { # Describes a URL link.
15762 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
15763 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
15764 },
15765 ],
15766 },
15767 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
15768 # which can be attached to an RPC error.
15769 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
15770 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
15771 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
15772 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
15773 },
15774 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
15775 &quot;dimensions&quot;: { # The map holding related quota dimensions.
15776 &quot;a_key&quot;: &quot;A String&quot;,
15777 },
15778 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
15779 # type or metric.
15780 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
15781 # or metric.
15782 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
15783 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
15784 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
15785 },
15786 },
15787 ],
15788 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
15789 # This property is optional.
15790 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
15791 },
15792 ],
15793 },
15794 &quot;getVersionOperationMetadata&quot;: {
15795 &quot;inlineSbomInfo&quot;: {
15796 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
15797 # appropriate identifiers.
15798 &quot;a_key&quot;: &quot;A String&quot;,
15799 },
15800 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
15801 # identifiers.
15802 &quot;a_key&quot;: &quot;A String&quot;,
15803 },
15804 },
15805 },
15806 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
15807 # message that was returned, such as `NOT FOUND`.
15808 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
15809 # status code that was returned. For example, a `404` means the
15810 # resource was not found.
15811 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
15812 # defined by the server.
15813 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
15814 # This value is inRFC3339
15815 # text format.
15816 &quot;instancesBulkInsertOperationMetadata&quot;: {
15817 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
15818 # Example key: zones/us-central1-a
15819 &quot;a_key&quot;: {
15820 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
15821 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
15822 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
15823 # error.
15824 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
15825 # if the flow is rolling forward or rolling back.
15826 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
15827 },
15828 },
15829 },
15830 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
15831 # Operation resources.
15832 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
15833 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
15834 # group of operations results from a `bulkInsert` API request.
15835 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
15836 # `update`, or `delete`, and so on.
15837 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
15838 # There is no requirement that this be linear or support any granularity of
15839 # operations. This should not be used to guess when the operation will be
15840 # complete. This number should monotonically increase as the operation
15841 # progresses.
15842 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
15843 # applicable when performing regional operations.
15844 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
15845 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
15846 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
15847 # this field will contain information on all underlying zonal actions and
15848 # their state.
15849 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
15850 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
15851 # Example key: zones/us-central1-a
15852 &quot;a_key&quot;: {
15853 &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
15854 # populated.
15855 # different programming environments, including REST APIs and RPC APIs. It is
15856 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
15857 # three pieces of data: error code, error message, and error details.
15858 #
15859 # You can find out more about this error model and how to work with it in the
15860 # [API Design Guide](https://cloud.google.com/apis/design/errors).
15861 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
15862 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
15863 # message types for APIs to use.
15864 {
15865 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
15866 },
15867 ],
15868 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
15869 # user-facing error message should be localized and sent in the
15870 # google.rpc.Status.details field, or localized by the client.
15871 },
15872 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
15873 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
15874 },
15875 },
15876 },
15877 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
15878 # This value is inRFC3339
15879 # text format.
15880 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
15881 # following:
15882 # `PENDING`, `RUNNING`, or `DONE`.
15883 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
15884 # operation.
15885 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
15886 # of the target resource.
15887 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
15888 # operations related to creating a snapshot, this points to the disk
15889 # that the snapshot was created from.
15890 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
15891 # `[email protected]` or
15892 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
15893 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
15894 # operation, this field will be populated.
15895 {
15896 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
15897 # Engine returns NO_RESULTS_ON_PAGE if there
15898 # are no results in the response.
15899 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
15900 # value format. For example:
15901 #
15902 # &quot;data&quot;: [
15903 # {
15904 # &quot;key&quot;: &quot;scope&quot;,
15905 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
15906 # }
15907 {
15908 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
15909 # returned. For example, for warnings where there are no results in a list
15910 # request for a particular zone, this key might be scope and
15911 # the key value might be the zone name. Other examples might be a key
15912 # indicating a deprecated resource and a suggested replacement, or a
15913 # warning about invalid network settings (for example, if an instance
15914 # attempts to perform IP forwarding but is not enabled for IP forwarding).
15915 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
15916 },
15917 ],
15918 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
15919 },
15920 ],
15921 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
15922 # applicable when performing per-zone operations.
15923 }</pre>
15924 </div>
15925
15926 <div class="method">
15927 <code class="details" id="sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</code>
15928 <pre>Sends diagnostic interrupt to the instance.
15929
15930 Args:
15931 project: string, Project ID for this request. (required)
15932 zone: string, The name of the zone for this request. (required)
15933 instance: string, Name of the instance scoping this request. (required)
15934 x__xgafv: string, V1 error format.
15935 Allowed values
15936 1 - v1 error format
15937 2 - v2 error format
15938 </pre>
15939 </div>
15940
15941 <div class="method">
15942 <code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</code>
15943 <pre>Sets deletion protection on the instance.
15944
15945 Args:
15946 project: string, Project ID for this request. (required)
15947 zone: string, The name of the zone for this request. (required)
15948 resource: string, Name or id of the resource for this request. (required)
15949 deletionProtection: boolean, Whether the resource should be protected against deletion.
15950 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
15951 that if you must retry your request, the server will know to ignore the
15952 request if it has already been completed.
15953
15954 For example, consider a situation where you make an initial request and
15955 the request times out. If you make the request again with the same
15956 request ID, the server can check if original operation with the same
15957 request ID was received, and if so, will ignore the second request. This
15958 prevents clients from accidentally creating duplicate commitments.
15959
15960 The request ID must be
15961 a valid UUID with the exception that zero UUID is not supported
15962 (00000000-0000-0000-0000-000000000000).
15963 x__xgafv: string, V1 error format.
15964 Allowed values
15965 1 - v1 error format
15966 2 - v2 error format
15967
15968 Returns:
15969 An object of the form:
15970
15971 { # Represents an Operation resource.
15972 #
15973 # Google Compute Engine has three Operation resources:
15974 #
15975 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
15976 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
15977 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
15978 #
15979 # You can use an operation resource to manage asynchronous API requests.
15980 # For more information, readHandling
15981 # API responses.
15982 #
15983 # Operations can be global, regional or zonal.
15984 #
15985 # - For global operations, use the `globalOperations`
15986 # resource.
15987 # - For regional operations, use the
15988 # `regionOperations` resource.
15989 # - For zonal operations, use
15990 # the `zoneOperations` resource.
15991 #
15992 #
15993 #
15994 # For more information, read
15995 # Global, Regional, and Zonal Resources.
15996 #
15997 # Note that completed Operation resources have a limited
15998 # retention period.
15999 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
16000 # Not present otherwise.
16001 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
16002 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
16003 # set when the operation is created.
16004 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
16005 # text format.
16006 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
16007 # this field will be populated.
16008 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
16009 # operation.
16010 {
16011 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
16012 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
16013 # details. There is a set of defined message types to use for providing
16014 # details.The syntax depends on the error code. For example,
16015 # QuotaExceededInfo will have details when the error code is
16016 # QUOTA_EXCEEDED.
16017 {
16018 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
16019 #
16020 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
16021 # is not enabled:
16022 #
16023 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
16024 # &quot;domain&quot;: &quot;googleapis.com&quot;
16025 # &quot;metadata&quot;: {
16026 # &quot;resource&quot;: &quot;projects/123&quot;,
16027 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
16028 # }
16029 # }
16030 #
16031 # This response indicates that the pubsub.googleapis.com API is not enabled.
16032 #
16033 # Example of an error that is returned when attempting to create a Spanner
16034 # instance in a region that is out of stock:
16035 #
16036 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
16037 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
16038 # &quot;metadata&quot;: {
16039 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
16040 # }
16041 # }
16042 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
16043 # is typically the registered service name of the tool or product that
16044 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
16045 # generated by some common infrastructure, the error domain must be a
16046 # globally unique value that identifies the infrastructure. For Google API
16047 # infrastructure, the error domain is &quot;googleapis.com&quot;.
16048 &quot;metadatas&quot;: { # Additional structured details about this error.
16049 #
16050 # Keys must match a regular expression of `a-z+` but should
16051 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
16052 # length. When identifying the current value of an exceeded limit, the units
16053 # should be contained in the key, not the value. For example, rather than
16054 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
16055 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
16056 # instances that can be created in a single (batch) request.
16057 &quot;a_key&quot;: &quot;A String&quot;,
16058 },
16059 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
16060 # proximate cause of the error. Error reasons are unique within a particular
16061 # domain of errors. This should be at most 63 characters and match a
16062 # regular expression of `A-Z+[A-Z0-9]`, which represents
16063 # UPPER_SNAKE_CASE.
16064 },
16065 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
16066 #
16067 # For example, if a quota check failed with an error indicating the calling
16068 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
16069 # directly to the right place in the developer console to flip the bit.
16070 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
16071 { # Describes a URL link.
16072 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
16073 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
16074 },
16075 ],
16076 },
16077 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
16078 # which can be attached to an RPC error.
16079 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
16080 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
16081 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
16082 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
16083 },
16084 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
16085 &quot;dimensions&quot;: { # The map holding related quota dimensions.
16086 &quot;a_key&quot;: &quot;A String&quot;,
16087 },
16088 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
16089 # type or metric.
16090 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
16091 # or metric.
16092 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
16093 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
16094 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
16095 },
16096 },
16097 ],
16098 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
16099 # This property is optional.
16100 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
16101 },
16102 ],
16103 },
16104 &quot;getVersionOperationMetadata&quot;: {
16105 &quot;inlineSbomInfo&quot;: {
16106 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
16107 # appropriate identifiers.
16108 &quot;a_key&quot;: &quot;A String&quot;,
16109 },
16110 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
16111 # identifiers.
16112 &quot;a_key&quot;: &quot;A String&quot;,
16113 },
16114 },
16115 },
16116 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
16117 # message that was returned, such as `NOT FOUND`.
16118 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
16119 # status code that was returned. For example, a `404` means the
16120 # resource was not found.
16121 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
16122 # defined by the server.
16123 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
16124 # This value is inRFC3339
16125 # text format.
16126 &quot;instancesBulkInsertOperationMetadata&quot;: {
16127 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
16128 # Example key: zones/us-central1-a
16129 &quot;a_key&quot;: {
16130 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
16131 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
16132 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
16133 # error.
16134 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
16135 # if the flow is rolling forward or rolling back.
16136 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
16137 },
16138 },
16139 },
16140 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
16141 # Operation resources.
16142 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
16143 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
16144 # group of operations results from a `bulkInsert` API request.
16145 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
16146 # `update`, or `delete`, and so on.
16147 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
16148 # There is no requirement that this be linear or support any granularity of
16149 # operations. This should not be used to guess when the operation will be
16150 # complete. This number should monotonically increase as the operation
16151 # progresses.
16152 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
16153 # applicable when performing regional operations.
16154 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
16155 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
16156 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
16157 # this field will contain information on all underlying zonal actions and
16158 # their state.
16159 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
16160 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
16161 # Example key: zones/us-central1-a
16162 &quot;a_key&quot;: {
16163 &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
16164 # populated.
16165 # different programming environments, including REST APIs and RPC APIs. It is
16166 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
16167 # three pieces of data: error code, error message, and error details.
16168 #
16169 # You can find out more about this error model and how to work with it in the
16170 # [API Design Guide](https://cloud.google.com/apis/design/errors).
16171 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
16172 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
16173 # message types for APIs to use.
16174 {
16175 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
16176 },
16177 ],
16178 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
16179 # user-facing error message should be localized and sent in the
16180 # google.rpc.Status.details field, or localized by the client.
16181 },
16182 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
16183 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
16184 },
16185 },
16186 },
16187 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
16188 # This value is inRFC3339
16189 # text format.
16190 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
16191 # following:
16192 # `PENDING`, `RUNNING`, or `DONE`.
16193 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
16194 # operation.
16195 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
16196 # of the target resource.
16197 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
16198 # operations related to creating a snapshot, this points to the disk
16199 # that the snapshot was created from.
16200 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
16201 # `[email protected]` or
16202 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
16203 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
16204 # operation, this field will be populated.
16205 {
16206 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
16207 # Engine returns NO_RESULTS_ON_PAGE if there
16208 # are no results in the response.
16209 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
16210 # value format. For example:
16211 #
16212 # &quot;data&quot;: [
16213 # {
16214 # &quot;key&quot;: &quot;scope&quot;,
16215 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
16216 # }
16217 {
16218 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
16219 # returned. For example, for warnings where there are no results in a list
16220 # request for a particular zone, this key might be scope and
16221 # the key value might be the zone name. Other examples might be a key
16222 # indicating a deprecated resource and a suggested replacement, or a
16223 # warning about invalid network settings (for example, if an instance
16224 # attempts to perform IP forwarding but is not enabled for IP forwarding).
16225 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
16226 },
16227 ],
16228 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
16229 },
16230 ],
16231 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
16232 # applicable when performing per-zone operations.
16233 }</pre>
16234 </div>
16235
16236 <div class="method">
16237 <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</code>
16238 <pre>Sets the auto-delete flag for a disk attached to an instance.
16239
16240 Args:
16241 project: string, Project ID for this request. (required)
16242 zone: string, The name of the zone for this request. (required)
16243 instance: string, The instance name for this request. (required)
16244 autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
16245 deviceName: string, The device name of the disk to modify. Make a get() request
16246 on the instance to view currently attached disks and device names. (required)
16247 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
16248 that if you must retry your request, the server will know to ignore the
16249 request if it has already been completed.
16250
16251 For example, consider a situation where you make an initial request and
16252 the request times out. If you make the request again with the same
16253 request ID, the server can check if original operation with the same
16254 request ID was received, and if so, will ignore the second request. This
16255 prevents clients from accidentally creating duplicate commitments.
16256
16257 The request ID must be
16258 a valid UUID with the exception that zero UUID is not supported
16259 (00000000-0000-0000-0000-000000000000).
16260 x__xgafv: string, V1 error format.
16261 Allowed values
16262 1 - v1 error format
16263 2 - v2 error format
16264
16265 Returns:
16266 An object of the form:
16267
16268 { # Represents an Operation resource.
16269 #
16270 # Google Compute Engine has three Operation resources:
16271 #
16272 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
16273 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
16274 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
16275 #
16276 # You can use an operation resource to manage asynchronous API requests.
16277 # For more information, readHandling
16278 # API responses.
16279 #
16280 # Operations can be global, regional or zonal.
16281 #
16282 # - For global operations, use the `globalOperations`
16283 # resource.
16284 # - For regional operations, use the
16285 # `regionOperations` resource.
16286 # - For zonal operations, use
16287 # the `zoneOperations` resource.
16288 #
16289 #
16290 #
16291 # For more information, read
16292 # Global, Regional, and Zonal Resources.
16293 #
16294 # Note that completed Operation resources have a limited
16295 # retention period.
16296 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
16297 # Not present otherwise.
16298 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
16299 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
16300 # set when the operation is created.
16301 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
16302 # text format.
16303 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
16304 # this field will be populated.
16305 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
16306 # operation.
16307 {
16308 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
16309 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
16310 # details. There is a set of defined message types to use for providing
16311 # details.The syntax depends on the error code. For example,
16312 # QuotaExceededInfo will have details when the error code is
16313 # QUOTA_EXCEEDED.
16314 {
16315 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
16316 #
16317 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
16318 # is not enabled:
16319 #
16320 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
16321 # &quot;domain&quot;: &quot;googleapis.com&quot;
16322 # &quot;metadata&quot;: {
16323 # &quot;resource&quot;: &quot;projects/123&quot;,
16324 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
16325 # }
16326 # }
16327 #
16328 # This response indicates that the pubsub.googleapis.com API is not enabled.
16329 #
16330 # Example of an error that is returned when attempting to create a Spanner
16331 # instance in a region that is out of stock:
16332 #
16333 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
16334 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
16335 # &quot;metadata&quot;: {
16336 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
16337 # }
16338 # }
16339 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
16340 # is typically the registered service name of the tool or product that
16341 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
16342 # generated by some common infrastructure, the error domain must be a
16343 # globally unique value that identifies the infrastructure. For Google API
16344 # infrastructure, the error domain is &quot;googleapis.com&quot;.
16345 &quot;metadatas&quot;: { # Additional structured details about this error.
16346 #
16347 # Keys must match a regular expression of `a-z+` but should
16348 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
16349 # length. When identifying the current value of an exceeded limit, the units
16350 # should be contained in the key, not the value. For example, rather than
16351 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
16352 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
16353 # instances that can be created in a single (batch) request.
16354 &quot;a_key&quot;: &quot;A String&quot;,
16355 },
16356 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
16357 # proximate cause of the error. Error reasons are unique within a particular
16358 # domain of errors. This should be at most 63 characters and match a
16359 # regular expression of `A-Z+[A-Z0-9]`, which represents
16360 # UPPER_SNAKE_CASE.
16361 },
16362 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
16363 #
16364 # For example, if a quota check failed with an error indicating the calling
16365 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
16366 # directly to the right place in the developer console to flip the bit.
16367 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
16368 { # Describes a URL link.
16369 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
16370 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
16371 },
16372 ],
16373 },
16374 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
16375 # which can be attached to an RPC error.
16376 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
16377 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
16378 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
16379 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
16380 },
16381 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
16382 &quot;dimensions&quot;: { # The map holding related quota dimensions.
16383 &quot;a_key&quot;: &quot;A String&quot;,
16384 },
16385 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
16386 # type or metric.
16387 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
16388 # or metric.
16389 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
16390 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
16391 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
16392 },
16393 },
16394 ],
16395 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
16396 # This property is optional.
16397 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
16398 },
16399 ],
16400 },
16401 &quot;getVersionOperationMetadata&quot;: {
16402 &quot;inlineSbomInfo&quot;: {
16403 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
16404 # appropriate identifiers.
16405 &quot;a_key&quot;: &quot;A String&quot;,
16406 },
16407 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
16408 # identifiers.
16409 &quot;a_key&quot;: &quot;A String&quot;,
16410 },
16411 },
16412 },
16413 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
16414 # message that was returned, such as `NOT FOUND`.
16415 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
16416 # status code that was returned. For example, a `404` means the
16417 # resource was not found.
16418 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
16419 # defined by the server.
16420 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
16421 # This value is inRFC3339
16422 # text format.
16423 &quot;instancesBulkInsertOperationMetadata&quot;: {
16424 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
16425 # Example key: zones/us-central1-a
16426 &quot;a_key&quot;: {
16427 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
16428 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
16429 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
16430 # error.
16431 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
16432 # if the flow is rolling forward or rolling back.
16433 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
16434 },
16435 },
16436 },
16437 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
16438 # Operation resources.
16439 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
16440 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
16441 # group of operations results from a `bulkInsert` API request.
16442 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
16443 # `update`, or `delete`, and so on.
16444 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
16445 # There is no requirement that this be linear or support any granularity of
16446 # operations. This should not be used to guess when the operation will be
16447 # complete. This number should monotonically increase as the operation
16448 # progresses.
16449 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
16450 # applicable when performing regional operations.
16451 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
16452 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
16453 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
16454 # this field will contain information on all underlying zonal actions and
16455 # their state.
16456 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
16457 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
16458 # Example key: zones/us-central1-a
16459 &quot;a_key&quot;: {
16460 &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
16461 # populated.
16462 # different programming environments, including REST APIs and RPC APIs. It is
16463 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
16464 # three pieces of data: error code, error message, and error details.
16465 #
16466 # You can find out more about this error model and how to work with it in the
16467 # [API Design Guide](https://cloud.google.com/apis/design/errors).
16468 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
16469 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
16470 # message types for APIs to use.
16471 {
16472 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
16473 },
16474 ],
16475 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
16476 # user-facing error message should be localized and sent in the
16477 # google.rpc.Status.details field, or localized by the client.
16478 },
16479 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
16480 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
16481 },
16482 },
16483 },
16484 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
16485 # This value is inRFC3339
16486 # text format.
16487 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
16488 # following:
16489 # `PENDING`, `RUNNING`, or `DONE`.
16490 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
16491 # operation.
16492 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
16493 # of the target resource.
16494 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
16495 # operations related to creating a snapshot, this points to the disk
16496 # that the snapshot was created from.
16497 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
16498 # `[email protected]` or
16499 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
16500 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
16501 # operation, this field will be populated.
16502 {
16503 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
16504 # Engine returns NO_RESULTS_ON_PAGE if there
16505 # are no results in the response.
16506 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
16507 # value format. For example:
16508 #
16509 # &quot;data&quot;: [
16510 # {
16511 # &quot;key&quot;: &quot;scope&quot;,
16512 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
16513 # }
16514 {
16515 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
16516 # returned. For example, for warnings where there are no results in a list
16517 # request for a particular zone, this key might be scope and
16518 # the key value might be the zone name. Other examples might be a key
16519 # indicating a deprecated resource and a suggested replacement, or a
16520 # warning about invalid network settings (for example, if an instance
16521 # attempts to perform IP forwarding but is not enabled for IP forwarding).
16522 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
16523 },
16524 ],
16525 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
16526 },
16527 ],
16528 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
16529 # applicable when performing per-zone operations.
16530 }</pre>
16531 </div>
16532
16533 <div class="method">
16534 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>
16535 <pre>Sets the access control policy on the specified resource.
16536 Replaces any existing policy.
16537
16538 Args:
16539 project: string, Project ID for this request. (required)
16540 zone: string, The name of the zone for this request. (required)
16541 resource: string, Name or id of the resource for this request. (required)
16542 body: object, The request body.
16543 The object takes the form of:
16544
16545 {
16546 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
16547 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
16548 { # Associates `members`, or principals, with a `role`.
16549 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
16550 #
16551 # If the condition evaluates to `true`, then this binding applies to the
16552 # current request.
16553 #
16554 # If the condition evaluates to `false`, then this binding does not apply to
16555 # the current request. However, a different role binding might grant the same
16556 # role to one or more of the principals in this binding.
16557 #
16558 # To learn which resources support conditions in their IAM policies, see the
16559 # [IAM
16560 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
16561 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
16562 # are documented at https://github.com/google/cel-spec.
16563 #
16564 # Example (Comparison):
16565 #
16566 # title: &quot;Summary size limit&quot;
16567 # description: &quot;Determines if a summary is less than 100 chars&quot;
16568 # expression: &quot;document.summary.size() &lt; 100&quot;
16569 #
16570 # Example (Equality):
16571 #
16572 # title: &quot;Requestor is owner&quot;
16573 # description: &quot;Determines if requestor is the document owner&quot;
16574 # expression: &quot;document.owner == request.auth.claims.email&quot;
16575 #
16576 # Example (Logic):
16577 #
16578 # title: &quot;Public documents&quot;
16579 # description: &quot;Determine whether the document should be publicly visible&quot;
16580 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
16581 #
16582 # Example (Data Manipulation):
16583 #
16584 # title: &quot;Notification string&quot;
16585 # description: &quot;Create a notification string with a timestamp.&quot;
16586 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
16587 #
16588 # The exact variables and functions that may be referenced within an expression
16589 # are determined by the service that evaluates it. See the service
16590 # documentation for additional information.
16591 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
16592 # describes the expression, e.g. when hovered over it in a UI.
16593 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
16594 # syntax.
16595 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
16596 # reporting, e.g. a file name and a position in the file.
16597 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
16598 # its purpose. This can be used e.g. in UIs which allow to enter the
16599 # expression.
16600 },
16601 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
16602 # `members` can have the following values:
16603 #
16604 # * `allUsers`: A special identifier that represents anyone who is
16605 # on the internet; with or without a Google account.
16606 #
16607 # * `allAuthenticatedUsers`: A special identifier that represents anyone
16608 # who is authenticated with a Google account or a service account.
16609 # Does not include identities that come from external identity providers
16610 # (IdPs) through identity federation.
16611 #
16612 # * `user:{emailid}`: An email address that represents a specific Google
16613 # account. For example, `[email protected]` .
16614 #
16615 #
16616 # * `serviceAccount:{emailid}`: An email address that represents a Google
16617 # service account. For example,
16618 # `[email protected]`.
16619 #
16620 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
16621 # identifier for a
16622 # [Kubernetes service
16623 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
16624 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
16625 #
16626 # * `group:{emailid}`: An email address that represents a Google group.
16627 # For example, `[email protected]`.
16628 #
16629 #
16630 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
16631 # users of that domain. For example, `google.com` or `example.com`.
16632 #
16633 #
16634 #
16635 #
16636 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
16637 # A single identity in a workforce identity pool.
16638 #
16639 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
16640 # All workforce identities in a group.
16641 #
16642 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
16643 # All workforce identities with a specific attribute value.
16644 #
16645 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
16646 # All identities in a workforce identity pool.
16647 #
16648 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
16649 # A single identity in a workload identity pool.
16650 #
16651 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
16652 # A workload identity pool group.
16653 #
16654 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
16655 # All identities in a workload identity pool with a certain attribute.
16656 #
16657 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
16658 # All identities in a workload identity pool.
16659 #
16660 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
16661 # identifier) representing a user that has been recently deleted. For
16662 # example, `[email protected]?uid=123456789012345678901`. If the user is
16663 # recovered, this value reverts to `user:{emailid}` and the recovered user
16664 # retains the role in the binding.
16665 #
16666 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
16667 # unique identifier) representing a service account that has been recently
16668 # deleted. For example,
16669 # `[email protected]?uid=123456789012345678901`.
16670 # If the service account is undeleted, this value reverts to
16671 # `serviceAccount:{emailid}` and the undeleted service account retains the
16672 # role in the binding.
16673 #
16674 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
16675 # identifier) representing a Google group that has been recently
16676 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
16677 # the group is recovered, this value reverts to `group:{emailid}` and the
16678 # recovered group retains the role in the binding.
16679 #
16680 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
16681 # Deleted single identity in a workforce identity pool. For example,
16682 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
16683 &quot;A String&quot;,
16684 ],
16685 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
16686 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
16687 #
16688 # For an overview of the IAM roles and permissions, see the
16689 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
16690 # a list of the available pre-defined roles, see
16691 # [here](https://cloud.google.com/iam/docs/understanding-roles).
16692 },
16693 ],
16694 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
16695 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
16696 &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
16697 # the policy is limited to a few 10s of KB. An empty policy is in general a
16698 # valid policy but certain services (like Projects) might reject them.
16699 # controls for Google Cloud resources.
16700 #
16701 #
16702 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
16703 # `members`, or principals, to a single `role`. Principals can be user
16704 # accounts, service accounts, Google groups, and domains (such as G Suite). A
16705 # `role` is a named list of permissions; each `role` can be an IAM predefined
16706 # role or a user-created custom role.
16707 #
16708 # For some types of Google Cloud resources, a `binding` can also specify a
16709 # `condition`, which is a logical expression that allows access to a resource
16710 # only if the expression evaluates to `true`. A condition can add constraints
16711 # based on attributes of the request, the resource, or both. To learn which
16712 # resources support conditions in their IAM policies, see the
16713 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
16714 #
16715 # **JSON example:**
16716 #
16717 # ```
16718 # {
16719 # &quot;bindings&quot;: [
16720 # {
16721 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
16722 # &quot;members&quot;: [
16723 # &quot;user:[email protected]&quot;,
16724 # &quot;group:[email protected]&quot;,
16725 # &quot;domain:google.com&quot;,
16726 # &quot;serviceAccount:[email protected]&quot;
16727 # ]
16728 # },
16729 # {
16730 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
16731 # &quot;members&quot;: [
16732 # &quot;user:[email protected]&quot;
16733 # ],
16734 # &quot;condition&quot;: {
16735 # &quot;title&quot;: &quot;expirable access&quot;,
16736 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
16737 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
16738 # }
16739 # }
16740 # ],
16741 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
16742 # &quot;version&quot;: 3
16743 # }
16744 # ```
16745 #
16746 # **YAML example:**
16747 #
16748 # ```
16749 # bindings:
16750 # - members:
16751 # - user:[email protected]
16752 # - group:[email protected]
16753 # - domain:google.com
16754 # - serviceAccount:[email protected]
16755 # role: roles/resourcemanager.organizationAdmin
16756 # - members:
16757 # - user:[email protected]
16758 # role: roles/resourcemanager.organizationViewer
16759 # condition:
16760 # title: expirable access
16761 # description: Does not grant access after Sep 2020
16762 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
16763 # etag: BwWWja0YfJA=
16764 # version: 3
16765 # ```
16766 #
16767 # For a description of IAM and its features, see the
16768 # [IAM documentation](https://cloud.google.com/iam/docs/).
16769 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
16770 { # Specifies the audit configuration for a service.
16771 # The configuration determines which permission types are logged, and what
16772 # identities, if any, are exempted from logging.
16773 # An AuditConfig must have one or more AuditLogConfigs.
16774 #
16775 # If there are AuditConfigs for both `allServices` and a specific service,
16776 # the union of the two AuditConfigs is used for that service: the log_types
16777 # specified in each AuditConfig are enabled, and the exempted_members in each
16778 # AuditLogConfig are exempted.
16779 #
16780 # Example Policy with multiple AuditConfigs:
16781 #
16782 # {
16783 # &quot;audit_configs&quot;: [
16784 # {
16785 # &quot;service&quot;: &quot;allServices&quot;,
16786 # &quot;audit_log_configs&quot;: [
16787 # {
16788 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
16789 # &quot;exempted_members&quot;: [
16790 # &quot;user:[email protected]&quot;
16791 # ]
16792 # },
16793 # {
16794 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
16795 # },
16796 # {
16797 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
16798 # }
16799 # ]
16800 # },
16801 # {
16802 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
16803 # &quot;audit_log_configs&quot;: [
16804 # {
16805 # &quot;log_type&quot;: &quot;DATA_READ&quot;
16806 # },
16807 # {
16808 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
16809 # &quot;exempted_members&quot;: [
16810 # &quot;user:[email protected]&quot;
16811 # ]
16812 # }
16813 # ]
16814 # }
16815 # ]
16816 # }
16817 #
16818 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
16819 # logging. It also exempts `[email protected]` from DATA_READ logging, and
16820 # `[email protected]` from DATA_WRITE logging.
16821 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
16822 { # Provides the configuration for logging a type of permissions.
16823 # Example:
16824 #
16825 # {
16826 # &quot;audit_log_configs&quot;: [
16827 # {
16828 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
16829 # &quot;exempted_members&quot;: [
16830 # &quot;user:[email protected]&quot;
16831 # ]
16832 # },
16833 # {
16834 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
16835 # }
16836 # ]
16837 # }
16838 #
16839 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
16840 # [email protected] from DATA_READ logging.
16841 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
16842 # permission.
16843 # Follows the same format of Binding.members.
16844 &quot;A String&quot;,
16845 ],
16846 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
16847 },
16848 ],
16849 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
16850 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
16851 # `allServices` is a special value that covers all services.
16852 },
16853 ],
16854 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
16855 # may specify a `condition` that determines how and when the `bindings` are
16856 # applied. Each of the `bindings` must contain at least one principal.
16857 #
16858 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
16859 # of these principals can be Google groups. Each occurrence of a principal
16860 # counts towards these limits. For example, if the `bindings` grant 50
16861 # different roles to `user:[email protected]`, and not to any other
16862 # principal, then you can add another 1,450 principals to the `bindings` in
16863 # the `Policy`.
16864 { # Associates `members`, or principals, with a `role`.
16865 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
16866 #
16867 # If the condition evaluates to `true`, then this binding applies to the
16868 # current request.
16869 #
16870 # If the condition evaluates to `false`, then this binding does not apply to
16871 # the current request. However, a different role binding might grant the same
16872 # role to one or more of the principals in this binding.
16873 #
16874 # To learn which resources support conditions in their IAM policies, see the
16875 # [IAM
16876 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
16877 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
16878 # are documented at https://github.com/google/cel-spec.
16879 #
16880 # Example (Comparison):
16881 #
16882 # title: &quot;Summary size limit&quot;
16883 # description: &quot;Determines if a summary is less than 100 chars&quot;
16884 # expression: &quot;document.summary.size() &lt; 100&quot;
16885 #
16886 # Example (Equality):
16887 #
16888 # title: &quot;Requestor is owner&quot;
16889 # description: &quot;Determines if requestor is the document owner&quot;
16890 # expression: &quot;document.owner == request.auth.claims.email&quot;
16891 #
16892 # Example (Logic):
16893 #
16894 # title: &quot;Public documents&quot;
16895 # description: &quot;Determine whether the document should be publicly visible&quot;
16896 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
16897 #
16898 # Example (Data Manipulation):
16899 #
16900 # title: &quot;Notification string&quot;
16901 # description: &quot;Create a notification string with a timestamp.&quot;
16902 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
16903 #
16904 # The exact variables and functions that may be referenced within an expression
16905 # are determined by the service that evaluates it. See the service
16906 # documentation for additional information.
16907 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
16908 # describes the expression, e.g. when hovered over it in a UI.
16909 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
16910 # syntax.
16911 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
16912 # reporting, e.g. a file name and a position in the file.
16913 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
16914 # its purpose. This can be used e.g. in UIs which allow to enter the
16915 # expression.
16916 },
16917 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
16918 # `members` can have the following values:
16919 #
16920 # * `allUsers`: A special identifier that represents anyone who is
16921 # on the internet; with or without a Google account.
16922 #
16923 # * `allAuthenticatedUsers`: A special identifier that represents anyone
16924 # who is authenticated with a Google account or a service account.
16925 # Does not include identities that come from external identity providers
16926 # (IdPs) through identity federation.
16927 #
16928 # * `user:{emailid}`: An email address that represents a specific Google
16929 # account. For example, `[email protected]` .
16930 #
16931 #
16932 # * `serviceAccount:{emailid}`: An email address that represents a Google
16933 # service account. For example,
16934 # `[email protected]`.
16935 #
16936 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
16937 # identifier for a
16938 # [Kubernetes service
16939 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
16940 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
16941 #
16942 # * `group:{emailid}`: An email address that represents a Google group.
16943 # For example, `[email protected]`.
16944 #
16945 #
16946 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
16947 # users of that domain. For example, `google.com` or `example.com`.
16948 #
16949 #
16950 #
16951 #
16952 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
16953 # A single identity in a workforce identity pool.
16954 #
16955 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
16956 # All workforce identities in a group.
16957 #
16958 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
16959 # All workforce identities with a specific attribute value.
16960 #
16961 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
16962 # All identities in a workforce identity pool.
16963 #
16964 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
16965 # A single identity in a workload identity pool.
16966 #
16967 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
16968 # A workload identity pool group.
16969 #
16970 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
16971 # All identities in a workload identity pool with a certain attribute.
16972 #
16973 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
16974 # All identities in a workload identity pool.
16975 #
16976 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
16977 # identifier) representing a user that has been recently deleted. For
16978 # example, `[email protected]?uid=123456789012345678901`. If the user is
16979 # recovered, this value reverts to `user:{emailid}` and the recovered user
16980 # retains the role in the binding.
16981 #
16982 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
16983 # unique identifier) representing a service account that has been recently
16984 # deleted. For example,
16985 # `[email protected]?uid=123456789012345678901`.
16986 # If the service account is undeleted, this value reverts to
16987 # `serviceAccount:{emailid}` and the undeleted service account retains the
16988 # role in the binding.
16989 #
16990 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
16991 # identifier) representing a Google group that has been recently
16992 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
16993 # the group is recovered, this value reverts to `group:{emailid}` and the
16994 # recovered group retains the role in the binding.
16995 #
16996 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
16997 # Deleted single identity in a workforce identity pool. For example,
16998 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
16999 &quot;A String&quot;,
17000 ],
17001 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
17002 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
17003 #
17004 # For an overview of the IAM roles and permissions, see the
17005 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
17006 # a list of the available pre-defined roles, see
17007 # [here](https://cloud.google.com/iam/docs/understanding-roles).
17008 },
17009 ],
17010 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
17011 # prevent simultaneous updates of a policy from overwriting each other.
17012 # It is strongly suggested that systems make use of the `etag` in the
17013 # read-modify-write cycle to perform policy updates in order to avoid race
17014 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
17015 # systems are expected to put that etag in the request to `setIamPolicy` to
17016 # ensure that their change will be applied to the same version of the policy.
17017 #
17018 # **Important:** If you use IAM Conditions, you must include the `etag` field
17019 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
17020 # you to overwrite a version `3` policy with a version `1` policy, and all of
17021 # the conditions in the version `3` policy are lost.
17022 &quot;version&quot;: 42, # Specifies the format of the policy.
17023 #
17024 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
17025 # are rejected.
17026 #
17027 # Any operation that affects conditional role bindings must specify version
17028 # `3`. This requirement applies to the following operations:
17029 #
17030 # * Getting a policy that includes a conditional role binding
17031 # * Adding a conditional role binding to a policy
17032 # * Changing a conditional role binding in a policy
17033 # * Removing any role binding, with or without a condition, from a policy
17034 # that includes conditions
17035 #
17036 # **Important:** If you use IAM Conditions, you must include the `etag` field
17037 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
17038 # you to overwrite a version `3` policy with a version `1` policy, and all of
17039 # the conditions in the version `3` policy are lost.
17040 #
17041 # If a policy does not include any conditions, operations on that policy may
17042 # specify any valid version or leave the field unset.
17043 #
17044 # To learn which resources support conditions in their IAM policies, see the
17045 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
17046 },
17047 }
17048
17049 x__xgafv: string, V1 error format.
17050 Allowed values
17051 1 - v1 error format
17052 2 - v2 error format
17053
17054 Returns:
17055 An object of the form:
17056
17057 { # An Identity and Access Management (IAM) policy, which specifies access
17058 # controls for Google Cloud resources.
17059 #
17060 #
17061 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
17062 # `members`, or principals, to a single `role`. Principals can be user
17063 # accounts, service accounts, Google groups, and domains (such as G Suite). A
17064 # `role` is a named list of permissions; each `role` can be an IAM predefined
17065 # role or a user-created custom role.
17066 #
17067 # For some types of Google Cloud resources, a `binding` can also specify a
17068 # `condition`, which is a logical expression that allows access to a resource
17069 # only if the expression evaluates to `true`. A condition can add constraints
17070 # based on attributes of the request, the resource, or both. To learn which
17071 # resources support conditions in their IAM policies, see the
17072 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
17073 #
17074 # **JSON example:**
17075 #
17076 # ```
17077 # {
17078 # &quot;bindings&quot;: [
17079 # {
17080 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
17081 # &quot;members&quot;: [
17082 # &quot;user:[email protected]&quot;,
17083 # &quot;group:[email protected]&quot;,
17084 # &quot;domain:google.com&quot;,
17085 # &quot;serviceAccount:[email protected]&quot;
17086 # ]
17087 # },
17088 # {
17089 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
17090 # &quot;members&quot;: [
17091 # &quot;user:[email protected]&quot;
17092 # ],
17093 # &quot;condition&quot;: {
17094 # &quot;title&quot;: &quot;expirable access&quot;,
17095 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
17096 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
17097 # }
17098 # }
17099 # ],
17100 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
17101 # &quot;version&quot;: 3
17102 # }
17103 # ```
17104 #
17105 # **YAML example:**
17106 #
17107 # ```
17108 # bindings:
17109 # - members:
17110 # - user:[email protected]
17111 # - group:[email protected]
17112 # - domain:google.com
17113 # - serviceAccount:[email protected]
17114 # role: roles/resourcemanager.organizationAdmin
17115 # - members:
17116 # - user:[email protected]
17117 # role: roles/resourcemanager.organizationViewer
17118 # condition:
17119 # title: expirable access
17120 # description: Does not grant access after Sep 2020
17121 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
17122 # etag: BwWWja0YfJA=
17123 # version: 3
17124 # ```
17125 #
17126 # For a description of IAM and its features, see the
17127 # [IAM documentation](https://cloud.google.com/iam/docs/).
17128 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
17129 { # Specifies the audit configuration for a service.
17130 # The configuration determines which permission types are logged, and what
17131 # identities, if any, are exempted from logging.
17132 # An AuditConfig must have one or more AuditLogConfigs.
17133 #
17134 # If there are AuditConfigs for both `allServices` and a specific service,
17135 # the union of the two AuditConfigs is used for that service: the log_types
17136 # specified in each AuditConfig are enabled, and the exempted_members in each
17137 # AuditLogConfig are exempted.
17138 #
17139 # Example Policy with multiple AuditConfigs:
17140 #
17141 # {
17142 # &quot;audit_configs&quot;: [
17143 # {
17144 # &quot;service&quot;: &quot;allServices&quot;,
17145 # &quot;audit_log_configs&quot;: [
17146 # {
17147 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
17148 # &quot;exempted_members&quot;: [
17149 # &quot;user:[email protected]&quot;
17150 # ]
17151 # },
17152 # {
17153 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
17154 # },
17155 # {
17156 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
17157 # }
17158 # ]
17159 # },
17160 # {
17161 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
17162 # &quot;audit_log_configs&quot;: [
17163 # {
17164 # &quot;log_type&quot;: &quot;DATA_READ&quot;
17165 # },
17166 # {
17167 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
17168 # &quot;exempted_members&quot;: [
17169 # &quot;user:[email protected]&quot;
17170 # ]
17171 # }
17172 # ]
17173 # }
17174 # ]
17175 # }
17176 #
17177 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
17178 # logging. It also exempts `[email protected]` from DATA_READ logging, and
17179 # `[email protected]` from DATA_WRITE logging.
17180 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
17181 { # Provides the configuration for logging a type of permissions.
17182 # Example:
17183 #
17184 # {
17185 # &quot;audit_log_configs&quot;: [
17186 # {
17187 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
17188 # &quot;exempted_members&quot;: [
17189 # &quot;user:[email protected]&quot;
17190 # ]
17191 # },
17192 # {
17193 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
17194 # }
17195 # ]
17196 # }
17197 #
17198 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
17199 # [email protected] from DATA_READ logging.
17200 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
17201 # permission.
17202 # Follows the same format of Binding.members.
17203 &quot;A String&quot;,
17204 ],
17205 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
17206 },
17207 ],
17208 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
17209 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
17210 # `allServices` is a special value that covers all services.
17211 },
17212 ],
17213 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
17214 # may specify a `condition` that determines how and when the `bindings` are
17215 # applied. Each of the `bindings` must contain at least one principal.
17216 #
17217 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
17218 # of these principals can be Google groups. Each occurrence of a principal
17219 # counts towards these limits. For example, if the `bindings` grant 50
17220 # different roles to `user:[email protected]`, and not to any other
17221 # principal, then you can add another 1,450 principals to the `bindings` in
17222 # the `Policy`.
17223 { # Associates `members`, or principals, with a `role`.
17224 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
17225 #
17226 # If the condition evaluates to `true`, then this binding applies to the
17227 # current request.
17228 #
17229 # If the condition evaluates to `false`, then this binding does not apply to
17230 # the current request. However, a different role binding might grant the same
17231 # role to one or more of the principals in this binding.
17232 #
17233 # To learn which resources support conditions in their IAM policies, see the
17234 # [IAM
17235 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
17236 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
17237 # are documented at https://github.com/google/cel-spec.
17238 #
17239 # Example (Comparison):
17240 #
17241 # title: &quot;Summary size limit&quot;
17242 # description: &quot;Determines if a summary is less than 100 chars&quot;
17243 # expression: &quot;document.summary.size() &lt; 100&quot;
17244 #
17245 # Example (Equality):
17246 #
17247 # title: &quot;Requestor is owner&quot;
17248 # description: &quot;Determines if requestor is the document owner&quot;
17249 # expression: &quot;document.owner == request.auth.claims.email&quot;
17250 #
17251 # Example (Logic):
17252 #
17253 # title: &quot;Public documents&quot;
17254 # description: &quot;Determine whether the document should be publicly visible&quot;
17255 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
17256 #
17257 # Example (Data Manipulation):
17258 #
17259 # title: &quot;Notification string&quot;
17260 # description: &quot;Create a notification string with a timestamp.&quot;
17261 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
17262 #
17263 # The exact variables and functions that may be referenced within an expression
17264 # are determined by the service that evaluates it. See the service
17265 # documentation for additional information.
17266 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
17267 # describes the expression, e.g. when hovered over it in a UI.
17268 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
17269 # syntax.
17270 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
17271 # reporting, e.g. a file name and a position in the file.
17272 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
17273 # its purpose. This can be used e.g. in UIs which allow to enter the
17274 # expression.
17275 },
17276 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
17277 # `members` can have the following values:
17278 #
17279 # * `allUsers`: A special identifier that represents anyone who is
17280 # on the internet; with or without a Google account.
17281 #
17282 # * `allAuthenticatedUsers`: A special identifier that represents anyone
17283 # who is authenticated with a Google account or a service account.
17284 # Does not include identities that come from external identity providers
17285 # (IdPs) through identity federation.
17286 #
17287 # * `user:{emailid}`: An email address that represents a specific Google
17288 # account. For example, `[email protected]` .
17289 #
17290 #
17291 # * `serviceAccount:{emailid}`: An email address that represents a Google
17292 # service account. For example,
17293 # `[email protected]`.
17294 #
17295 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
17296 # identifier for a
17297 # [Kubernetes service
17298 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
17299 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
17300 #
17301 # * `group:{emailid}`: An email address that represents a Google group.
17302 # For example, `[email protected]`.
17303 #
17304 #
17305 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
17306 # users of that domain. For example, `google.com` or `example.com`.
17307 #
17308 #
17309 #
17310 #
17311 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
17312 # A single identity in a workforce identity pool.
17313 #
17314 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
17315 # All workforce identities in a group.
17316 #
17317 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
17318 # All workforce identities with a specific attribute value.
17319 #
17320 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
17321 # All identities in a workforce identity pool.
17322 #
17323 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
17324 # A single identity in a workload identity pool.
17325 #
17326 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
17327 # A workload identity pool group.
17328 #
17329 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
17330 # All identities in a workload identity pool with a certain attribute.
17331 #
17332 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
17333 # All identities in a workload identity pool.
17334 #
17335 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
17336 # identifier) representing a user that has been recently deleted. For
17337 # example, `[email protected]?uid=123456789012345678901`. If the user is
17338 # recovered, this value reverts to `user:{emailid}` and the recovered user
17339 # retains the role in the binding.
17340 #
17341 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
17342 # unique identifier) representing a service account that has been recently
17343 # deleted. For example,
17344 # `[email protected]?uid=123456789012345678901`.
17345 # If the service account is undeleted, this value reverts to
17346 # `serviceAccount:{emailid}` and the undeleted service account retains the
17347 # role in the binding.
17348 #
17349 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
17350 # identifier) representing a Google group that has been recently
17351 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
17352 # the group is recovered, this value reverts to `group:{emailid}` and the
17353 # recovered group retains the role in the binding.
17354 #
17355 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
17356 # Deleted single identity in a workforce identity pool. For example,
17357 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
17358 &quot;A String&quot;,
17359 ],
17360 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
17361 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
17362 #
17363 # For an overview of the IAM roles and permissions, see the
17364 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
17365 # a list of the available pre-defined roles, see
17366 # [here](https://cloud.google.com/iam/docs/understanding-roles).
17367 },
17368 ],
17369 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
17370 # prevent simultaneous updates of a policy from overwriting each other.
17371 # It is strongly suggested that systems make use of the `etag` in the
17372 # read-modify-write cycle to perform policy updates in order to avoid race
17373 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
17374 # systems are expected to put that etag in the request to `setIamPolicy` to
17375 # ensure that their change will be applied to the same version of the policy.
17376 #
17377 # **Important:** If you use IAM Conditions, you must include the `etag` field
17378 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
17379 # you to overwrite a version `3` policy with a version `1` policy, and all of
17380 # the conditions in the version `3` policy are lost.
17381 &quot;version&quot;: 42, # Specifies the format of the policy.
17382 #
17383 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
17384 # are rejected.
17385 #
17386 # Any operation that affects conditional role bindings must specify version
17387 # `3`. This requirement applies to the following operations:
17388 #
17389 # * Getting a policy that includes a conditional role binding
17390 # * Adding a conditional role binding to a policy
17391 # * Changing a conditional role binding in a policy
17392 # * Removing any role binding, with or without a condition, from a policy
17393 # that includes conditions
17394 #
17395 # **Important:** If you use IAM Conditions, you must include the `etag` field
17396 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
17397 # you to overwrite a version `3` policy with a version `1` policy, and all of
17398 # the conditions in the version `3` policy are lost.
17399 #
17400 # If a policy does not include any conditions, operations on that policy may
17401 # specify any valid version or leave the field unset.
17402 #
17403 # To learn which resources support conditions in their IAM policies, see the
17404 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
17405 }</pre>
17406 </div>
17407
17408 <div class="method">
17409 <code class="details" id="setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
17410 <pre>Sets labels on an instance. To learn more about labels, read theLabeling
17411 Resources documentation.
17412
17413 Args:
17414 project: string, Project ID for this request. (required)
17415 zone: string, The name of the zone for this request. (required)
17416 instance: string, Name of the instance scoping this request. (required)
17417 body: object, The request body.
17418 The object takes the form of:
17419
17420 {
17421 &quot;labelFingerprint&quot;: &quot;A String&quot;, # Fingerprint of the previous set of labels for this resource,
17422 # used to prevent conflicts. Provide the latest fingerprint value when making
17423 # a request to add or change labels.
17424 &quot;labels&quot;: {
17425 &quot;a_key&quot;: &quot;A String&quot;,
17426 },
17427 }
17428
17429 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
17430 that if you must retry your request, the server will know to ignore the
17431 request if it has already been completed.
17432
17433 For example, consider a situation where you make an initial request and
17434 the request times out. If you make the request again with the same
17435 request ID, the server can check if original operation with the same
17436 request ID was received, and if so, will ignore the second request. This
17437 prevents clients from accidentally creating duplicate commitments.
17438
17439 The request ID must be
17440 a valid UUID with the exception that zero UUID is not supported
17441 (00000000-0000-0000-0000-000000000000).
17442 x__xgafv: string, V1 error format.
17443 Allowed values
17444 1 - v1 error format
17445 2 - v2 error format
17446
17447 Returns:
17448 An object of the form:
17449
17450 { # Represents an Operation resource.
17451 #
17452 # Google Compute Engine has three Operation resources:
17453 #
17454 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
17455 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
17456 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
17457 #
17458 # You can use an operation resource to manage asynchronous API requests.
17459 # For more information, readHandling
17460 # API responses.
17461 #
17462 # Operations can be global, regional or zonal.
17463 #
17464 # - For global operations, use the `globalOperations`
17465 # resource.
17466 # - For regional operations, use the
17467 # `regionOperations` resource.
17468 # - For zonal operations, use
17469 # the `zoneOperations` resource.
17470 #
17471 #
17472 #
17473 # For more information, read
17474 # Global, Regional, and Zonal Resources.
17475 #
17476 # Note that completed Operation resources have a limited
17477 # retention period.
17478 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17479 # Not present otherwise.
17480 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17481 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17482 # set when the operation is created.
17483 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17484 # text format.
17485 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17486 # this field will be populated.
17487 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17488 # operation.
17489 {
17490 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17491 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17492 # details. There is a set of defined message types to use for providing
17493 # details.The syntax depends on the error code. For example,
17494 # QuotaExceededInfo will have details when the error code is
17495 # QUOTA_EXCEEDED.
17496 {
17497 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17498 #
17499 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17500 # is not enabled:
17501 #
17502 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17503 # &quot;domain&quot;: &quot;googleapis.com&quot;
17504 # &quot;metadata&quot;: {
17505 # &quot;resource&quot;: &quot;projects/123&quot;,
17506 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17507 # }
17508 # }
17509 #
17510 # This response indicates that the pubsub.googleapis.com API is not enabled.
17511 #
17512 # Example of an error that is returned when attempting to create a Spanner
17513 # instance in a region that is out of stock:
17514 #
17515 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17516 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17517 # &quot;metadata&quot;: {
17518 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17519 # }
17520 # }
17521 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17522 # is typically the registered service name of the tool or product that
17523 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17524 # generated by some common infrastructure, the error domain must be a
17525 # globally unique value that identifies the infrastructure. For Google API
17526 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17527 &quot;metadatas&quot;: { # Additional structured details about this error.
17528 #
17529 # Keys must match a regular expression of `a-z+` but should
17530 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17531 # length. When identifying the current value of an exceeded limit, the units
17532 # should be contained in the key, not the value. For example, rather than
17533 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17534 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17535 # instances that can be created in a single (batch) request.
17536 &quot;a_key&quot;: &quot;A String&quot;,
17537 },
17538 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17539 # proximate cause of the error. Error reasons are unique within a particular
17540 # domain of errors. This should be at most 63 characters and match a
17541 # regular expression of `A-Z+[A-Z0-9]`, which represents
17542 # UPPER_SNAKE_CASE.
17543 },
17544 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17545 #
17546 # For example, if a quota check failed with an error indicating the calling
17547 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17548 # directly to the right place in the developer console to flip the bit.
17549 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
17550 { # Describes a URL link.
17551 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
17552 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
17553 },
17554 ],
17555 },
17556 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
17557 # which can be attached to an RPC error.
17558 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
17559 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
17560 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
17561 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
17562 },
17563 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
17564 &quot;dimensions&quot;: { # The map holding related quota dimensions.
17565 &quot;a_key&quot;: &quot;A String&quot;,
17566 },
17567 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
17568 # type or metric.
17569 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
17570 # or metric.
17571 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
17572 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
17573 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
17574 },
17575 },
17576 ],
17577 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
17578 # This property is optional.
17579 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
17580 },
17581 ],
17582 },
17583 &quot;getVersionOperationMetadata&quot;: {
17584 &quot;inlineSbomInfo&quot;: {
17585 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
17586 # appropriate identifiers.
17587 &quot;a_key&quot;: &quot;A String&quot;,
17588 },
17589 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
17590 # identifiers.
17591 &quot;a_key&quot;: &quot;A String&quot;,
17592 },
17593 },
17594 },
17595 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
17596 # message that was returned, such as `NOT FOUND`.
17597 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
17598 # status code that was returned. For example, a `404` means the
17599 # resource was not found.
17600 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
17601 # defined by the server.
17602 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
17603 # This value is inRFC3339
17604 # text format.
17605 &quot;instancesBulkInsertOperationMetadata&quot;: {
17606 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
17607 # Example key: zones/us-central1-a
17608 &quot;a_key&quot;: {
17609 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
17610 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
17611 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
17612 # error.
17613 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
17614 # if the flow is rolling forward or rolling back.
17615 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
17616 },
17617 },
17618 },
17619 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
17620 # Operation resources.
17621 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
17622 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
17623 # group of operations results from a `bulkInsert` API request.
17624 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
17625 # `update`, or `delete`, and so on.
17626 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17627 # There is no requirement that this be linear or support any granularity of
17628 # operations. This should not be used to guess when the operation will be
17629 # complete. This number should monotonically increase as the operation
17630 # progresses.
17631 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17632 # applicable when performing regional operations.
17633 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17634 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
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="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
17717 <pre>Changes the number and/or type of accelerator for a stopped instance to the
17718 values specified in the request.
17719
17720 Args:
17721 project: string, Project ID for this request. (required)
17722 zone: string, The name of the zone for this request. (required)
17723 instance: string, Name of the instance scoping this request. (required)
17724 body: object, The request body.
17725 The object takes the form of:
17726
17727 {
17728 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
17729 { # A specification of the type and number of accelerator cards attached to the
17730 # instance.
17731 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
17732 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
17733 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
17734 # If you are creating an instance template, specify only the
17735 # accelerator name.
17736 # See GPUs on Compute Engine
17737 # for a full list of accelerator types.
17738 },
17739 ],
17740 }
17741
17742 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
17743 that if you must retry your request, the server will know to ignore the
17744 request if it has already been completed.
17745
17746 For example, consider a situation where you make an initial request and
17747 the request times out. If you make the request again with the same
17748 request ID, the server can check if original operation with the same
17749 request ID was received, and if so, will ignore the second request. This
17750 prevents clients from accidentally creating duplicate commitments.
17751
17752 The request ID must be
17753 a valid UUID with the exception that zero UUID is not supported
17754 (00000000-0000-0000-0000-000000000000).
17755 x__xgafv: string, V1 error format.
17756 Allowed values
17757 1 - v1 error format
17758 2 - v2 error format
17759
17760 Returns:
17761 An object of the form:
17762
17763 { # Represents an Operation resource.
17764 #
17765 # Google Compute Engine has three Operation resources:
17766 #
17767 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
17768 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
17769 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
17770 #
17771 # You can use an operation resource to manage asynchronous API requests.
17772 # For more information, readHandling
17773 # API responses.
17774 #
17775 # Operations can be global, regional or zonal.
17776 #
17777 # - For global operations, use the `globalOperations`
17778 # resource.
17779 # - For regional operations, use the
17780 # `regionOperations` resource.
17781 # - For zonal operations, use
17782 # the `zoneOperations` resource.
17783 #
17784 #
17785 #
17786 # For more information, read
17787 # Global, Regional, and Zonal Resources.
17788 #
17789 # Note that completed Operation resources have a limited
17790 # retention period.
17791 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17792 # Not present otherwise.
17793 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17794 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17795 # set when the operation is created.
17796 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17797 # text format.
17798 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17799 # this field will be populated.
17800 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17801 # operation.
17802 {
17803 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17804 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17805 # details. There is a set of defined message types to use for providing
17806 # details.The syntax depends on the error code. For example,
17807 # QuotaExceededInfo will have details when the error code is
17808 # QUOTA_EXCEEDED.
17809 {
17810 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17811 #
17812 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17813 # is not enabled:
17814 #
17815 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17816 # &quot;domain&quot;: &quot;googleapis.com&quot;
17817 # &quot;metadata&quot;: {
17818 # &quot;resource&quot;: &quot;projects/123&quot;,
17819 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17820 # }
17821 # }
17822 #
17823 # This response indicates that the pubsub.googleapis.com API is not enabled.
17824 #
17825 # Example of an error that is returned when attempting to create a Spanner
17826 # instance in a region that is out of stock:
17827 #
17828 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17829 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17830 # &quot;metadata&quot;: {
17831 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17832 # }
17833 # }
17834 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17835 # is typically the registered service name of the tool or product that
17836 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17837 # generated by some common infrastructure, the error domain must be a
17838 # globally unique value that identifies the infrastructure. For Google API
17839 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17840 &quot;metadatas&quot;: { # Additional structured details about this error.
17841 #
17842 # Keys must match a regular expression of `a-z+` but should
17843 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17844 # length. When identifying the current value of an exceeded limit, the units
17845 # should be contained in the key, not the value. For example, rather than
17846 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17847 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17848 # instances that can be created in a single (batch) request.
17849 &quot;a_key&quot;: &quot;A String&quot;,
17850 },
17851 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17852 # proximate cause of the error. Error reasons are unique within a particular
17853 # domain of errors. This should be at most 63 characters and match a
17854 # regular expression of `A-Z+[A-Z0-9]`, which represents
17855 # UPPER_SNAKE_CASE.
17856 },
17857 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17858 #
17859 # For example, if a quota check failed with an error indicating the calling
17860 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17861 # directly to the right place in the developer console to flip the bit.
17862 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
17863 { # Describes a URL link.
17864 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
17865 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
17866 },
17867 ],
17868 },
17869 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
17870 # which can be attached to an RPC error.
17871 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
17872 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
17873 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
17874 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
17875 },
17876 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
17877 &quot;dimensions&quot;: { # The map holding related quota dimensions.
17878 &quot;a_key&quot;: &quot;A String&quot;,
17879 },
17880 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
17881 # type or metric.
17882 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
17883 # or metric.
17884 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
17885 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
17886 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
17887 },
17888 },
17889 ],
17890 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
17891 # This property is optional.
17892 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
17893 },
17894 ],
17895 },
17896 &quot;getVersionOperationMetadata&quot;: {
17897 &quot;inlineSbomInfo&quot;: {
17898 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
17899 # appropriate identifiers.
17900 &quot;a_key&quot;: &quot;A String&quot;,
17901 },
17902 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
17903 # identifiers.
17904 &quot;a_key&quot;: &quot;A String&quot;,
17905 },
17906 },
17907 },
17908 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
17909 # message that was returned, such as `NOT FOUND`.
17910 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
17911 # status code that was returned. For example, a `404` means the
17912 # resource was not found.
17913 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
17914 # defined by the server.
17915 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
17916 # This value is inRFC3339
17917 # text format.
17918 &quot;instancesBulkInsertOperationMetadata&quot;: {
17919 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
17920 # Example key: zones/us-central1-a
17921 &quot;a_key&quot;: {
17922 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
17923 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
17924 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
17925 # error.
17926 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
17927 # if the flow is rolling forward or rolling back.
17928 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
17929 },
17930 },
17931 },
17932 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
17933 # Operation resources.
17934 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
17935 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
17936 # group of operations results from a `bulkInsert` API request.
17937 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
17938 # `update`, or `delete`, and so on.
17939 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17940 # There is no requirement that this be linear or support any granularity of
17941 # operations. This should not be used to guess when the operation will be
17942 # complete. This number should monotonically increase as the operation
17943 # progresses.
17944 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17945 # applicable when performing regional operations.
17946 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17947 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
17948 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
17949 # this field will contain information on all underlying zonal actions and
17950 # their state.
17951 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
17952 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
17953 # Example key: zones/us-central1-a
17954 &quot;a_key&quot;: {
17955 &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
17956 # populated.
17957 # different programming environments, including REST APIs and RPC APIs. It is
17958 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
17959 # three pieces of data: error code, error message, and error details.
17960 #
17961 # You can find out more about this error model and how to work with it in the
17962 # [API Design Guide](https://cloud.google.com/apis/design/errors).
17963 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
17964 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
17965 # message types for APIs to use.
17966 {
17967 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
17968 },
17969 ],
17970 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
17971 # user-facing error message should be localized and sent in the
17972 # google.rpc.Status.details field, or localized by the client.
17973 },
17974 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
17975 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
17976 },
17977 },
17978 },
17979 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
17980 # This value is inRFC3339
17981 # text format.
17982 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
17983 # following:
17984 # `PENDING`, `RUNNING`, or `DONE`.
17985 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
17986 # operation.
17987 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
17988 # of the target resource.
17989 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
17990 # operations related to creating a snapshot, this points to the disk
17991 # that the snapshot was created from.
17992 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
17993 # `[email protected]` or
17994 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
17995 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
17996 # operation, this field will be populated.
17997 {
17998 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
17999 # Engine returns NO_RESULTS_ON_PAGE if there
18000 # are no results in the response.
18001 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
18002 # value format. For example:
18003 #
18004 # &quot;data&quot;: [
18005 # {
18006 # &quot;key&quot;: &quot;scope&quot;,
18007 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
18008 # }
18009 {
18010 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18011 # returned. For example, for warnings where there are no results in a list
18012 # request for a particular zone, this key might be scope and
18013 # the key value might be the zone name. Other examples might be a key
18014 # indicating a deprecated resource and a suggested replacement, or a
18015 # warning about invalid network settings (for example, if an instance
18016 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18017 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18018 },
18019 ],
18020 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18021 },
18022 ],
18023 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18024 # applicable when performing per-zone operations.
18025 }</pre>
18026 </div>
18027
18028 <div class="method">
18029 <code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
18030 <pre>Changes the machine type for a stopped instance to the machine
18031 type specified in the request.
18032
18033 Args:
18034 project: string, Project ID for this request. (required)
18035 zone: string, The name of the zone for this request. (required)
18036 instance: string, Name of the instance scoping this request. (required)
18037 body: object, The request body.
18038 The object takes the form of:
18039
18040 {
18041 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource. See Machine Types for a full list of
18042 # machine types. For example:zones/us-central1-f/machineTypes/n1-standard-1
18043 }
18044
18045 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18046 that if you must retry your request, the server will know to ignore the
18047 request if it has already been completed.
18048
18049 For example, consider a situation where you make an initial request and
18050 the request times out. If you make the request again with the same
18051 request ID, the server can check if original operation with the same
18052 request ID was received, and if so, will ignore the second request. This
18053 prevents clients from accidentally creating duplicate commitments.
18054
18055 The request ID must be
18056 a valid UUID with the exception that zero UUID is not supported
18057 (00000000-0000-0000-0000-000000000000).
18058 x__xgafv: string, V1 error format.
18059 Allowed values
18060 1 - v1 error format
18061 2 - v2 error format
18062
18063 Returns:
18064 An object of the form:
18065
18066 { # Represents an Operation resource.
18067 #
18068 # Google Compute Engine has three Operation resources:
18069 #
18070 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
18071 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
18072 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
18073 #
18074 # You can use an operation resource to manage asynchronous API requests.
18075 # For more information, readHandling
18076 # API responses.
18077 #
18078 # Operations can be global, regional or zonal.
18079 #
18080 # - For global operations, use the `globalOperations`
18081 # resource.
18082 # - For regional operations, use the
18083 # `regionOperations` resource.
18084 # - For zonal operations, use
18085 # the `zoneOperations` resource.
18086 #
18087 #
18088 #
18089 # For more information, read
18090 # Global, Regional, and Zonal Resources.
18091 #
18092 # Note that completed Operation resources have a limited
18093 # retention period.
18094 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
18095 # Not present otherwise.
18096 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
18097 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
18098 # set when the operation is created.
18099 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
18100 # text format.
18101 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
18102 # this field will be populated.
18103 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
18104 # operation.
18105 {
18106 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
18107 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
18108 # details. There is a set of defined message types to use for providing
18109 # details.The syntax depends on the error code. For example,
18110 # QuotaExceededInfo will have details when the error code is
18111 # QUOTA_EXCEEDED.
18112 {
18113 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
18114 #
18115 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
18116 # is not enabled:
18117 #
18118 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
18119 # &quot;domain&quot;: &quot;googleapis.com&quot;
18120 # &quot;metadata&quot;: {
18121 # &quot;resource&quot;: &quot;projects/123&quot;,
18122 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
18123 # }
18124 # }
18125 #
18126 # This response indicates that the pubsub.googleapis.com API is not enabled.
18127 #
18128 # Example of an error that is returned when attempting to create a Spanner
18129 # instance in a region that is out of stock:
18130 #
18131 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
18132 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
18133 # &quot;metadata&quot;: {
18134 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
18135 # }
18136 # }
18137 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
18138 # is typically the registered service name of the tool or product that
18139 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
18140 # generated by some common infrastructure, the error domain must be a
18141 # globally unique value that identifies the infrastructure. For Google API
18142 # infrastructure, the error domain is &quot;googleapis.com&quot;.
18143 &quot;metadatas&quot;: { # Additional structured details about this error.
18144 #
18145 # Keys must match a regular expression of `a-z+` but should
18146 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
18147 # length. When identifying the current value of an exceeded limit, the units
18148 # should be contained in the key, not the value. For example, rather than
18149 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
18150 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
18151 # instances that can be created in a single (batch) request.
18152 &quot;a_key&quot;: &quot;A String&quot;,
18153 },
18154 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
18155 # proximate cause of the error. Error reasons are unique within a particular
18156 # domain of errors. This should be at most 63 characters and match a
18157 # regular expression of `A-Z+[A-Z0-9]`, which represents
18158 # UPPER_SNAKE_CASE.
18159 },
18160 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
18161 #
18162 # For example, if a quota check failed with an error indicating the calling
18163 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
18164 # directly to the right place in the developer console to flip the bit.
18165 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18166 { # Describes a URL link.
18167 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18168 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18169 },
18170 ],
18171 },
18172 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18173 # which can be attached to an RPC error.
18174 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18175 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18176 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18177 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18178 },
18179 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18180 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18181 &quot;a_key&quot;: &quot;A String&quot;,
18182 },
18183 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18184 # type or metric.
18185 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18186 # or metric.
18187 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18188 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18189 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18190 },
18191 },
18192 ],
18193 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18194 # This property is optional.
18195 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18196 },
18197 ],
18198 },
18199 &quot;getVersionOperationMetadata&quot;: {
18200 &quot;inlineSbomInfo&quot;: {
18201 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
18202 # appropriate identifiers.
18203 &quot;a_key&quot;: &quot;A String&quot;,
18204 },
18205 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
18206 # identifiers.
18207 &quot;a_key&quot;: &quot;A String&quot;,
18208 },
18209 },
18210 },
18211 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
18212 # message that was returned, such as `NOT FOUND`.
18213 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
18214 # status code that was returned. For example, a `404` means the
18215 # resource was not found.
18216 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
18217 # defined by the server.
18218 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
18219 # This value is inRFC3339
18220 # text format.
18221 &quot;instancesBulkInsertOperationMetadata&quot;: {
18222 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
18223 # Example key: zones/us-central1-a
18224 &quot;a_key&quot;: {
18225 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
18226 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
18227 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
18228 # error.
18229 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
18230 # if the flow is rolling forward or rolling back.
18231 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
18232 },
18233 },
18234 },
18235 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
18236 # Operation resources.
18237 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
18238 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
18239 # group of operations results from a `bulkInsert` API request.
18240 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
18241 # `update`, or `delete`, and so on.
18242 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
18243 # There is no requirement that this be linear or support any granularity of
18244 # operations. This should not be used to guess when the operation will be
18245 # complete. This number should monotonically increase as the operation
18246 # progresses.
18247 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
18248 # applicable when performing regional operations.
18249 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
18250 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
18251 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
18252 # this field will contain information on all underlying zonal actions and
18253 # their state.
18254 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
18255 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
18256 # Example key: zones/us-central1-a
18257 &quot;a_key&quot;: {
18258 &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
18259 # populated.
18260 # different programming environments, including REST APIs and RPC APIs. It is
18261 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
18262 # three pieces of data: error code, error message, and error details.
18263 #
18264 # You can find out more about this error model and how to work with it in the
18265 # [API Design Guide](https://cloud.google.com/apis/design/errors).
18266 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
18267 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
18268 # message types for APIs to use.
18269 {
18270 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
18271 },
18272 ],
18273 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
18274 # user-facing error message should be localized and sent in the
18275 # google.rpc.Status.details field, or localized by the client.
18276 },
18277 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
18278 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
18279 },
18280 },
18281 },
18282 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
18283 # This value is inRFC3339
18284 # text format.
18285 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
18286 # following:
18287 # `PENDING`, `RUNNING`, or `DONE`.
18288 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
18289 # operation.
18290 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
18291 # of the target resource.
18292 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
18293 # operations related to creating a snapshot, this points to the disk
18294 # that the snapshot was created from.
18295 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
18296 # `[email protected]` or
18297 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
18298 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
18299 # operation, this field will be populated.
18300 {
18301 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
18302 # Engine returns NO_RESULTS_ON_PAGE if there
18303 # are no results in the response.
18304 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
18305 # value format. For example:
18306 #
18307 # &quot;data&quot;: [
18308 # {
18309 # &quot;key&quot;: &quot;scope&quot;,
18310 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
18311 # }
18312 {
18313 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18314 # returned. For example, for warnings where there are no results in a list
18315 # request for a particular zone, this key might be scope and
18316 # the key value might be the zone name. Other examples might be a key
18317 # indicating a deprecated resource and a suggested replacement, or a
18318 # warning about invalid network settings (for example, if an instance
18319 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18320 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18321 },
18322 ],
18323 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18324 },
18325 ],
18326 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18327 # applicable when performing per-zone operations.
18328 }</pre>
18329 </div>
18330
18331 <div class="method">
18332 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
18333 <pre>Sets metadata for the specified instance to the data included
18334 in the request.
18335
18336 Args:
18337 project: string, Project ID for this request. (required)
18338 zone: string, The name of the zone for this request. (required)
18339 instance: string, Name of the instance scoping this request. (required)
18340 body: object, The request body.
18341 The object takes the form of:
18342
18343 { # A metadata key/value entry.
18344 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
18345 # the metadata&#x27;s contents and used for optimistic locking. The
18346 # fingerprint is initially generated by Compute Engine and changes after
18347 # every request to modify or update metadata. You must always provide an
18348 # up-to-date fingerprint hash in order to update or change metadata,
18349 # otherwise the request will fail with error412 conditionNotMet.
18350 #
18351 # To see the latest fingerprint, make a get() request to
18352 # retrieve the resource.
18353 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
18354 # less than 512 KB.
18355 { # Metadata
18356 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
18357 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
18358 # This is reflected as part of a URL in the metadata server. Additionally, to
18359 # avoid ambiguity, keys must not conflict with any other metadata keys
18360 # for the project.
18361 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
18362 # have meaning as interpreted by the image running in the instance. The
18363 # only restriction placed on values is that their size must be less than
18364 # or equal to 262144 bytes (256 KiB).
18365 },
18366 ],
18367 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
18368 # for metadata.
18369 }
18370
18371 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18372 that if you must retry your request, the server will know to ignore the
18373 request if it has already been completed.
18374
18375 For example, consider a situation where you make an initial request and
18376 the request times out. If you make the request again with the same
18377 request ID, the server can check if original operation with the same
18378 request ID was received, and if so, will ignore the second request. This
18379 prevents clients from accidentally creating duplicate commitments.
18380
18381 The request ID must be
18382 a valid UUID with the exception that zero UUID is not supported
18383 (00000000-0000-0000-0000-000000000000).
18384 x__xgafv: string, V1 error format.
18385 Allowed values
18386 1 - v1 error format
18387 2 - v2 error format
18388
18389 Returns:
18390 An object of the form:
18391
18392 { # Represents an Operation resource.
18393 #
18394 # Google Compute Engine has three Operation resources:
18395 #
18396 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
18397 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
18398 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
18399 #
18400 # You can use an operation resource to manage asynchronous API requests.
18401 # For more information, readHandling
18402 # API responses.
18403 #
18404 # Operations can be global, regional or zonal.
18405 #
18406 # - For global operations, use the `globalOperations`
18407 # resource.
18408 # - For regional operations, use the
18409 # `regionOperations` resource.
18410 # - For zonal operations, use
18411 # the `zoneOperations` resource.
18412 #
18413 #
18414 #
18415 # For more information, read
18416 # Global, Regional, and Zonal Resources.
18417 #
18418 # Note that completed Operation resources have a limited
18419 # retention period.
18420 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
18421 # Not present otherwise.
18422 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
18423 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
18424 # set when the operation is created.
18425 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
18426 # text format.
18427 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
18428 # this field will be populated.
18429 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
18430 # operation.
18431 {
18432 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
18433 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
18434 # details. There is a set of defined message types to use for providing
18435 # details.The syntax depends on the error code. For example,
18436 # QuotaExceededInfo will have details when the error code is
18437 # QUOTA_EXCEEDED.
18438 {
18439 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
18440 #
18441 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
18442 # is not enabled:
18443 #
18444 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
18445 # &quot;domain&quot;: &quot;googleapis.com&quot;
18446 # &quot;metadata&quot;: {
18447 # &quot;resource&quot;: &quot;projects/123&quot;,
18448 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
18449 # }
18450 # }
18451 #
18452 # This response indicates that the pubsub.googleapis.com API is not enabled.
18453 #
18454 # Example of an error that is returned when attempting to create a Spanner
18455 # instance in a region that is out of stock:
18456 #
18457 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
18458 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
18459 # &quot;metadata&quot;: {
18460 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
18461 # }
18462 # }
18463 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
18464 # is typically the registered service name of the tool or product that
18465 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
18466 # generated by some common infrastructure, the error domain must be a
18467 # globally unique value that identifies the infrastructure. For Google API
18468 # infrastructure, the error domain is &quot;googleapis.com&quot;.
18469 &quot;metadatas&quot;: { # Additional structured details about this error.
18470 #
18471 # Keys must match a regular expression of `a-z+` but should
18472 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
18473 # length. When identifying the current value of an exceeded limit, the units
18474 # should be contained in the key, not the value. For example, rather than
18475 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
18476 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
18477 # instances that can be created in a single (batch) request.
18478 &quot;a_key&quot;: &quot;A String&quot;,
18479 },
18480 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
18481 # proximate cause of the error. Error reasons are unique within a particular
18482 # domain of errors. This should be at most 63 characters and match a
18483 # regular expression of `A-Z+[A-Z0-9]`, which represents
18484 # UPPER_SNAKE_CASE.
18485 },
18486 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
18487 #
18488 # For example, if a quota check failed with an error indicating the calling
18489 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
18490 # directly to the right place in the developer console to flip the bit.
18491 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18492 { # Describes a URL link.
18493 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18494 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18495 },
18496 ],
18497 },
18498 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18499 # which can be attached to an RPC error.
18500 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18501 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18502 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18503 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18504 },
18505 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18506 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18507 &quot;a_key&quot;: &quot;A String&quot;,
18508 },
18509 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18510 # type or metric.
18511 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18512 # or metric.
18513 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18514 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18515 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18516 },
18517 },
18518 ],
18519 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18520 # This property is optional.
18521 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18522 },
18523 ],
18524 },
18525 &quot;getVersionOperationMetadata&quot;: {
18526 &quot;inlineSbomInfo&quot;: {
18527 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
18528 # appropriate identifiers.
18529 &quot;a_key&quot;: &quot;A String&quot;,
18530 },
18531 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
18532 # identifiers.
18533 &quot;a_key&quot;: &quot;A String&quot;,
18534 },
18535 },
18536 },
18537 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
18538 # message that was returned, such as `NOT FOUND`.
18539 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
18540 # status code that was returned. For example, a `404` means the
18541 # resource was not found.
18542 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
18543 # defined by the server.
18544 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
18545 # This value is inRFC3339
18546 # text format.
18547 &quot;instancesBulkInsertOperationMetadata&quot;: {
18548 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
18549 # Example key: zones/us-central1-a
18550 &quot;a_key&quot;: {
18551 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
18552 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
18553 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
18554 # error.
18555 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
18556 # if the flow is rolling forward or rolling back.
18557 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
18558 },
18559 },
18560 },
18561 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
18562 # Operation resources.
18563 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
18564 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
18565 # group of operations results from a `bulkInsert` API request.
18566 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
18567 # `update`, or `delete`, and so on.
18568 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
18569 # There is no requirement that this be linear or support any granularity of
18570 # operations. This should not be used to guess when the operation will be
18571 # complete. This number should monotonically increase as the operation
18572 # progresses.
18573 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
18574 # applicable when performing regional operations.
18575 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
18576 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
18577 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
18578 # this field will contain information on all underlying zonal actions and
18579 # their state.
18580 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
18581 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
18582 # Example key: zones/us-central1-a
18583 &quot;a_key&quot;: {
18584 &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
18585 # populated.
18586 # different programming environments, including REST APIs and RPC APIs. It is
18587 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
18588 # three pieces of data: error code, error message, and error details.
18589 #
18590 # You can find out more about this error model and how to work with it in the
18591 # [API Design Guide](https://cloud.google.com/apis/design/errors).
18592 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
18593 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
18594 # message types for APIs to use.
18595 {
18596 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
18597 },
18598 ],
18599 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
18600 # user-facing error message should be localized and sent in the
18601 # google.rpc.Status.details field, or localized by the client.
18602 },
18603 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
18604 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
18605 },
18606 },
18607 },
18608 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
18609 # This value is inRFC3339
18610 # text format.
18611 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
18612 # following:
18613 # `PENDING`, `RUNNING`, or `DONE`.
18614 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
18615 # operation.
18616 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
18617 # of the target resource.
18618 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
18619 # operations related to creating a snapshot, this points to the disk
18620 # that the snapshot was created from.
18621 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
18622 # `[email protected]` or
18623 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
18624 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
18625 # operation, this field will be populated.
18626 {
18627 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
18628 # Engine returns NO_RESULTS_ON_PAGE if there
18629 # are no results in the response.
18630 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
18631 # value format. For example:
18632 #
18633 # &quot;data&quot;: [
18634 # {
18635 # &quot;key&quot;: &quot;scope&quot;,
18636 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
18637 # }
18638 {
18639 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18640 # returned. For example, for warnings where there are no results in a list
18641 # request for a particular zone, this key might be scope and
18642 # the key value might be the zone name. Other examples might be a key
18643 # indicating a deprecated resource and a suggested replacement, or a
18644 # warning about invalid network settings (for example, if an instance
18645 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18646 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18647 },
18648 ],
18649 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18650 },
18651 ],
18652 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18653 # applicable when performing per-zone operations.
18654 }</pre>
18655 </div>
18656
18657 <div class="method">
18658 <code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
18659 <pre>Changes the minimum CPU platform that this instance should use.
18660 This method can only
18661 be called on a stopped instance. For more information, readSpecifying a
18662 Minimum CPU Platform.
18663
18664 Args:
18665 project: string, Project ID for this request. (required)
18666 zone: string, The name of the zone for this request. (required)
18667 instance: string, Name of the instance scoping this request. (required)
18668 body: object, The request body.
18669 The object takes the form of:
18670
18671 {
18672 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform this instance should be started at.
18673 }
18674
18675 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18676 that if you must retry your request, the server will know to ignore the
18677 request if it has already been completed.
18678
18679 For example, consider a situation where you make an initial request and
18680 the request times out. If you make the request again with the same
18681 request ID, the server can check if original operation with the same
18682 request ID was received, and if so, will ignore the second request. This
18683 prevents clients from accidentally creating duplicate commitments.
18684
18685 The request ID must be
18686 a valid UUID with the exception that zero UUID is not supported
18687 (00000000-0000-0000-0000-000000000000).
18688 x__xgafv: string, V1 error format.
18689 Allowed values
18690 1 - v1 error format
18691 2 - v2 error format
18692
18693 Returns:
18694 An object of the form:
18695
18696 { # Represents an Operation resource.
18697 #
18698 # Google Compute Engine has three Operation resources:
18699 #
18700 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
18701 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
18702 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
18703 #
18704 # You can use an operation resource to manage asynchronous API requests.
18705 # For more information, readHandling
18706 # API responses.
18707 #
18708 # Operations can be global, regional or zonal.
18709 #
18710 # - For global operations, use the `globalOperations`
18711 # resource.
18712 # - For regional operations, use the
18713 # `regionOperations` resource.
18714 # - For zonal operations, use
18715 # the `zoneOperations` resource.
18716 #
18717 #
18718 #
18719 # For more information, read
18720 # Global, Regional, and Zonal Resources.
18721 #
18722 # Note that completed Operation resources have a limited
18723 # retention period.
18724 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
18725 # Not present otherwise.
18726 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
18727 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
18728 # set when the operation is created.
18729 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
18730 # text format.
18731 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
18732 # this field will be populated.
18733 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
18734 # operation.
18735 {
18736 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
18737 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
18738 # details. There is a set of defined message types to use for providing
18739 # details.The syntax depends on the error code. For example,
18740 # QuotaExceededInfo will have details when the error code is
18741 # QUOTA_EXCEEDED.
18742 {
18743 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
18744 #
18745 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
18746 # is not enabled:
18747 #
18748 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
18749 # &quot;domain&quot;: &quot;googleapis.com&quot;
18750 # &quot;metadata&quot;: {
18751 # &quot;resource&quot;: &quot;projects/123&quot;,
18752 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
18753 # }
18754 # }
18755 #
18756 # This response indicates that the pubsub.googleapis.com API is not enabled.
18757 #
18758 # Example of an error that is returned when attempting to create a Spanner
18759 # instance in a region that is out of stock:
18760 #
18761 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
18762 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
18763 # &quot;metadata&quot;: {
18764 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
18765 # }
18766 # }
18767 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
18768 # is typically the registered service name of the tool or product that
18769 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
18770 # generated by some common infrastructure, the error domain must be a
18771 # globally unique value that identifies the infrastructure. For Google API
18772 # infrastructure, the error domain is &quot;googleapis.com&quot;.
18773 &quot;metadatas&quot;: { # Additional structured details about this error.
18774 #
18775 # Keys must match a regular expression of `a-z+` but should
18776 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
18777 # length. When identifying the current value of an exceeded limit, the units
18778 # should be contained in the key, not the value. For example, rather than
18779 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
18780 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
18781 # instances that can be created in a single (batch) request.
18782 &quot;a_key&quot;: &quot;A String&quot;,
18783 },
18784 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
18785 # proximate cause of the error. Error reasons are unique within a particular
18786 # domain of errors. This should be at most 63 characters and match a
18787 # regular expression of `A-Z+[A-Z0-9]`, which represents
18788 # UPPER_SNAKE_CASE.
18789 },
18790 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
18791 #
18792 # For example, if a quota check failed with an error indicating the calling
18793 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
18794 # directly to the right place in the developer console to flip the bit.
18795 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18796 { # Describes a URL link.
18797 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18798 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18799 },
18800 ],
18801 },
18802 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18803 # which can be attached to an RPC error.
18804 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18805 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18806 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18807 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18808 },
18809 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18810 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18811 &quot;a_key&quot;: &quot;A String&quot;,
18812 },
18813 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18814 # type or metric.
18815 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18816 # or metric.
18817 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18818 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18819 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18820 },
18821 },
18822 ],
18823 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18824 # This property is optional.
18825 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18826 },
18827 ],
18828 },
18829 &quot;getVersionOperationMetadata&quot;: {
18830 &quot;inlineSbomInfo&quot;: {
18831 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
18832 # appropriate identifiers.
18833 &quot;a_key&quot;: &quot;A String&quot;,
18834 },
18835 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
18836 # identifiers.
18837 &quot;a_key&quot;: &quot;A String&quot;,
18838 },
18839 },
18840 },
18841 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
18842 # message that was returned, such as `NOT FOUND`.
18843 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
18844 # status code that was returned. For example, a `404` means the
18845 # resource was not found.
18846 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
18847 # defined by the server.
18848 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
18849 # This value is inRFC3339
18850 # text format.
18851 &quot;instancesBulkInsertOperationMetadata&quot;: {
18852 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
18853 # Example key: zones/us-central1-a
18854 &quot;a_key&quot;: {
18855 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
18856 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
18857 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
18858 # error.
18859 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
18860 # if the flow is rolling forward or rolling back.
18861 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
18862 },
18863 },
18864 },
18865 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
18866 # Operation resources.
18867 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
18868 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
18869 # group of operations results from a `bulkInsert` API request.
18870 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
18871 # `update`, or `delete`, and so on.
18872 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
18873 # There is no requirement that this be linear or support any granularity of
18874 # operations. This should not be used to guess when the operation will be
18875 # complete. This number should monotonically increase as the operation
18876 # progresses.
18877 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
18878 # applicable when performing regional operations.
18879 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
18880 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
18881 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
18882 # this field will contain information on all underlying zonal actions and
18883 # their state.
18884 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
18885 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
18886 # Example key: zones/us-central1-a
18887 &quot;a_key&quot;: {
18888 &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
18889 # populated.
18890 # different programming environments, including REST APIs and RPC APIs. It is
18891 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
18892 # three pieces of data: error code, error message, and error details.
18893 #
18894 # You can find out more about this error model and how to work with it in the
18895 # [API Design Guide](https://cloud.google.com/apis/design/errors).
18896 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
18897 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
18898 # message types for APIs to use.
18899 {
18900 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
18901 },
18902 ],
18903 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
18904 # user-facing error message should be localized and sent in the
18905 # google.rpc.Status.details field, or localized by the client.
18906 },
18907 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
18908 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
18909 },
18910 },
18911 },
18912 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
18913 # This value is inRFC3339
18914 # text format.
18915 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
18916 # following:
18917 # `PENDING`, `RUNNING`, or `DONE`.
18918 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
18919 # operation.
18920 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
18921 # of the target resource.
18922 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
18923 # operations related to creating a snapshot, this points to the disk
18924 # that the snapshot was created from.
18925 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
18926 # `[email protected]` or
18927 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
18928 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
18929 # operation, this field will be populated.
18930 {
18931 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
18932 # Engine returns NO_RESULTS_ON_PAGE if there
18933 # are no results in the response.
18934 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
18935 # value format. For example:
18936 #
18937 # &quot;data&quot;: [
18938 # {
18939 # &quot;key&quot;: &quot;scope&quot;,
18940 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
18941 # }
18942 {
18943 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18944 # returned. For example, for warnings where there are no results in a list
18945 # request for a particular zone, this key might be scope and
18946 # the key value might be the zone name. Other examples might be a key
18947 # indicating a deprecated resource and a suggested replacement, or a
18948 # warning about invalid network settings (for example, if an instance
18949 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18950 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18951 },
18952 ],
18953 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18954 },
18955 ],
18956 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18957 # applicable when performing per-zone operations.
18958 }</pre>
18959 </div>
18960
18961 <div class="method">
18962 <code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
18963 <pre>Sets name of an instance.
18964
18965 Args:
18966 project: string, Project ID for this request. (required)
18967 zone: string, The name of the zone for this request. (required)
18968 instance: string, The instance name for this request. (required)
18969 body: object, The request body.
18970 The object takes the form of:
18971
18972 {
18973 &quot;currentName&quot;: &quot;A String&quot;, # The current name of this resource, used to prevent conflicts. Provide the
18974 # latest name when making a request to change name.
18975 &quot;name&quot;: &quot;A String&quot;, # The name to be applied to the instance. Needs to be RFC 1035 compliant.
18976 }
18977
18978 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18979 that if you must retry your request, the server will know to ignore the
18980 request if it has already been completed.
18981
18982 For example, consider a situation where you make an initial request and
18983 the request times out. If you make the request again with the same
18984 request ID, the server can check if original operation with the same
18985 request ID was received, and if so, will ignore the second request. This
18986 prevents clients from accidentally creating duplicate commitments.
18987
18988 The request ID must be
18989 a valid UUID with the exception that zero UUID is not supported
18990 (00000000-0000-0000-0000-000000000000).
18991 x__xgafv: string, V1 error format.
18992 Allowed values
18993 1 - v1 error format
18994 2 - v2 error format
18995
18996 Returns:
18997 An object of the form:
18998
18999 { # Represents an Operation resource.
19000 #
19001 # Google Compute Engine has three Operation resources:
19002 #
19003 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
19004 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
19005 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
19006 #
19007 # You can use an operation resource to manage asynchronous API requests.
19008 # For more information, readHandling
19009 # API responses.
19010 #
19011 # Operations can be global, regional or zonal.
19012 #
19013 # - For global operations, use the `globalOperations`
19014 # resource.
19015 # - For regional operations, use the
19016 # `regionOperations` resource.
19017 # - For zonal operations, use
19018 # the `zoneOperations` resource.
19019 #
19020 #
19021 #
19022 # For more information, read
19023 # Global, Regional, and Zonal Resources.
19024 #
19025 # Note that completed Operation resources have a limited
19026 # retention period.
19027 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
19028 # Not present otherwise.
19029 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
19030 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
19031 # set when the operation is created.
19032 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
19033 # text format.
19034 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
19035 # this field will be populated.
19036 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
19037 # operation.
19038 {
19039 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
19040 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
19041 # details. There is a set of defined message types to use for providing
19042 # details.The syntax depends on the error code. For example,
19043 # QuotaExceededInfo will have details when the error code is
19044 # QUOTA_EXCEEDED.
19045 {
19046 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
19047 #
19048 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
19049 # is not enabled:
19050 #
19051 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
19052 # &quot;domain&quot;: &quot;googleapis.com&quot;
19053 # &quot;metadata&quot;: {
19054 # &quot;resource&quot;: &quot;projects/123&quot;,
19055 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
19056 # }
19057 # }
19058 #
19059 # This response indicates that the pubsub.googleapis.com API is not enabled.
19060 #
19061 # Example of an error that is returned when attempting to create a Spanner
19062 # instance in a region that is out of stock:
19063 #
19064 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
19065 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
19066 # &quot;metadata&quot;: {
19067 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
19068 # }
19069 # }
19070 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
19071 # is typically the registered service name of the tool or product that
19072 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
19073 # generated by some common infrastructure, the error domain must be a
19074 # globally unique value that identifies the infrastructure. For Google API
19075 # infrastructure, the error domain is &quot;googleapis.com&quot;.
19076 &quot;metadatas&quot;: { # Additional structured details about this error.
19077 #
19078 # Keys must match a regular expression of `a-z+` but should
19079 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
19080 # length. When identifying the current value of an exceeded limit, the units
19081 # should be contained in the key, not the value. For example, rather than
19082 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
19083 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
19084 # instances that can be created in a single (batch) request.
19085 &quot;a_key&quot;: &quot;A String&quot;,
19086 },
19087 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
19088 # proximate cause of the error. Error reasons are unique within a particular
19089 # domain of errors. This should be at most 63 characters and match a
19090 # regular expression of `A-Z+[A-Z0-9]`, which represents
19091 # UPPER_SNAKE_CASE.
19092 },
19093 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
19094 #
19095 # For example, if a quota check failed with an error indicating the calling
19096 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
19097 # directly to the right place in the developer console to flip the bit.
19098 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
19099 { # Describes a URL link.
19100 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
19101 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
19102 },
19103 ],
19104 },
19105 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
19106 # which can be attached to an RPC error.
19107 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
19108 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
19109 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
19110 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
19111 },
19112 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
19113 &quot;dimensions&quot;: { # The map holding related quota dimensions.
19114 &quot;a_key&quot;: &quot;A String&quot;,
19115 },
19116 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
19117 # type or metric.
19118 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
19119 # or metric.
19120 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
19121 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
19122 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
19123 },
19124 },
19125 ],
19126 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
19127 # This property is optional.
19128 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
19129 },
19130 ],
19131 },
19132 &quot;getVersionOperationMetadata&quot;: {
19133 &quot;inlineSbomInfo&quot;: {
19134 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
19135 # appropriate identifiers.
19136 &quot;a_key&quot;: &quot;A String&quot;,
19137 },
19138 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
19139 # identifiers.
19140 &quot;a_key&quot;: &quot;A String&quot;,
19141 },
19142 },
19143 },
19144 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
19145 # message that was returned, such as `NOT FOUND`.
19146 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
19147 # status code that was returned. For example, a `404` means the
19148 # resource was not found.
19149 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
19150 # defined by the server.
19151 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
19152 # This value is inRFC3339
19153 # text format.
19154 &quot;instancesBulkInsertOperationMetadata&quot;: {
19155 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
19156 # Example key: zones/us-central1-a
19157 &quot;a_key&quot;: {
19158 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
19159 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
19160 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
19161 # error.
19162 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
19163 # if the flow is rolling forward or rolling back.
19164 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
19165 },
19166 },
19167 },
19168 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
19169 # Operation resources.
19170 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
19171 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
19172 # group of operations results from a `bulkInsert` API request.
19173 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
19174 # `update`, or `delete`, and so on.
19175 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
19176 # There is no requirement that this be linear or support any granularity of
19177 # operations. This should not be used to guess when the operation will be
19178 # complete. This number should monotonically increase as the operation
19179 # progresses.
19180 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
19181 # applicable when performing regional operations.
19182 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
19183 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
19184 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
19185 # this field will contain information on all underlying zonal actions and
19186 # their state.
19187 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
19188 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
19189 # Example key: zones/us-central1-a
19190 &quot;a_key&quot;: {
19191 &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
19192 # populated.
19193 # different programming environments, including REST APIs and RPC APIs. It is
19194 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
19195 # three pieces of data: error code, error message, and error details.
19196 #
19197 # You can find out more about this error model and how to work with it in the
19198 # [API Design Guide](https://cloud.google.com/apis/design/errors).
19199 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
19200 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
19201 # message types for APIs to use.
19202 {
19203 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
19204 },
19205 ],
19206 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
19207 # user-facing error message should be localized and sent in the
19208 # google.rpc.Status.details field, or localized by the client.
19209 },
19210 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
19211 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
19212 },
19213 },
19214 },
19215 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
19216 # This value is inRFC3339
19217 # text format.
19218 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
19219 # following:
19220 # `PENDING`, `RUNNING`, or `DONE`.
19221 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
19222 # operation.
19223 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
19224 # of the target resource.
19225 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
19226 # operations related to creating a snapshot, this points to the disk
19227 # that the snapshot was created from.
19228 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
19229 # `[email protected]` or
19230 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
19231 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
19232 # operation, this field will be populated.
19233 {
19234 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
19235 # Engine returns NO_RESULTS_ON_PAGE if there
19236 # are no results in the response.
19237 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
19238 # value format. For example:
19239 #
19240 # &quot;data&quot;: [
19241 # {
19242 # &quot;key&quot;: &quot;scope&quot;,
19243 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
19244 # }
19245 {
19246 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
19247 # returned. For example, for warnings where there are no results in a list
19248 # request for a particular zone, this key might be scope and
19249 # the key value might be the zone name. Other examples might be a key
19250 # indicating a deprecated resource and a suggested replacement, or a
19251 # warning about invalid network settings (for example, if an instance
19252 # attempts to perform IP forwarding but is not enabled for IP forwarding).
19253 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
19254 },
19255 ],
19256 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
19257 },
19258 ],
19259 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
19260 # applicable when performing per-zone operations.
19261 }</pre>
19262 </div>
19263
19264 <div class="method">
19265 <code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
19266 <pre>Sets an instance&#x27;s scheduling options. You can only call this method on astopped instance,
19267 that is, a VM instance that is in a `TERMINATED` state. SeeInstance Life
19268 Cycle for more information on the possible instance states.
19269 For more information about setting scheduling options for a VM, seeSet
19270 VM host maintenance policy.
19271
19272 Args:
19273 project: string, Project ID for this request. (required)
19274 zone: string, The name of the zone for this request. (required)
19275 instance: string, Instance name for this request. (required)
19276 body: object, The request body.
19277 The object takes the form of:
19278
19279 { # Sets the scheduling options for an Instance.
19280 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
19281 # terminated by Compute Engine (not terminated by a user). You can only set
19282 # the automatic restart option for standard instances.Preemptible instances
19283 # cannot be automatically restarted.
19284 #
19285 # By default, this is set to true so an instance is
19286 # automatically restarted if it is terminated by Compute Engine.
19287 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
19288 # must be a number between 1 and the number of availability domains
19289 # specified in the spread placement policy attached to the instance.
19290 &quot;currentCpus&quot;: 42, # Current number of vCPUs available for VM.
19291 # 0 or unset means default vCPUs of the current machine type.
19292 &quot;currentMemoryMb&quot;: &quot;A String&quot;, # Current amount of memory (in MB) available for VM.
19293 # 0 or unset means default amount of memory of the current machine type.
19294 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
19295 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
19296 &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
19297 # graceful shutdown isn&#x27;t complete after this time, then the instance
19298 # transitions to the STOPPING state.
19299 # as a count of seconds and fractions of seconds at nanosecond
19300 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
19301 # or &quot;month&quot;. Range is approximately 10,000 years.
19302 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
19303 # Durations less than one second are represented with a 0
19304 # `seconds` field and a positive `nanos` field. Must be from 0
19305 # to 999,999,999 inclusive.
19306 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
19307 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
19308 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
19309 },
19310 },
19311 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
19312 # within the range of [90, 330] with the increment of 30, if unset, the
19313 # default behavior of host error recovery will be used.
19314 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
19315 &quot;latencyTolerant&quot;: True or False, # Defines whether the instance is tolerant of higher cpu latency. This can
19316 # only be set during instance creation, or when the instance is not currently
19317 # running. It must not be set if thepreemptible option is
19318 # also set.
19319 &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
19320 # recovery of the Local Ssd state is attempted. Its value should be in
19321 # between 0 and 168 hours with hour granularity and the default value being 1
19322 # hour.
19323 # as a count of seconds and fractions of seconds at nanosecond
19324 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
19325 # or &quot;month&quot;. Range is approximately 10,000 years.
19326 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
19327 # Durations less than one second are represented with a 0
19328 # `seconds` field and a positive `nanos` field. Must be from 0
19329 # to 999,999,999 inclusive.
19330 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
19331 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
19332 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
19333 },
19334 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
19335 # resources.
19336 # This field is for use by internal tools that use the public API.
19337 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
19338 # be scheduled for maintenance.
19339 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
19340 # are: `PERIODIC`.
19341 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
19342 # the instance termination action will be performed at the end of the run
19343 # duration.
19344 # as a count of seconds and fractions of seconds at nanosecond
19345 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
19346 # or &quot;month&quot;. Range is approximately 10,000 years.
19347 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
19348 # Durations less than one second are represented with a 0
19349 # `seconds` field and a positive `nanos` field. Must be from 0
19350 # to 999,999,999 inclusive.
19351 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
19352 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
19353 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
19354 },
19355 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
19356 # on a sole-tenant node.
19357 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
19358 # affinity for more information.
19359 # Overrides reservationAffinity.
19360 { # Node Affinity: the configuration of desired nodes onto which this Instance
19361 # could be scheduled.
19362 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
19363 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
19364 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
19365 &quot;A String&quot;,
19366 ],
19367 },
19368 ],
19369 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
19370 # the default behavior is MIGRATE. Forpreemptible instances,
19371 # the default and only possible behavior is TERMINATE. For more
19372 # information, see
19373 # Set
19374 # VM host maintenance policy.
19375 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
19376 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
19377 # else, the Local SSD data will be preserved when the instance is stopped
19378 # at the end of the run duration/termination time.
19379 },
19380 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
19381 # instance creation or while the instance isstopped and
19382 # therefore, in a `TERMINATED` state. SeeInstance Life
19383 # Cycle for more information on the possible instance states.
19384 &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
19385 # Off signal is triggered for Spot
19386 # VMs only. If not specified, there will be no wait before the G2 Soft
19387 # Off signal is triggered.
19388 # as a count of seconds and fractions of seconds at nanosecond
19389 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
19390 # or &quot;month&quot;. Range is approximately 10,000 years.
19391 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
19392 # Durations less than one second are represented with a 0
19393 # `seconds` field and a positive `nanos` field. Must be from 0
19394 # to 999,999,999 inclusive.
19395 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
19396 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
19397 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
19398 },
19399 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
19400 &quot;shutdownTimeout&quot;: { # A Duration represents a fixed-length span of time represented # DEPRECATED: please use skipGuestOsShutdown.
19401 # Timeout between GCE ACPI G2 Soft
19402 # Off and ACPI G3 Mechanical
19403 # Off during shutdown operation of VM.
19404 #
19405 # For Standard VMs values between 0s and 120s are allowed. For Spot and
19406 # Preemptible VMs supported values are between 0s and 30s.
19407 #
19408 # If no value is specified for shutdownDuration, default values are 90s for
19409 # Standard VMs and 30s for Spot/Preemptible VMs.
19410 # as a count of seconds and fractions of seconds at nanosecond
19411 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
19412 # or &quot;month&quot;. Range is approximately 10,000 years.
19413 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
19414 # Durations less than one second are represented with a 0
19415 # `seconds` field and a positive `nanos` field. Must be from 0
19416 # to 999,999,999 inclusive.
19417 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
19418 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
19419 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
19420 },
19421 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
19422 # Off and ACPI G3 Mechanical
19423 # Off for Standard VMs and 30 seconds for Spot VMs.
19424 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
19425 # termination action will be performed at the termination time.
19426 &quot;vsockMode&quot;: { # Message to control the enablement of the vsock device. # The vsock mode of the instance.
19427 &quot;mode&quot;: &quot;A String&quot;,
19428 },
19429 &quot;windowsLicenseOptimizationMode&quot;: &quot;A String&quot;, # Represents the Windows Server License Optimization Mode of the VM. If
19430 # unspecified, the default mode is `OFF`.
19431 }
19432
19433 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
19434 that if you must retry your request, the server will know to ignore the
19435 request if it has already been completed.
19436
19437 For example, consider a situation where you make an initial request and
19438 the request times out. If you make the request again with the same
19439 request ID, the server can check if original operation with the same
19440 request ID was received, and if so, will ignore the second request. This
19441 prevents clients from accidentally creating duplicate commitments.
19442
19443 The request ID must be
19444 a valid UUID with the exception that zero UUID is not supported
19445 (00000000-0000-0000-0000-000000000000).
19446 x__xgafv: string, V1 error format.
19447 Allowed values
19448 1 - v1 error format
19449 2 - v2 error format
19450
19451 Returns:
19452 An object of the form:
19453
19454 { # Represents an Operation resource.
19455 #
19456 # Google Compute Engine has three Operation resources:
19457 #
19458 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
19459 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
19460 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
19461 #
19462 # You can use an operation resource to manage asynchronous API requests.
19463 # For more information, readHandling
19464 # API responses.
19465 #
19466 # Operations can be global, regional or zonal.
19467 #
19468 # - For global operations, use the `globalOperations`
19469 # resource.
19470 # - For regional operations, use the
19471 # `regionOperations` resource.
19472 # - For zonal operations, use
19473 # the `zoneOperations` resource.
19474 #
19475 #
19476 #
19477 # For more information, read
19478 # Global, Regional, and Zonal Resources.
19479 #
19480 # Note that completed Operation resources have a limited
19481 # retention period.
19482 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
19483 # Not present otherwise.
19484 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
19485 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
19486 # set when the operation is created.
19487 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
19488 # text format.
19489 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
19490 # this field will be populated.
19491 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
19492 # operation.
19493 {
19494 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
19495 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
19496 # details. There is a set of defined message types to use for providing
19497 # details.The syntax depends on the error code. For example,
19498 # QuotaExceededInfo will have details when the error code is
19499 # QUOTA_EXCEEDED.
19500 {
19501 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
19502 #
19503 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
19504 # is not enabled:
19505 #
19506 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
19507 # &quot;domain&quot;: &quot;googleapis.com&quot;
19508 # &quot;metadata&quot;: {
19509 # &quot;resource&quot;: &quot;projects/123&quot;,
19510 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
19511 # }
19512 # }
19513 #
19514 # This response indicates that the pubsub.googleapis.com API is not enabled.
19515 #
19516 # Example of an error that is returned when attempting to create a Spanner
19517 # instance in a region that is out of stock:
19518 #
19519 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
19520 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
19521 # &quot;metadata&quot;: {
19522 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
19523 # }
19524 # }
19525 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
19526 # is typically the registered service name of the tool or product that
19527 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
19528 # generated by some common infrastructure, the error domain must be a
19529 # globally unique value that identifies the infrastructure. For Google API
19530 # infrastructure, the error domain is &quot;googleapis.com&quot;.
19531 &quot;metadatas&quot;: { # Additional structured details about this error.
19532 #
19533 # Keys must match a regular expression of `a-z+` but should
19534 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
19535 # length. When identifying the current value of an exceeded limit, the units
19536 # should be contained in the key, not the value. For example, rather than
19537 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
19538 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
19539 # instances that can be created in a single (batch) request.
19540 &quot;a_key&quot;: &quot;A String&quot;,
19541 },
19542 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
19543 # proximate cause of the error. Error reasons are unique within a particular
19544 # domain of errors. This should be at most 63 characters and match a
19545 # regular expression of `A-Z+[A-Z0-9]`, which represents
19546 # UPPER_SNAKE_CASE.
19547 },
19548 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
19549 #
19550 # For example, if a quota check failed with an error indicating the calling
19551 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
19552 # directly to the right place in the developer console to flip the bit.
19553 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
19554 { # Describes a URL link.
19555 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
19556 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
19557 },
19558 ],
19559 },
19560 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
19561 # which can be attached to an RPC error.
19562 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
19563 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
19564 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
19565 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
19566 },
19567 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
19568 &quot;dimensions&quot;: { # The map holding related quota dimensions.
19569 &quot;a_key&quot;: &quot;A String&quot;,
19570 },
19571 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
19572 # type or metric.
19573 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
19574 # or metric.
19575 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
19576 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
19577 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
19578 },
19579 },
19580 ],
19581 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
19582 # This property is optional.
19583 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
19584 },
19585 ],
19586 },
19587 &quot;getVersionOperationMetadata&quot;: {
19588 &quot;inlineSbomInfo&quot;: {
19589 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
19590 # appropriate identifiers.
19591 &quot;a_key&quot;: &quot;A String&quot;,
19592 },
19593 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
19594 # identifiers.
19595 &quot;a_key&quot;: &quot;A String&quot;,
19596 },
19597 },
19598 },
19599 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
19600 # message that was returned, such as `NOT FOUND`.
19601 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
19602 # status code that was returned. For example, a `404` means the
19603 # resource was not found.
19604 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
19605 # defined by the server.
19606 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
19607 # This value is inRFC3339
19608 # text format.
19609 &quot;instancesBulkInsertOperationMetadata&quot;: {
19610 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
19611 # Example key: zones/us-central1-a
19612 &quot;a_key&quot;: {
19613 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
19614 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
19615 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
19616 # error.
19617 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
19618 # if the flow is rolling forward or rolling back.
19619 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
19620 },
19621 },
19622 },
19623 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
19624 # Operation resources.
19625 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
19626 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
19627 # group of operations results from a `bulkInsert` API request.
19628 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
19629 # `update`, or `delete`, and so on.
19630 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
19631 # There is no requirement that this be linear or support any granularity of
19632 # operations. This should not be used to guess when the operation will be
19633 # complete. This number should monotonically increase as the operation
19634 # progresses.
19635 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
19636 # applicable when performing regional operations.
19637 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
19638 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
19639 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
19640 # this field will contain information on all underlying zonal actions and
19641 # their state.
19642 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
19643 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
19644 # Example key: zones/us-central1-a
19645 &quot;a_key&quot;: {
19646 &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
19647 # populated.
19648 # different programming environments, including REST APIs and RPC APIs. It is
19649 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
19650 # three pieces of data: error code, error message, and error details.
19651 #
19652 # You can find out more about this error model and how to work with it in the
19653 # [API Design Guide](https://cloud.google.com/apis/design/errors).
19654 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
19655 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
19656 # message types for APIs to use.
19657 {
19658 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
19659 },
19660 ],
19661 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
19662 # user-facing error message should be localized and sent in the
19663 # google.rpc.Status.details field, or localized by the client.
19664 },
19665 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
19666 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
19667 },
19668 },
19669 },
19670 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
19671 # This value is inRFC3339
19672 # text format.
19673 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
19674 # following:
19675 # `PENDING`, `RUNNING`, or `DONE`.
19676 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
19677 # operation.
19678 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
19679 # of the target resource.
19680 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
19681 # operations related to creating a snapshot, this points to the disk
19682 # that the snapshot was created from.
19683 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
19684 # `[email protected]` or
19685 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
19686 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
19687 # operation, this field will be populated.
19688 {
19689 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
19690 # Engine returns NO_RESULTS_ON_PAGE if there
19691 # are no results in the response.
19692 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
19693 # value format. For example:
19694 #
19695 # &quot;data&quot;: [
19696 # {
19697 # &quot;key&quot;: &quot;scope&quot;,
19698 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
19699 # }
19700 {
19701 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
19702 # returned. For example, for warnings where there are no results in a list
19703 # request for a particular zone, this key might be scope and
19704 # the key value might be the zone name. Other examples might be a key
19705 # indicating a deprecated resource and a suggested replacement, or a
19706 # warning about invalid network settings (for example, if an instance
19707 # attempts to perform IP forwarding but is not enabled for IP forwarding).
19708 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
19709 },
19710 ],
19711 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
19712 },
19713 ],
19714 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
19715 # applicable when performing per-zone operations.
19716 }</pre>
19717 </div>
19718
19719 <div class="method">
19720 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
19721 <pre>Sets the Google Cloud Armor security policy for the specified instance.
19722 For more information, seeGoogle
19723 Cloud Armor Overview
19724
19725 Args:
19726 project: string, Project ID for this request. (required)
19727 zone: string, Name of the zone scoping this request. (required)
19728 instance: string, Name of the Instance resource to which the security policy should be
19729 set. The name should conform to RFC1035. (required)
19730 body: object, The request body.
19731 The object takes the form of:
19732
19733 {
19734 &quot;networkInterfaces&quot;: [ # The network interfaces that the security policy will be applied to. Network
19735 # interfaces use the nicN naming format. You can only set a
19736 # security policy for network interfaces with an access config.
19737 &quot;A String&quot;,
19738 ],
19739 &quot;securityPolicy&quot;: &quot;A String&quot;, # A full or partial URL to a security policy to add to this instance.
19740 # If this field is set to an empty string it will remove the associated
19741 # security policy.
19742 }
19743
19744 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
19745 that if you must retry your request, the server will know to ignore the
19746 request if it has already been completed.
19747
19748 For example, consider a situation where you make an initial request and
19749 the request times out. If you make the request again with the same
19750 request ID, the server can check if original operation with the same
19751 request ID was received, and if so, will ignore the second request. This
19752 prevents clients from accidentally creating duplicate commitments.
19753
19754 The request ID must be
19755 a valid UUID with the exception that zero UUID is not supported
19756 (00000000-0000-0000-0000-000000000000).
19757 x__xgafv: string, V1 error format.
19758 Allowed values
19759 1 - v1 error format
19760 2 - v2 error format
19761
19762 Returns:
19763 An object of the form:
19764
19765 { # Represents an Operation resource.
19766 #
19767 # Google Compute Engine has three Operation resources:
19768 #
19769 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
19770 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
19771 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
19772 #
19773 # You can use an operation resource to manage asynchronous API requests.
19774 # For more information, readHandling
19775 # API responses.
19776 #
19777 # Operations can be global, regional or zonal.
19778 #
19779 # - For global operations, use the `globalOperations`
19780 # resource.
19781 # - For regional operations, use the
19782 # `regionOperations` resource.
19783 # - For zonal operations, use
19784 # the `zoneOperations` resource.
19785 #
19786 #
19787 #
19788 # For more information, read
19789 # Global, Regional, and Zonal Resources.
19790 #
19791 # Note that completed Operation resources have a limited
19792 # retention period.
19793 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
19794 # Not present otherwise.
19795 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
19796 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
19797 # set when the operation is created.
19798 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
19799 # text format.
19800 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
19801 # this field will be populated.
19802 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
19803 # operation.
19804 {
19805 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
19806 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
19807 # details. There is a set of defined message types to use for providing
19808 # details.The syntax depends on the error code. For example,
19809 # QuotaExceededInfo will have details when the error code is
19810 # QUOTA_EXCEEDED.
19811 {
19812 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
19813 #
19814 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
19815 # is not enabled:
19816 #
19817 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
19818 # &quot;domain&quot;: &quot;googleapis.com&quot;
19819 # &quot;metadata&quot;: {
19820 # &quot;resource&quot;: &quot;projects/123&quot;,
19821 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
19822 # }
19823 # }
19824 #
19825 # This response indicates that the pubsub.googleapis.com API is not enabled.
19826 #
19827 # Example of an error that is returned when attempting to create a Spanner
19828 # instance in a region that is out of stock:
19829 #
19830 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
19831 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
19832 # &quot;metadata&quot;: {
19833 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
19834 # }
19835 # }
19836 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
19837 # is typically the registered service name of the tool or product that
19838 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
19839 # generated by some common infrastructure, the error domain must be a
19840 # globally unique value that identifies the infrastructure. For Google API
19841 # infrastructure, the error domain is &quot;googleapis.com&quot;.
19842 &quot;metadatas&quot;: { # Additional structured details about this error.
19843 #
19844 # Keys must match a regular expression of `a-z+` but should
19845 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
19846 # length. When identifying the current value of an exceeded limit, the units
19847 # should be contained in the key, not the value. For example, rather than
19848 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
19849 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
19850 # instances that can be created in a single (batch) request.
19851 &quot;a_key&quot;: &quot;A String&quot;,
19852 },
19853 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
19854 # proximate cause of the error. Error reasons are unique within a particular
19855 # domain of errors. This should be at most 63 characters and match a
19856 # regular expression of `A-Z+[A-Z0-9]`, which represents
19857 # UPPER_SNAKE_CASE.
19858 },
19859 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
19860 #
19861 # For example, if a quota check failed with an error indicating the calling
19862 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
19863 # directly to the right place in the developer console to flip the bit.
19864 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
19865 { # Describes a URL link.
19866 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
19867 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
19868 },
19869 ],
19870 },
19871 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
19872 # which can be attached to an RPC error.
19873 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
19874 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
19875 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
19876 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
19877 },
19878 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
19879 &quot;dimensions&quot;: { # The map holding related quota dimensions.
19880 &quot;a_key&quot;: &quot;A String&quot;,
19881 },
19882 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
19883 # type or metric.
19884 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
19885 # or metric.
19886 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
19887 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
19888 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
19889 },
19890 },
19891 ],
19892 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
19893 # This property is optional.
19894 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
19895 },
19896 ],
19897 },
19898 &quot;getVersionOperationMetadata&quot;: {
19899 &quot;inlineSbomInfo&quot;: {
19900 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
19901 # appropriate identifiers.
19902 &quot;a_key&quot;: &quot;A String&quot;,
19903 },
19904 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
19905 # identifiers.
19906 &quot;a_key&quot;: &quot;A String&quot;,
19907 },
19908 },
19909 },
19910 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
19911 # message that was returned, such as `NOT FOUND`.
19912 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
19913 # status code that was returned. For example, a `404` means the
19914 # resource was not found.
19915 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
19916 # defined by the server.
19917 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
19918 # This value is inRFC3339
19919 # text format.
19920 &quot;instancesBulkInsertOperationMetadata&quot;: {
19921 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
19922 # Example key: zones/us-central1-a
19923 &quot;a_key&quot;: {
19924 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
19925 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
19926 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
19927 # error.
19928 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
19929 # if the flow is rolling forward or rolling back.
19930 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
19931 },
19932 },
19933 },
19934 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
19935 # Operation resources.
19936 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
19937 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
19938 # group of operations results from a `bulkInsert` API request.
19939 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
19940 # `update`, or `delete`, and so on.
19941 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
19942 # There is no requirement that this be linear or support any granularity of
19943 # operations. This should not be used to guess when the operation will be
19944 # complete. This number should monotonically increase as the operation
19945 # progresses.
19946 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
19947 # applicable when performing regional operations.
19948 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
19949 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
19950 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
19951 # this field will contain information on all underlying zonal actions and
19952 # their state.
19953 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
19954 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
19955 # Example key: zones/us-central1-a
19956 &quot;a_key&quot;: {
19957 &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
19958 # populated.
19959 # different programming environments, including REST APIs and RPC APIs. It is
19960 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
19961 # three pieces of data: error code, error message, and error details.
19962 #
19963 # You can find out more about this error model and how to work with it in the
19964 # [API Design Guide](https://cloud.google.com/apis/design/errors).
19965 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
19966 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
19967 # message types for APIs to use.
19968 {
19969 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
19970 },
19971 ],
19972 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
19973 # user-facing error message should be localized and sent in the
19974 # google.rpc.Status.details field, or localized by the client.
19975 },
19976 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
19977 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
19978 },
19979 },
19980 },
19981 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
19982 # This value is inRFC3339
19983 # text format.
19984 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
19985 # following:
19986 # `PENDING`, `RUNNING`, or `DONE`.
19987 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
19988 # operation.
19989 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
19990 # of the target resource.
19991 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
19992 # operations related to creating a snapshot, this points to the disk
19993 # that the snapshot was created from.
19994 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
19995 # `[email protected]` or
19996 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
19997 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
19998 # operation, this field will be populated.
19999 {
20000 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
20001 # Engine returns NO_RESULTS_ON_PAGE if there
20002 # are no results in the response.
20003 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
20004 # value format. For example:
20005 #
20006 # &quot;data&quot;: [
20007 # {
20008 # &quot;key&quot;: &quot;scope&quot;,
20009 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
20010 # }
20011 {
20012 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
20013 # returned. For example, for warnings where there are no results in a list
20014 # request for a particular zone, this key might be scope and
20015 # the key value might be the zone name. Other examples might be a key
20016 # indicating a deprecated resource and a suggested replacement, or a
20017 # warning about invalid network settings (for example, if an instance
20018 # attempts to perform IP forwarding but is not enabled for IP forwarding).
20019 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
20020 },
20021 ],
20022 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
20023 },
20024 ],
20025 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
20026 # applicable when performing per-zone operations.
20027 }</pre>
20028 </div>
20029
20030 <div class="method">
20031 <code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
20032 <pre>Sets the service account on the instance. For more information,
20033 readChanging
20034 the service account and access scopes for an instance.
20035
20036 Args:
20037 project: string, Project ID for this request. (required)
20038 zone: string, The name of the zone for this request. (required)
20039 instance: string, Name of the instance resource to start. (required)
20040 body: object, The request body.
20041 The object takes the form of:
20042
20043 {
20044 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
20045 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
20046 &quot;A String&quot;,
20047 ],
20048 }
20049
20050 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
20051 that if you must retry your request, the server will know to ignore the
20052 request if it has already been completed.
20053
20054 For example, consider a situation where you make an initial request and
20055 the request times out. If you make the request again with the same
20056 request ID, the server can check if original operation with the same
20057 request ID was received, and if so, will ignore the second request. This
20058 prevents clients from accidentally creating duplicate commitments.
20059
20060 The request ID must be
20061 a valid UUID with the exception that zero UUID is not supported
20062 (00000000-0000-0000-0000-000000000000).
20063 x__xgafv: string, V1 error format.
20064 Allowed values
20065 1 - v1 error format
20066 2 - v2 error format
20067
20068 Returns:
20069 An object of the form:
20070
20071 { # Represents an Operation resource.
20072 #
20073 # Google Compute Engine has three Operation resources:
20074 #
20075 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
20076 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
20077 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
20078 #
20079 # You can use an operation resource to manage asynchronous API requests.
20080 # For more information, readHandling
20081 # API responses.
20082 #
20083 # Operations can be global, regional or zonal.
20084 #
20085 # - For global operations, use the `globalOperations`
20086 # resource.
20087 # - For regional operations, use the
20088 # `regionOperations` resource.
20089 # - For zonal operations, use
20090 # the `zoneOperations` resource.
20091 #
20092 #
20093 #
20094 # For more information, read
20095 # Global, Regional, and Zonal Resources.
20096 #
20097 # Note that completed Operation resources have a limited
20098 # retention period.
20099 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
20100 # Not present otherwise.
20101 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
20102 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
20103 # set when the operation is created.
20104 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
20105 # text format.
20106 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
20107 # this field will be populated.
20108 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
20109 # operation.
20110 {
20111 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
20112 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
20113 # details. There is a set of defined message types to use for providing
20114 # details.The syntax depends on the error code. For example,
20115 # QuotaExceededInfo will have details when the error code is
20116 # QUOTA_EXCEEDED.
20117 {
20118 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
20119 #
20120 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
20121 # is not enabled:
20122 #
20123 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
20124 # &quot;domain&quot;: &quot;googleapis.com&quot;
20125 # &quot;metadata&quot;: {
20126 # &quot;resource&quot;: &quot;projects/123&quot;,
20127 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
20128 # }
20129 # }
20130 #
20131 # This response indicates that the pubsub.googleapis.com API is not enabled.
20132 #
20133 # Example of an error that is returned when attempting to create a Spanner
20134 # instance in a region that is out of stock:
20135 #
20136 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
20137 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
20138 # &quot;metadata&quot;: {
20139 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
20140 # }
20141 # }
20142 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
20143 # is typically the registered service name of the tool or product that
20144 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
20145 # generated by some common infrastructure, the error domain must be a
20146 # globally unique value that identifies the infrastructure. For Google API
20147 # infrastructure, the error domain is &quot;googleapis.com&quot;.
20148 &quot;metadatas&quot;: { # Additional structured details about this error.
20149 #
20150 # Keys must match a regular expression of `a-z+` but should
20151 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
20152 # length. When identifying the current value of an exceeded limit, the units
20153 # should be contained in the key, not the value. For example, rather than
20154 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
20155 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
20156 # instances that can be created in a single (batch) request.
20157 &quot;a_key&quot;: &quot;A String&quot;,
20158 },
20159 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
20160 # proximate cause of the error. Error reasons are unique within a particular
20161 # domain of errors. This should be at most 63 characters and match a
20162 # regular expression of `A-Z+[A-Z0-9]`, which represents
20163 # UPPER_SNAKE_CASE.
20164 },
20165 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
20166 #
20167 # For example, if a quota check failed with an error indicating the calling
20168 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
20169 # directly to the right place in the developer console to flip the bit.
20170 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
20171 { # Describes a URL link.
20172 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
20173 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
20174 },
20175 ],
20176 },
20177 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
20178 # which can be attached to an RPC error.
20179 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
20180 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
20181 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
20182 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
20183 },
20184 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
20185 &quot;dimensions&quot;: { # The map holding related quota dimensions.
20186 &quot;a_key&quot;: &quot;A String&quot;,
20187 },
20188 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
20189 # type or metric.
20190 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
20191 # or metric.
20192 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
20193 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
20194 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
20195 },
20196 },
20197 ],
20198 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
20199 # This property is optional.
20200 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
20201 },
20202 ],
20203 },
20204 &quot;getVersionOperationMetadata&quot;: {
20205 &quot;inlineSbomInfo&quot;: {
20206 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
20207 # appropriate identifiers.
20208 &quot;a_key&quot;: &quot;A String&quot;,
20209 },
20210 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
20211 # identifiers.
20212 &quot;a_key&quot;: &quot;A String&quot;,
20213 },
20214 },
20215 },
20216 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
20217 # message that was returned, such as `NOT FOUND`.
20218 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
20219 # status code that was returned. For example, a `404` means the
20220 # resource was not found.
20221 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
20222 # defined by the server.
20223 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
20224 # This value is inRFC3339
20225 # text format.
20226 &quot;instancesBulkInsertOperationMetadata&quot;: {
20227 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
20228 # Example key: zones/us-central1-a
20229 &quot;a_key&quot;: {
20230 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
20231 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
20232 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
20233 # error.
20234 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
20235 # if the flow is rolling forward or rolling back.
20236 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
20237 },
20238 },
20239 },
20240 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
20241 # Operation resources.
20242 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
20243 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
20244 # group of operations results from a `bulkInsert` API request.
20245 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
20246 # `update`, or `delete`, and so on.
20247 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
20248 # There is no requirement that this be linear or support any granularity of
20249 # operations. This should not be used to guess when the operation will be
20250 # complete. This number should monotonically increase as the operation
20251 # progresses.
20252 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
20253 # applicable when performing regional operations.
20254 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
20255 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
20256 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
20257 # this field will contain information on all underlying zonal actions and
20258 # their state.
20259 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
20260 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
20261 # Example key: zones/us-central1-a
20262 &quot;a_key&quot;: {
20263 &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
20264 # populated.
20265 # different programming environments, including REST APIs and RPC APIs. It is
20266 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
20267 # three pieces of data: error code, error message, and error details.
20268 #
20269 # You can find out more about this error model and how to work with it in the
20270 # [API Design Guide](https://cloud.google.com/apis/design/errors).
20271 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
20272 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
20273 # message types for APIs to use.
20274 {
20275 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
20276 },
20277 ],
20278 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
20279 # user-facing error message should be localized and sent in the
20280 # google.rpc.Status.details field, or localized by the client.
20281 },
20282 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
20283 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
20284 },
20285 },
20286 },
20287 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
20288 # This value is inRFC3339
20289 # text format.
20290 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
20291 # following:
20292 # `PENDING`, `RUNNING`, or `DONE`.
20293 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
20294 # operation.
20295 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
20296 # of the target resource.
20297 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
20298 # operations related to creating a snapshot, this points to the disk
20299 # that the snapshot was created from.
20300 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
20301 # `[email protected]` or
20302 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
20303 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
20304 # operation, this field will be populated.
20305 {
20306 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
20307 # Engine returns NO_RESULTS_ON_PAGE if there
20308 # are no results in the response.
20309 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
20310 # value format. For example:
20311 #
20312 # &quot;data&quot;: [
20313 # {
20314 # &quot;key&quot;: &quot;scope&quot;,
20315 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
20316 # }
20317 {
20318 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
20319 # returned. For example, for warnings where there are no results in a list
20320 # request for a particular zone, this key might be scope and
20321 # the key value might be the zone name. Other examples might be a key
20322 # indicating a deprecated resource and a suggested replacement, or a
20323 # warning about invalid network settings (for example, if an instance
20324 # attempts to perform IP forwarding but is not enabled for IP forwarding).
20325 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
20326 },
20327 ],
20328 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
20329 },
20330 ],
20331 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
20332 # applicable when performing per-zone operations.
20333 }</pre>
20334 </div>
20335
20336 <div class="method">
20337 <code class="details" id="setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
20338 <pre>Sets the Shielded Instance integrity policy for an instance. You can
20339 only use this method on a running instance. This method
20340 supports PATCH semantics and uses the JSON merge
20341 patch format and processing rules.
20342
20343 Args:
20344 project: string, Project ID for this request. (required)
20345 zone: string, The name of the zone for this request. (required)
20346 instance: string, Name or id of the instance scoping this request. (required)
20347 body: object, The request body.
20348 The object takes the form of:
20349
20350 { # The policy describes the baseline against which
20351 # Instance boot integrity is measured.
20352 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
20353 # measurements from the VM instance&#x27;s most recent boot.
20354 }
20355
20356 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
20357 that if you must retry your request, the server will know to ignore the
20358 request if it has already been completed.
20359
20360 For example, consider a situation where you make an initial request and
20361 the request times out. If you make the request again with the same
20362 request ID, the server can check if original operation with the same
20363 request ID was received, and if so, will ignore the second request. This
20364 prevents clients from accidentally creating duplicate commitments.
20365
20366 The request ID must be
20367 a valid UUID with the exception that zero UUID is not supported
20368 (00000000-0000-0000-0000-000000000000).
20369 x__xgafv: string, V1 error format.
20370 Allowed values
20371 1 - v1 error format
20372 2 - v2 error format
20373
20374 Returns:
20375 An object of the form:
20376
20377 { # Represents an Operation resource.
20378 #
20379 # Google Compute Engine has three Operation resources:
20380 #
20381 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
20382 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
20383 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
20384 #
20385 # You can use an operation resource to manage asynchronous API requests.
20386 # For more information, readHandling
20387 # API responses.
20388 #
20389 # Operations can be global, regional or zonal.
20390 #
20391 # - For global operations, use the `globalOperations`
20392 # resource.
20393 # - For regional operations, use the
20394 # `regionOperations` resource.
20395 # - For zonal operations, use
20396 # the `zoneOperations` resource.
20397 #
20398 #
20399 #
20400 # For more information, read
20401 # Global, Regional, and Zonal Resources.
20402 #
20403 # Note that completed Operation resources have a limited
20404 # retention period.
20405 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
20406 # Not present otherwise.
20407 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
20408 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
20409 # set when the operation is created.
20410 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
20411 # text format.
20412 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
20413 # this field will be populated.
20414 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
20415 # operation.
20416 {
20417 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
20418 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
20419 # details. There is a set of defined message types to use for providing
20420 # details.The syntax depends on the error code. For example,
20421 # QuotaExceededInfo will have details when the error code is
20422 # QUOTA_EXCEEDED.
20423 {
20424 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
20425 #
20426 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
20427 # is not enabled:
20428 #
20429 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
20430 # &quot;domain&quot;: &quot;googleapis.com&quot;
20431 # &quot;metadata&quot;: {
20432 # &quot;resource&quot;: &quot;projects/123&quot;,
20433 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
20434 # }
20435 # }
20436 #
20437 # This response indicates that the pubsub.googleapis.com API is not enabled.
20438 #
20439 # Example of an error that is returned when attempting to create a Spanner
20440 # instance in a region that is out of stock:
20441 #
20442 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
20443 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
20444 # &quot;metadata&quot;: {
20445 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
20446 # }
20447 # }
20448 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
20449 # is typically the registered service name of the tool or product that
20450 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
20451 # generated by some common infrastructure, the error domain must be a
20452 # globally unique value that identifies the infrastructure. For Google API
20453 # infrastructure, the error domain is &quot;googleapis.com&quot;.
20454 &quot;metadatas&quot;: { # Additional structured details about this error.
20455 #
20456 # Keys must match a regular expression of `a-z+` but should
20457 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
20458 # length. When identifying the current value of an exceeded limit, the units
20459 # should be contained in the key, not the value. For example, rather than
20460 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
20461 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
20462 # instances that can be created in a single (batch) request.
20463 &quot;a_key&quot;: &quot;A String&quot;,
20464 },
20465 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
20466 # proximate cause of the error. Error reasons are unique within a particular
20467 # domain of errors. This should be at most 63 characters and match a
20468 # regular expression of `A-Z+[A-Z0-9]`, which represents
20469 # UPPER_SNAKE_CASE.
20470 },
20471 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
20472 #
20473 # For example, if a quota check failed with an error indicating the calling
20474 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
20475 # directly to the right place in the developer console to flip the bit.
20476 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
20477 { # Describes a URL link.
20478 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
20479 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
20480 },
20481 ],
20482 },
20483 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
20484 # which can be attached to an RPC error.
20485 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
20486 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
20487 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
20488 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
20489 },
20490 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
20491 &quot;dimensions&quot;: { # The map holding related quota dimensions.
20492 &quot;a_key&quot;: &quot;A String&quot;,
20493 },
20494 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
20495 # type or metric.
20496 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
20497 # or metric.
20498 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
20499 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
20500 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
20501 },
20502 },
20503 ],
20504 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
20505 # This property is optional.
20506 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
20507 },
20508 ],
20509 },
20510 &quot;getVersionOperationMetadata&quot;: {
20511 &quot;inlineSbomInfo&quot;: {
20512 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
20513 # appropriate identifiers.
20514 &quot;a_key&quot;: &quot;A String&quot;,
20515 },
20516 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
20517 # identifiers.
20518 &quot;a_key&quot;: &quot;A String&quot;,
20519 },
20520 },
20521 },
20522 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
20523 # message that was returned, such as `NOT FOUND`.
20524 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
20525 # status code that was returned. For example, a `404` means the
20526 # resource was not found.
20527 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
20528 # defined by the server.
20529 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
20530 # This value is inRFC3339
20531 # text format.
20532 &quot;instancesBulkInsertOperationMetadata&quot;: {
20533 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
20534 # Example key: zones/us-central1-a
20535 &quot;a_key&quot;: {
20536 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
20537 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
20538 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
20539 # error.
20540 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
20541 # if the flow is rolling forward or rolling back.
20542 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
20543 },
20544 },
20545 },
20546 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
20547 # Operation resources.
20548 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
20549 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
20550 # group of operations results from a `bulkInsert` API request.
20551 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
20552 # `update`, or `delete`, and so on.
20553 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
20554 # There is no requirement that this be linear or support any granularity of
20555 # operations. This should not be used to guess when the operation will be
20556 # complete. This number should monotonically increase as the operation
20557 # progresses.
20558 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
20559 # applicable when performing regional operations.
20560 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
20561 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
20562 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
20563 # this field will contain information on all underlying zonal actions and
20564 # their state.
20565 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
20566 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
20567 # Example key: zones/us-central1-a
20568 &quot;a_key&quot;: {
20569 &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
20570 # populated.
20571 # different programming environments, including REST APIs and RPC APIs. It is
20572 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
20573 # three pieces of data: error code, error message, and error details.
20574 #
20575 # You can find out more about this error model and how to work with it in the
20576 # [API Design Guide](https://cloud.google.com/apis/design/errors).
20577 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
20578 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
20579 # message types for APIs to use.
20580 {
20581 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
20582 },
20583 ],
20584 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
20585 # user-facing error message should be localized and sent in the
20586 # google.rpc.Status.details field, or localized by the client.
20587 },
20588 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
20589 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
20590 },
20591 },
20592 },
20593 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
20594 # This value is inRFC3339
20595 # text format.
20596 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
20597 # following:
20598 # `PENDING`, `RUNNING`, or `DONE`.
20599 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
20600 # operation.
20601 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
20602 # of the target resource.
20603 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
20604 # operations related to creating a snapshot, this points to the disk
20605 # that the snapshot was created from.
20606 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
20607 # `[email protected]` or
20608 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
20609 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
20610 # operation, this field will be populated.
20611 {
20612 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
20613 # Engine returns NO_RESULTS_ON_PAGE if there
20614 # are no results in the response.
20615 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
20616 # value format. For example:
20617 #
20618 # &quot;data&quot;: [
20619 # {
20620 # &quot;key&quot;: &quot;scope&quot;,
20621 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
20622 # }
20623 {
20624 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
20625 # returned. For example, for warnings where there are no results in a list
20626 # request for a particular zone, this key might be scope and
20627 # the key value might be the zone name. Other examples might be a key
20628 # indicating a deprecated resource and a suggested replacement, or a
20629 # warning about invalid network settings (for example, if an instance
20630 # attempts to perform IP forwarding but is not enabled for IP forwarding).
20631 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
20632 },
20633 ],
20634 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
20635 },
20636 ],
20637 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
20638 # applicable when performing per-zone operations.
20639 }</pre>
20640 </div>
20641
20642 <div class="method">
20643 <code class="details" id="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
20644 <pre>Sets the Shielded VM integrity policy for a VM instance. You can
20645 only use this method on a running VM instance. This method
20646 supports PATCH semantics and uses the JSON merge
20647 patch format and processing rules.
20648
20649 Args:
20650 project: string, Project ID for this request. (required)
20651 zone: string, The name of the zone for this request. (required)
20652 instance: string, Name of the instance scoping this request. (required)
20653 body: object, The request body.
20654 The object takes the form of:
20655
20656 { # The policy describes the baseline against which
20657 # VM instance boot integrity is measured.
20658 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
20659 # measurements from the VM instance&#x27;s most recent boot.
20660 }
20661
20662 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
20663 that if you must retry your request, the server will know to ignore the
20664 request if it has already been completed.
20665
20666 For example, consider a situation where you make an initial request and
20667 the request times out. If you make the request again with the same
20668 request ID, the server can check if original operation with the same
20669 request ID was received, and if so, will ignore the second request. This
20670 prevents clients from accidentally creating duplicate commitments.
20671
20672 The request ID must be
20673 a valid UUID with the exception that zero UUID is not supported
20674 (00000000-0000-0000-0000-000000000000).
20675 x__xgafv: string, V1 error format.
20676 Allowed values
20677 1 - v1 error format
20678 2 - v2 error format
20679
20680 Returns:
20681 An object of the form:
20682
20683 { # Represents an Operation resource.
20684 #
20685 # Google Compute Engine has three Operation resources:
20686 #
20687 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
20688 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
20689 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
20690 #
20691 # You can use an operation resource to manage asynchronous API requests.
20692 # For more information, readHandling
20693 # API responses.
20694 #
20695 # Operations can be global, regional or zonal.
20696 #
20697 # - For global operations, use the `globalOperations`
20698 # resource.
20699 # - For regional operations, use the
20700 # `regionOperations` resource.
20701 # - For zonal operations, use
20702 # the `zoneOperations` resource.
20703 #
20704 #
20705 #
20706 # For more information, read
20707 # Global, Regional, and Zonal Resources.
20708 #
20709 # Note that completed Operation resources have a limited
20710 # retention period.
20711 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
20712 # Not present otherwise.
20713 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
20714 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
20715 # set when the operation is created.
20716 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
20717 # text format.
20718 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
20719 # this field will be populated.
20720 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
20721 # operation.
20722 {
20723 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
20724 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
20725 # details. There is a set of defined message types to use for providing
20726 # details.The syntax depends on the error code. For example,
20727 # QuotaExceededInfo will have details when the error code is
20728 # QUOTA_EXCEEDED.
20729 {
20730 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
20731 #
20732 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
20733 # is not enabled:
20734 #
20735 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
20736 # &quot;domain&quot;: &quot;googleapis.com&quot;
20737 # &quot;metadata&quot;: {
20738 # &quot;resource&quot;: &quot;projects/123&quot;,
20739 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
20740 # }
20741 # }
20742 #
20743 # This response indicates that the pubsub.googleapis.com API is not enabled.
20744 #
20745 # Example of an error that is returned when attempting to create a Spanner
20746 # instance in a region that is out of stock:
20747 #
20748 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
20749 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
20750 # &quot;metadata&quot;: {
20751 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
20752 # }
20753 # }
20754 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
20755 # is typically the registered service name of the tool or product that
20756 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
20757 # generated by some common infrastructure, the error domain must be a
20758 # globally unique value that identifies the infrastructure. For Google API
20759 # infrastructure, the error domain is &quot;googleapis.com&quot;.
20760 &quot;metadatas&quot;: { # Additional structured details about this error.
20761 #
20762 # Keys must match a regular expression of `a-z+` but should
20763 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
20764 # length. When identifying the current value of an exceeded limit, the units
20765 # should be contained in the key, not the value. For example, rather than
20766 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
20767 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
20768 # instances that can be created in a single (batch) request.
20769 &quot;a_key&quot;: &quot;A String&quot;,
20770 },
20771 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
20772 # proximate cause of the error. Error reasons are unique within a particular
20773 # domain of errors. This should be at most 63 characters and match a
20774 # regular expression of `A-Z+[A-Z0-9]`, which represents
20775 # UPPER_SNAKE_CASE.
20776 },
20777 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
20778 #
20779 # For example, if a quota check failed with an error indicating the calling
20780 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
20781 # directly to the right place in the developer console to flip the bit.
20782 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
20783 { # Describes a URL link.
20784 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
20785 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
20786 },
20787 ],
20788 },
20789 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
20790 # which can be attached to an RPC error.
20791 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
20792 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
20793 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
20794 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
20795 },
20796 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
20797 &quot;dimensions&quot;: { # The map holding related quota dimensions.
20798 &quot;a_key&quot;: &quot;A String&quot;,
20799 },
20800 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
20801 # type or metric.
20802 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
20803 # or metric.
20804 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
20805 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
20806 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
20807 },
20808 },
20809 ],
20810 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
20811 # This property is optional.
20812 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
20813 },
20814 ],
20815 },
20816 &quot;getVersionOperationMetadata&quot;: {
20817 &quot;inlineSbomInfo&quot;: {
20818 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
20819 # appropriate identifiers.
20820 &quot;a_key&quot;: &quot;A String&quot;,
20821 },
20822 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
20823 # identifiers.
20824 &quot;a_key&quot;: &quot;A String&quot;,
20825 },
20826 },
20827 },
20828 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
20829 # message that was returned, such as `NOT FOUND`.
20830 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
20831 # status code that was returned. For example, a `404` means the
20832 # resource was not found.
20833 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
20834 # defined by the server.
20835 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
20836 # This value is inRFC3339
20837 # text format.
20838 &quot;instancesBulkInsertOperationMetadata&quot;: {
20839 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
20840 # Example key: zones/us-central1-a
20841 &quot;a_key&quot;: {
20842 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
20843 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
20844 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
20845 # error.
20846 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
20847 # if the flow is rolling forward or rolling back.
20848 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
20849 },
20850 },
20851 },
20852 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
20853 # Operation resources.
20854 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
20855 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
20856 # group of operations results from a `bulkInsert` API request.
20857 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
20858 # `update`, or `delete`, and so on.
20859 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
20860 # There is no requirement that this be linear or support any granularity of
20861 # operations. This should not be used to guess when the operation will be
20862 # complete. This number should monotonically increase as the operation
20863 # progresses.
20864 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
20865 # applicable when performing regional operations.
20866 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
20867 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
20868 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
20869 # this field will contain information on all underlying zonal actions and
20870 # their state.
20871 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
20872 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
20873 # Example key: zones/us-central1-a
20874 &quot;a_key&quot;: {
20875 &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
20876 # populated.
20877 # different programming environments, including REST APIs and RPC APIs. It is
20878 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
20879 # three pieces of data: error code, error message, and error details.
20880 #
20881 # You can find out more about this error model and how to work with it in the
20882 # [API Design Guide](https://cloud.google.com/apis/design/errors).
20883 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
20884 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
20885 # message types for APIs to use.
20886 {
20887 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
20888 },
20889 ],
20890 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
20891 # user-facing error message should be localized and sent in the
20892 # google.rpc.Status.details field, or localized by the client.
20893 },
20894 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
20895 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
20896 },
20897 },
20898 },
20899 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
20900 # This value is inRFC3339
20901 # text format.
20902 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
20903 # following:
20904 # `PENDING`, `RUNNING`, or `DONE`.
20905 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
20906 # operation.
20907 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
20908 # of the target resource.
20909 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
20910 # operations related to creating a snapshot, this points to the disk
20911 # that the snapshot was created from.
20912 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
20913 # `[email protected]` or
20914 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
20915 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
20916 # operation, this field will be populated.
20917 {
20918 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
20919 # Engine returns NO_RESULTS_ON_PAGE if there
20920 # are no results in the response.
20921 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
20922 # value format. For example:
20923 #
20924 # &quot;data&quot;: [
20925 # {
20926 # &quot;key&quot;: &quot;scope&quot;,
20927 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
20928 # }
20929 {
20930 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
20931 # returned. For example, for warnings where there are no results in a list
20932 # request for a particular zone, this key might be scope and
20933 # the key value might be the zone name. Other examples might be a key
20934 # indicating a deprecated resource and a suggested replacement, or a
20935 # warning about invalid network settings (for example, if an instance
20936 # attempts to perform IP forwarding but is not enabled for IP forwarding).
20937 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
20938 },
20939 ],
20940 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
20941 },
20942 ],
20943 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
20944 # applicable when performing per-zone operations.
20945 }</pre>
20946 </div>
20947
20948 <div class="method">
20949 <code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
20950 <pre>Sets network tags
20951 for the specified instance to the data included in the request.
20952
20953 Args:
20954 project: string, Project ID for this request. (required)
20955 zone: string, The name of the zone for this request. (required)
20956 instance: string, Name of the instance scoping this request. (required)
20957 body: object, The request body.
20958 The object takes the form of:
20959
20960 { # A set of instance tags.
20961 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
20962 # the tags&#x27; contents and used for optimistic locking. The
20963 # fingerprint is initially generated by Compute Engine and changes after
20964 # every request to modify or update tags. You must always provide an
20965 # up-to-date fingerprint hash in order to update or change tags.
20966 #
20967 # To see the latest fingerprint, make get() request to the
20968 # instance.
20969 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
20970 # with RFC1035.
20971 &quot;A String&quot;,
20972 ],
20973 }
20974
20975 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
20976 that if you must retry your request, the server will know to ignore the
20977 request if it has already been completed.
20978
20979 For example, consider a situation where you make an initial request and
20980 the request times out. If you make the request again with the same
20981 request ID, the server can check if original operation with the same
20982 request ID was received, and if so, will ignore the second request. This
20983 prevents clients from accidentally creating duplicate commitments.
20984
20985 The request ID must be
20986 a valid UUID with the exception that zero UUID is not supported
20987 (00000000-0000-0000-0000-000000000000).
20988 x__xgafv: string, V1 error format.
20989 Allowed values
20990 1 - v1 error format
20991 2 - v2 error format
20992
20993 Returns:
20994 An object of the form:
20995
20996 { # Represents an Operation resource.
20997 #
20998 # Google Compute Engine has three Operation resources:
20999 #
21000 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
21001 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
21002 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
21003 #
21004 # You can use an operation resource to manage asynchronous API requests.
21005 # For more information, readHandling
21006 # API responses.
21007 #
21008 # Operations can be global, regional or zonal.
21009 #
21010 # - For global operations, use the `globalOperations`
21011 # resource.
21012 # - For regional operations, use the
21013 # `regionOperations` resource.
21014 # - For zonal operations, use
21015 # the `zoneOperations` resource.
21016 #
21017 #
21018 #
21019 # For more information, read
21020 # Global, Regional, and Zonal Resources.
21021 #
21022 # Note that completed Operation resources have a limited
21023 # retention period.
21024 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
21025 # Not present otherwise.
21026 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
21027 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
21028 # set when the operation is created.
21029 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
21030 # text format.
21031 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
21032 # this field will be populated.
21033 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
21034 # operation.
21035 {
21036 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
21037 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
21038 # details. There is a set of defined message types to use for providing
21039 # details.The syntax depends on the error code. For example,
21040 # QuotaExceededInfo will have details when the error code is
21041 # QUOTA_EXCEEDED.
21042 {
21043 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
21044 #
21045 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
21046 # is not enabled:
21047 #
21048 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
21049 # &quot;domain&quot;: &quot;googleapis.com&quot;
21050 # &quot;metadata&quot;: {
21051 # &quot;resource&quot;: &quot;projects/123&quot;,
21052 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
21053 # }
21054 # }
21055 #
21056 # This response indicates that the pubsub.googleapis.com API is not enabled.
21057 #
21058 # Example of an error that is returned when attempting to create a Spanner
21059 # instance in a region that is out of stock:
21060 #
21061 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
21062 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
21063 # &quot;metadata&quot;: {
21064 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
21065 # }
21066 # }
21067 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
21068 # is typically the registered service name of the tool or product that
21069 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
21070 # generated by some common infrastructure, the error domain must be a
21071 # globally unique value that identifies the infrastructure. For Google API
21072 # infrastructure, the error domain is &quot;googleapis.com&quot;.
21073 &quot;metadatas&quot;: { # Additional structured details about this error.
21074 #
21075 # Keys must match a regular expression of `a-z+` but should
21076 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
21077 # length. When identifying the current value of an exceeded limit, the units
21078 # should be contained in the key, not the value. For example, rather than
21079 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
21080 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
21081 # instances that can be created in a single (batch) request.
21082 &quot;a_key&quot;: &quot;A String&quot;,
21083 },
21084 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
21085 # proximate cause of the error. Error reasons are unique within a particular
21086 # domain of errors. This should be at most 63 characters and match a
21087 # regular expression of `A-Z+[A-Z0-9]`, which represents
21088 # UPPER_SNAKE_CASE.
21089 },
21090 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
21091 #
21092 # For example, if a quota check failed with an error indicating the calling
21093 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
21094 # directly to the right place in the developer console to flip the bit.
21095 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
21096 { # Describes a URL link.
21097 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
21098 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
21099 },
21100 ],
21101 },
21102 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
21103 # which can be attached to an RPC error.
21104 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
21105 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
21106 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
21107 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
21108 },
21109 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
21110 &quot;dimensions&quot;: { # The map holding related quota dimensions.
21111 &quot;a_key&quot;: &quot;A String&quot;,
21112 },
21113 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
21114 # type or metric.
21115 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
21116 # or metric.
21117 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
21118 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
21119 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
21120 },
21121 },
21122 ],
21123 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
21124 # This property is optional.
21125 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
21126 },
21127 ],
21128 },
21129 &quot;getVersionOperationMetadata&quot;: {
21130 &quot;inlineSbomInfo&quot;: {
21131 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
21132 # appropriate identifiers.
21133 &quot;a_key&quot;: &quot;A String&quot;,
21134 },
21135 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
21136 # identifiers.
21137 &quot;a_key&quot;: &quot;A String&quot;,
21138 },
21139 },
21140 },
21141 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
21142 # message that was returned, such as `NOT FOUND`.
21143 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
21144 # status code that was returned. For example, a `404` means the
21145 # resource was not found.
21146 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
21147 # defined by the server.
21148 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
21149 # This value is inRFC3339
21150 # text format.
21151 &quot;instancesBulkInsertOperationMetadata&quot;: {
21152 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
21153 # Example key: zones/us-central1-a
21154 &quot;a_key&quot;: {
21155 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
21156 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
21157 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
21158 # error.
21159 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
21160 # if the flow is rolling forward or rolling back.
21161 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
21162 },
21163 },
21164 },
21165 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
21166 # Operation resources.
21167 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
21168 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
21169 # group of operations results from a `bulkInsert` API request.
21170 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
21171 # `update`, or `delete`, and so on.
21172 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
21173 # There is no requirement that this be linear or support any granularity of
21174 # operations. This should not be used to guess when the operation will be
21175 # complete. This number should monotonically increase as the operation
21176 # progresses.
21177 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
21178 # applicable when performing regional operations.
21179 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
21180 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
21181 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
21182 # this field will contain information on all underlying zonal actions and
21183 # their state.
21184 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
21185 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
21186 # Example key: zones/us-central1-a
21187 &quot;a_key&quot;: {
21188 &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
21189 # populated.
21190 # different programming environments, including REST APIs and RPC APIs. It is
21191 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
21192 # three pieces of data: error code, error message, and error details.
21193 #
21194 # You can find out more about this error model and how to work with it in the
21195 # [API Design Guide](https://cloud.google.com/apis/design/errors).
21196 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
21197 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
21198 # message types for APIs to use.
21199 {
21200 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
21201 },
21202 ],
21203 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
21204 # user-facing error message should be localized and sent in the
21205 # google.rpc.Status.details field, or localized by the client.
21206 },
21207 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
21208 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
21209 },
21210 },
21211 },
21212 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
21213 # This value is inRFC3339
21214 # text format.
21215 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
21216 # following:
21217 # `PENDING`, `RUNNING`, or `DONE`.
21218 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
21219 # operation.
21220 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
21221 # of the target resource.
21222 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
21223 # operations related to creating a snapshot, this points to the disk
21224 # that the snapshot was created from.
21225 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
21226 # `[email protected]` or
21227 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
21228 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
21229 # operation, this field will be populated.
21230 {
21231 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
21232 # Engine returns NO_RESULTS_ON_PAGE if there
21233 # are no results in the response.
21234 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
21235 # value format. For example:
21236 #
21237 # &quot;data&quot;: [
21238 # {
21239 # &quot;key&quot;: &quot;scope&quot;,
21240 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
21241 # }
21242 {
21243 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
21244 # returned. For example, for warnings where there are no results in a list
21245 # request for a particular zone, this key might be scope and
21246 # the key value might be the zone name. Other examples might be a key
21247 # indicating a deprecated resource and a suggested replacement, or a
21248 # warning about invalid network settings (for example, if an instance
21249 # attempts to perform IP forwarding but is not enabled for IP forwarding).
21250 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
21251 },
21252 ],
21253 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
21254 },
21255 ],
21256 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
21257 # applicable when performing per-zone operations.
21258 }</pre>
21259 </div>
21260
21261 <div class="method">
21262 <code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, requestId=None, withExtendedNotifications=None, x__xgafv=None)</code>
21263 <pre>Simulates a host maintenance event on a VM. For more information, see
21264 Simulate a host maintenance event.
21265
21266 Args:
21267 project: string, Project ID for this request. (required)
21268 zone: string, The name of the zone for this request. (required)
21269 instance: string, Name of the instance scoping this request. (required)
21270 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
21271 that if you must retry your request, the server will know to ignore the
21272 request if it has already been completed.
21273
21274 For example, consider a situation where you make an initial request and
21275 the request times out. If you make the request again with the same
21276 request ID, the server can check if original operation with the same
21277 request ID was received, and if so, will ignore the second request. This
21278 prevents clients from accidentally creating duplicate commitments.
21279
21280 The request ID must be
21281 a valid UUID with the exception that zero UUID is not supported
21282 (00000000-0000-0000-0000-000000000000).
21283 withExtendedNotifications: boolean, Determines whether the customers receive notifications before migration.
21284 Only applicable to SF vms.
21285 x__xgafv: string, V1 error format.
21286 Allowed values
21287 1 - v1 error format
21288 2 - v2 error format
21289
21290 Returns:
21291 An object of the form:
21292
21293 { # Represents an Operation resource.
21294 #
21295 # Google Compute Engine has three Operation resources:
21296 #
21297 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
21298 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
21299 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
21300 #
21301 # You can use an operation resource to manage asynchronous API requests.
21302 # For more information, readHandling
21303 # API responses.
21304 #
21305 # Operations can be global, regional or zonal.
21306 #
21307 # - For global operations, use the `globalOperations`
21308 # resource.
21309 # - For regional operations, use the
21310 # `regionOperations` resource.
21311 # - For zonal operations, use
21312 # the `zoneOperations` resource.
21313 #
21314 #
21315 #
21316 # For more information, read
21317 # Global, Regional, and Zonal Resources.
21318 #
21319 # Note that completed Operation resources have a limited
21320 # retention period.
21321 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
21322 # Not present otherwise.
21323 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
21324 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
21325 # set when the operation is created.
21326 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
21327 # text format.
21328 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
21329 # this field will be populated.
21330 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
21331 # operation.
21332 {
21333 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
21334 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
21335 # details. There is a set of defined message types to use for providing
21336 # details.The syntax depends on the error code. For example,
21337 # QuotaExceededInfo will have details when the error code is
21338 # QUOTA_EXCEEDED.
21339 {
21340 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
21341 #
21342 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
21343 # is not enabled:
21344 #
21345 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
21346 # &quot;domain&quot;: &quot;googleapis.com&quot;
21347 # &quot;metadata&quot;: {
21348 # &quot;resource&quot;: &quot;projects/123&quot;,
21349 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
21350 # }
21351 # }
21352 #
21353 # This response indicates that the pubsub.googleapis.com API is not enabled.
21354 #
21355 # Example of an error that is returned when attempting to create a Spanner
21356 # instance in a region that is out of stock:
21357 #
21358 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
21359 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
21360 # &quot;metadata&quot;: {
21361 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
21362 # }
21363 # }
21364 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
21365 # is typically the registered service name of the tool or product that
21366 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
21367 # generated by some common infrastructure, the error domain must be a
21368 # globally unique value that identifies the infrastructure. For Google API
21369 # infrastructure, the error domain is &quot;googleapis.com&quot;.
21370 &quot;metadatas&quot;: { # Additional structured details about this error.
21371 #
21372 # Keys must match a regular expression of `a-z+` but should
21373 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
21374 # length. When identifying the current value of an exceeded limit, the units
21375 # should be contained in the key, not the value. For example, rather than
21376 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
21377 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
21378 # instances that can be created in a single (batch) request.
21379 &quot;a_key&quot;: &quot;A String&quot;,
21380 },
21381 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
21382 # proximate cause of the error. Error reasons are unique within a particular
21383 # domain of errors. This should be at most 63 characters and match a
21384 # regular expression of `A-Z+[A-Z0-9]`, which represents
21385 # UPPER_SNAKE_CASE.
21386 },
21387 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
21388 #
21389 # For example, if a quota check failed with an error indicating the calling
21390 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
21391 # directly to the right place in the developer console to flip the bit.
21392 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
21393 { # Describes a URL link.
21394 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
21395 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
21396 },
21397 ],
21398 },
21399 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
21400 # which can be attached to an RPC error.
21401 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
21402 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
21403 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
21404 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
21405 },
21406 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
21407 &quot;dimensions&quot;: { # The map holding related quota dimensions.
21408 &quot;a_key&quot;: &quot;A String&quot;,
21409 },
21410 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
21411 # type or metric.
21412 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
21413 # or metric.
21414 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
21415 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
21416 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
21417 },
21418 },
21419 ],
21420 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
21421 # This property is optional.
21422 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
21423 },
21424 ],
21425 },
21426 &quot;getVersionOperationMetadata&quot;: {
21427 &quot;inlineSbomInfo&quot;: {
21428 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
21429 # appropriate identifiers.
21430 &quot;a_key&quot;: &quot;A String&quot;,
21431 },
21432 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
21433 # identifiers.
21434 &quot;a_key&quot;: &quot;A String&quot;,
21435 },
21436 },
21437 },
21438 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
21439 # message that was returned, such as `NOT FOUND`.
21440 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
21441 # status code that was returned. For example, a `404` means the
21442 # resource was not found.
21443 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
21444 # defined by the server.
21445 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
21446 # This value is inRFC3339
21447 # text format.
21448 &quot;instancesBulkInsertOperationMetadata&quot;: {
21449 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
21450 # Example key: zones/us-central1-a
21451 &quot;a_key&quot;: {
21452 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
21453 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
21454 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
21455 # error.
21456 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
21457 # if the flow is rolling forward or rolling back.
21458 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
21459 },
21460 },
21461 },
21462 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
21463 # Operation resources.
21464 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
21465 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
21466 # group of operations results from a `bulkInsert` API request.
21467 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
21468 # `update`, or `delete`, and so on.
21469 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
21470 # There is no requirement that this be linear or support any granularity of
21471 # operations. This should not be used to guess when the operation will be
21472 # complete. This number should monotonically increase as the operation
21473 # progresses.
21474 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
21475 # applicable when performing regional operations.
21476 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
21477 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
21478 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
21479 # this field will contain information on all underlying zonal actions and
21480 # their state.
21481 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
21482 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
21483 # Example key: zones/us-central1-a
21484 &quot;a_key&quot;: {
21485 &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
21486 # populated.
21487 # different programming environments, including REST APIs and RPC APIs. It is
21488 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
21489 # three pieces of data: error code, error message, and error details.
21490 #
21491 # You can find out more about this error model and how to work with it in the
21492 # [API Design Guide](https://cloud.google.com/apis/design/errors).
21493 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
21494 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
21495 # message types for APIs to use.
21496 {
21497 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
21498 },
21499 ],
21500 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
21501 # user-facing error message should be localized and sent in the
21502 # google.rpc.Status.details field, or localized by the client.
21503 },
21504 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
21505 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
21506 },
21507 },
21508 },
21509 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
21510 # This value is inRFC3339
21511 # text format.
21512 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
21513 # following:
21514 # `PENDING`, `RUNNING`, or `DONE`.
21515 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
21516 # operation.
21517 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
21518 # of the target resource.
21519 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
21520 # operations related to creating a snapshot, this points to the disk
21521 # that the snapshot was created from.
21522 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
21523 # `[email protected]` or
21524 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
21525 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
21526 # operation, this field will be populated.
21527 {
21528 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
21529 # Engine returns NO_RESULTS_ON_PAGE if there
21530 # are no results in the response.
21531 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
21532 # value format. For example:
21533 #
21534 # &quot;data&quot;: [
21535 # {
21536 # &quot;key&quot;: &quot;scope&quot;,
21537 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
21538 # }
21539 {
21540 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
21541 # returned. For example, for warnings where there are no results in a list
21542 # request for a particular zone, this key might be scope and
21543 # the key value might be the zone name. Other examples might be a key
21544 # indicating a deprecated resource and a suggested replacement, or a
21545 # warning about invalid network settings (for example, if an instance
21546 # attempts to perform IP forwarding but is not enabled for IP forwarding).
21547 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
21548 },
21549 ],
21550 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
21551 },
21552 ],
21553 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
21554 # applicable when performing per-zone operations.
21555 }</pre>
21556 </div>
21557
21558 <div class="method">
21559 <code class="details" id="start">start(project, zone, instance, requestId=None, x__xgafv=None)</code>
21560 <pre>Starts an instance that was stopped using theinstances().stop
21561 method. For more information, seeRestart an
21562 instance.
21563
21564 Args:
21565 project: string, Project ID for this request. (required)
21566 zone: string, The name of the zone for this request. (required)
21567 instance: string, Name of the instance resource to start. (required)
21568 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
21569 that if you must retry your request, the server will know to ignore the
21570 request if it has already been completed.
21571
21572 For example, consider a situation where you make an initial request and
21573 the request times out. If you make the request again with the same
21574 request ID, the server can check if original operation with the same
21575 request ID was received, and if so, will ignore the second request. This
21576 prevents clients from accidentally creating duplicate commitments.
21577
21578 The request ID must be
21579 a valid UUID with the exception that zero UUID is not supported
21580 (00000000-0000-0000-0000-000000000000).
21581 x__xgafv: string, V1 error format.
21582 Allowed values
21583 1 - v1 error format
21584 2 - v2 error format
21585
21586 Returns:
21587 An object of the form:
21588
21589 { # Represents an Operation resource.
21590 #
21591 # Google Compute Engine has three Operation resources:
21592 #
21593 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
21594 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
21595 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
21596 #
21597 # You can use an operation resource to manage asynchronous API requests.
21598 # For more information, readHandling
21599 # API responses.
21600 #
21601 # Operations can be global, regional or zonal.
21602 #
21603 # - For global operations, use the `globalOperations`
21604 # resource.
21605 # - For regional operations, use the
21606 # `regionOperations` resource.
21607 # - For zonal operations, use
21608 # the `zoneOperations` resource.
21609 #
21610 #
21611 #
21612 # For more information, read
21613 # Global, Regional, and Zonal Resources.
21614 #
21615 # Note that completed Operation resources have a limited
21616 # retention period.
21617 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
21618 # Not present otherwise.
21619 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
21620 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
21621 # set when the operation is created.
21622 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
21623 # text format.
21624 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
21625 # this field will be populated.
21626 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
21627 # operation.
21628 {
21629 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
21630 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
21631 # details. There is a set of defined message types to use for providing
21632 # details.The syntax depends on the error code. For example,
21633 # QuotaExceededInfo will have details when the error code is
21634 # QUOTA_EXCEEDED.
21635 {
21636 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
21637 #
21638 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
21639 # is not enabled:
21640 #
21641 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
21642 # &quot;domain&quot;: &quot;googleapis.com&quot;
21643 # &quot;metadata&quot;: {
21644 # &quot;resource&quot;: &quot;projects/123&quot;,
21645 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
21646 # }
21647 # }
21648 #
21649 # This response indicates that the pubsub.googleapis.com API is not enabled.
21650 #
21651 # Example of an error that is returned when attempting to create a Spanner
21652 # instance in a region that is out of stock:
21653 #
21654 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
21655 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
21656 # &quot;metadata&quot;: {
21657 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
21658 # }
21659 # }
21660 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
21661 # is typically the registered service name of the tool or product that
21662 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
21663 # generated by some common infrastructure, the error domain must be a
21664 # globally unique value that identifies the infrastructure. For Google API
21665 # infrastructure, the error domain is &quot;googleapis.com&quot;.
21666 &quot;metadatas&quot;: { # Additional structured details about this error.
21667 #
21668 # Keys must match a regular expression of `a-z+` but should
21669 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
21670 # length. When identifying the current value of an exceeded limit, the units
21671 # should be contained in the key, not the value. For example, rather than
21672 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
21673 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
21674 # instances that can be created in a single (batch) request.
21675 &quot;a_key&quot;: &quot;A String&quot;,
21676 },
21677 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
21678 # proximate cause of the error. Error reasons are unique within a particular
21679 # domain of errors. This should be at most 63 characters and match a
21680 # regular expression of `A-Z+[A-Z0-9]`, which represents
21681 # UPPER_SNAKE_CASE.
21682 },
21683 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
21684 #
21685 # For example, if a quota check failed with an error indicating the calling
21686 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
21687 # directly to the right place in the developer console to flip the bit.
21688 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
21689 { # Describes a URL link.
21690 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
21691 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
21692 },
21693 ],
21694 },
21695 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
21696 # which can be attached to an RPC error.
21697 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
21698 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
21699 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
21700 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
21701 },
21702 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
21703 &quot;dimensions&quot;: { # The map holding related quota dimensions.
21704 &quot;a_key&quot;: &quot;A String&quot;,
21705 },
21706 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
21707 # type or metric.
21708 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
21709 # or metric.
21710 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
21711 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
21712 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
21713 },
21714 },
21715 ],
21716 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
21717 # This property is optional.
21718 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
21719 },
21720 ],
21721 },
21722 &quot;getVersionOperationMetadata&quot;: {
21723 &quot;inlineSbomInfo&quot;: {
21724 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
21725 # appropriate identifiers.
21726 &quot;a_key&quot;: &quot;A String&quot;,
21727 },
21728 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
21729 # identifiers.
21730 &quot;a_key&quot;: &quot;A String&quot;,
21731 },
21732 },
21733 },
21734 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
21735 # message that was returned, such as `NOT FOUND`.
21736 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
21737 # status code that was returned. For example, a `404` means the
21738 # resource was not found.
21739 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
21740 # defined by the server.
21741 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
21742 # This value is inRFC3339
21743 # text format.
21744 &quot;instancesBulkInsertOperationMetadata&quot;: {
21745 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
21746 # Example key: zones/us-central1-a
21747 &quot;a_key&quot;: {
21748 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
21749 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
21750 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
21751 # error.
21752 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
21753 # if the flow is rolling forward or rolling back.
21754 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
21755 },
21756 },
21757 },
21758 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
21759 # Operation resources.
21760 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
21761 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
21762 # group of operations results from a `bulkInsert` API request.
21763 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
21764 # `update`, or `delete`, and so on.
21765 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
21766 # There is no requirement that this be linear or support any granularity of
21767 # operations. This should not be used to guess when the operation will be
21768 # complete. This number should monotonically increase as the operation
21769 # progresses.
21770 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
21771 # applicable when performing regional operations.
21772 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
21773 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
21774 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
21775 # this field will contain information on all underlying zonal actions and
21776 # their state.
21777 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
21778 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
21779 # Example key: zones/us-central1-a
21780 &quot;a_key&quot;: {
21781 &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
21782 # populated.
21783 # different programming environments, including REST APIs and RPC APIs. It is
21784 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
21785 # three pieces of data: error code, error message, and error details.
21786 #
21787 # You can find out more about this error model and how to work with it in the
21788 # [API Design Guide](https://cloud.google.com/apis/design/errors).
21789 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
21790 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
21791 # message types for APIs to use.
21792 {
21793 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
21794 },
21795 ],
21796 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
21797 # user-facing error message should be localized and sent in the
21798 # google.rpc.Status.details field, or localized by the client.
21799 },
21800 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
21801 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
21802 },
21803 },
21804 },
21805 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
21806 # This value is inRFC3339
21807 # text format.
21808 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
21809 # following:
21810 # `PENDING`, `RUNNING`, or `DONE`.
21811 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
21812 # operation.
21813 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
21814 # of the target resource.
21815 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
21816 # operations related to creating a snapshot, this points to the disk
21817 # that the snapshot was created from.
21818 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
21819 # `[email protected]` or
21820 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
21821 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
21822 # operation, this field will be populated.
21823 {
21824 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
21825 # Engine returns NO_RESULTS_ON_PAGE if there
21826 # are no results in the response.
21827 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
21828 # value format. For example:
21829 #
21830 # &quot;data&quot;: [
21831 # {
21832 # &quot;key&quot;: &quot;scope&quot;,
21833 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
21834 # }
21835 {
21836 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
21837 # returned. For example, for warnings where there are no results in a list
21838 # request for a particular zone, this key might be scope and
21839 # the key value might be the zone name. Other examples might be a key
21840 # indicating a deprecated resource and a suggested replacement, or a
21841 # warning about invalid network settings (for example, if an instance
21842 # attempts to perform IP forwarding but is not enabled for IP forwarding).
21843 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
21844 },
21845 ],
21846 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
21847 },
21848 ],
21849 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
21850 # applicable when performing per-zone operations.
21851 }</pre>
21852 </div>
21853
21854 <div class="method">
21855 <code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
21856 <pre>Starts an instance that was stopped using theinstances().stop
21857 method. For more information, seeRestart an
21858 instance.
21859
21860 Args:
21861 project: string, Project ID for this request. (required)
21862 zone: string, The name of the zone for this request. (required)
21863 instance: string, Name of the instance resource to start. (required)
21864 body: object, The request body.
21865 The object takes the form of:
21866
21867 {
21868 &quot;disks&quot;: [ # Array of disks associated with this instance that are protected with acustomer-supplied
21869 # encryption key.
21870 #
21871 # In order to start the instance, the disk url and its corresponding key must
21872 # be provided.
21873 #
21874 # If the disk is not protected with a customer-supplied encryption key it
21875 # should not be specified.
21876 {
21877 &quot;diskEncryptionKey&quot;: { # Decrypts data associated with the disk with acustomer-supplied
21878 # encryption key.
21879 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
21880 # For example:
21881 #
21882 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21883 # key_region/cryptoKeys/key
21884 #
21885 # The fully-qualifed key name may be returned for resource GET requests. For
21886 # example:
21887 #
21888 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21889 # key_region/cryptoKeys/key
21890 # /cryptoKeyVersions/1
21891 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
21892 # key. If absent, the Compute Engine default service account is used.
21893 # For example:
21894 #
21895 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
21896 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
21897 # encryption key, encoded in RFC
21898 # 4648 base64 to either encrypt or decrypt this resource. You can
21899 # provide either the rawKey or thersaEncryptedKey.
21900 # For example:
21901 #
21902 # &quot;rawKey&quot;:
21903 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
21904 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
21905 # customer-supplied encryption key to either encrypt or decrypt this
21906 # resource. You can provide either the rawKey or thersaEncryptedKey.
21907 # For example:
21908 #
21909 # &quot;rsaEncryptedKey&quot;:
21910 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
21911 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
21912 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
21913 #
21914 # The key must meet the following requirements before you can provide it to
21915 # Compute Engine:
21916 #
21917 # 1. The key is wrapped using a RSA public key certificate provided by
21918 # Google.
21919 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
21920 # encoding.
21921 #
21922 # Gets the RSA public key certificate provided by Google at:
21923 #
21924 #
21925 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
21926 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
21927 # 4648 base64 encoded SHA-256 hash of the customer-supplied
21928 # encryption key that protects this resource.
21929 },
21930 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
21931 # resource. This field is only applicable for persistent disks.
21932 # For example:
21933 #
21934 # &quot;source&quot;: &quot;/compute/v1/projects/project_id/zones/zone/disks/
21935 # disk_name
21936 },
21937 ],
21938 &quot;instanceEncryptionKey&quot;: { # Decrypts data associated with an instance that is protected with acustomer-supplied
21939 # encryption key.
21940 #
21941 # If the instance you are starting is protected with a customer-supplied
21942 # encryption key, the correct key must be provided otherwise the
21943 # instance start will not succeed.
21944 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
21945 # For example:
21946 #
21947 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21948 # key_region/cryptoKeys/key
21949 #
21950 # The fully-qualifed key name may be returned for resource GET requests. For
21951 # example:
21952 #
21953 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
21954 # key_region/cryptoKeys/key
21955 # /cryptoKeyVersions/1
21956 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
21957 # key. If absent, the Compute Engine default service account is used.
21958 # For example:
21959 #
21960 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
21961 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
21962 # encryption key, encoded in RFC
21963 # 4648 base64 to either encrypt or decrypt this resource. You can
21964 # provide either the rawKey or thersaEncryptedKey.
21965 # For example:
21966 #
21967 # &quot;rawKey&quot;:
21968 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
21969 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
21970 # customer-supplied encryption key to either encrypt or decrypt this
21971 # resource. You can provide either the rawKey or thersaEncryptedKey.
21972 # For example:
21973 #
21974 # &quot;rsaEncryptedKey&quot;:
21975 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
21976 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
21977 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
21978 #
21979 # The key must meet the following requirements before you can provide it to
21980 # Compute Engine:
21981 #
21982 # 1. The key is wrapped using a RSA public key certificate provided by
21983 # Google.
21984 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
21985 # encoding.
21986 #
21987 # Gets the RSA public key certificate provided by Google at:
21988 #
21989 #
21990 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
21991 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
21992 # 4648 base64 encoded SHA-256 hash of the customer-supplied
21993 # encryption key that protects this resource.
21994 },
21995 }
21996
21997 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
21998 that if you must retry your request, the server will know to ignore the
21999 request if it has already been completed.
22000
22001 For example, consider a situation where you make an initial request and
22002 the request times out. If you make the request again with the same
22003 request ID, the server can check if original operation with the same
22004 request ID was received, and if so, will ignore the second request. This
22005 prevents clients from accidentally creating duplicate commitments.
22006
22007 The request ID must be
22008 a valid UUID with the exception that zero UUID is not supported
22009 (00000000-0000-0000-0000-000000000000).
22010 x__xgafv: string, V1 error format.
22011 Allowed values
22012 1 - v1 error format
22013 2 - v2 error format
22014
22015 Returns:
22016 An object of the form:
22017
22018 { # Represents an Operation resource.
22019 #
22020 # Google Compute Engine has three Operation resources:
22021 #
22022 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
22023 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
22024 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
22025 #
22026 # You can use an operation resource to manage asynchronous API requests.
22027 # For more information, readHandling
22028 # API responses.
22029 #
22030 # Operations can be global, regional or zonal.
22031 #
22032 # - For global operations, use the `globalOperations`
22033 # resource.
22034 # - For regional operations, use the
22035 # `regionOperations` resource.
22036 # - For zonal operations, use
22037 # the `zoneOperations` resource.
22038 #
22039 #
22040 #
22041 # For more information, read
22042 # Global, Regional, and Zonal Resources.
22043 #
22044 # Note that completed Operation resources have a limited
22045 # retention period.
22046 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
22047 # Not present otherwise.
22048 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
22049 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
22050 # set when the operation is created.
22051 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
22052 # text format.
22053 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
22054 # this field will be populated.
22055 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
22056 # operation.
22057 {
22058 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
22059 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
22060 # details. There is a set of defined message types to use for providing
22061 # details.The syntax depends on the error code. For example,
22062 # QuotaExceededInfo will have details when the error code is
22063 # QUOTA_EXCEEDED.
22064 {
22065 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
22066 #
22067 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
22068 # is not enabled:
22069 #
22070 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
22071 # &quot;domain&quot;: &quot;googleapis.com&quot;
22072 # &quot;metadata&quot;: {
22073 # &quot;resource&quot;: &quot;projects/123&quot;,
22074 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
22075 # }
22076 # }
22077 #
22078 # This response indicates that the pubsub.googleapis.com API is not enabled.
22079 #
22080 # Example of an error that is returned when attempting to create a Spanner
22081 # instance in a region that is out of stock:
22082 #
22083 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
22084 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
22085 # &quot;metadata&quot;: {
22086 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
22087 # }
22088 # }
22089 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
22090 # is typically the registered service name of the tool or product that
22091 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
22092 # generated by some common infrastructure, the error domain must be a
22093 # globally unique value that identifies the infrastructure. For Google API
22094 # infrastructure, the error domain is &quot;googleapis.com&quot;.
22095 &quot;metadatas&quot;: { # Additional structured details about this error.
22096 #
22097 # Keys must match a regular expression of `a-z+` but should
22098 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
22099 # length. When identifying the current value of an exceeded limit, the units
22100 # should be contained in the key, not the value. For example, rather than
22101 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
22102 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
22103 # instances that can be created in a single (batch) request.
22104 &quot;a_key&quot;: &quot;A String&quot;,
22105 },
22106 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
22107 # proximate cause of the error. Error reasons are unique within a particular
22108 # domain of errors. This should be at most 63 characters and match a
22109 # regular expression of `A-Z+[A-Z0-9]`, which represents
22110 # UPPER_SNAKE_CASE.
22111 },
22112 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
22113 #
22114 # For example, if a quota check failed with an error indicating the calling
22115 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
22116 # directly to the right place in the developer console to flip the bit.
22117 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
22118 { # Describes a URL link.
22119 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
22120 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
22121 },
22122 ],
22123 },
22124 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
22125 # which can be attached to an RPC error.
22126 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
22127 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
22128 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
22129 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
22130 },
22131 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
22132 &quot;dimensions&quot;: { # The map holding related quota dimensions.
22133 &quot;a_key&quot;: &quot;A String&quot;,
22134 },
22135 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
22136 # type or metric.
22137 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
22138 # or metric.
22139 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
22140 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
22141 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
22142 },
22143 },
22144 ],
22145 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
22146 # This property is optional.
22147 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
22148 },
22149 ],
22150 },
22151 &quot;getVersionOperationMetadata&quot;: {
22152 &quot;inlineSbomInfo&quot;: {
22153 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
22154 # appropriate identifiers.
22155 &quot;a_key&quot;: &quot;A String&quot;,
22156 },
22157 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
22158 # identifiers.
22159 &quot;a_key&quot;: &quot;A String&quot;,
22160 },
22161 },
22162 },
22163 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
22164 # message that was returned, such as `NOT FOUND`.
22165 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
22166 # status code that was returned. For example, a `404` means the
22167 # resource was not found.
22168 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
22169 # defined by the server.
22170 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
22171 # This value is inRFC3339
22172 # text format.
22173 &quot;instancesBulkInsertOperationMetadata&quot;: {
22174 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
22175 # Example key: zones/us-central1-a
22176 &quot;a_key&quot;: {
22177 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
22178 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
22179 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
22180 # error.
22181 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
22182 # if the flow is rolling forward or rolling back.
22183 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
22184 },
22185 },
22186 },
22187 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
22188 # Operation resources.
22189 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
22190 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
22191 # group of operations results from a `bulkInsert` API request.
22192 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
22193 # `update`, or `delete`, and so on.
22194 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
22195 # There is no requirement that this be linear or support any granularity of
22196 # operations. This should not be used to guess when the operation will be
22197 # complete. This number should monotonically increase as the operation
22198 # progresses.
22199 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
22200 # applicable when performing regional operations.
22201 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
22202 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
22203 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
22204 # this field will contain information on all underlying zonal actions and
22205 # their state.
22206 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
22207 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
22208 # Example key: zones/us-central1-a
22209 &quot;a_key&quot;: {
22210 &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
22211 # populated.
22212 # different programming environments, including REST APIs and RPC APIs. It is
22213 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
22214 # three pieces of data: error code, error message, and error details.
22215 #
22216 # You can find out more about this error model and how to work with it in the
22217 # [API Design Guide](https://cloud.google.com/apis/design/errors).
22218 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
22219 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
22220 # message types for APIs to use.
22221 {
22222 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
22223 },
22224 ],
22225 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
22226 # user-facing error message should be localized and sent in the
22227 # google.rpc.Status.details field, or localized by the client.
22228 },
22229 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
22230 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
22231 },
22232 },
22233 },
22234 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
22235 # This value is inRFC3339
22236 # text format.
22237 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
22238 # following:
22239 # `PENDING`, `RUNNING`, or `DONE`.
22240 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
22241 # operation.
22242 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
22243 # of the target resource.
22244 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
22245 # operations related to creating a snapshot, this points to the disk
22246 # that the snapshot was created from.
22247 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
22248 # `[email protected]` or
22249 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
22250 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
22251 # operation, this field will be populated.
22252 {
22253 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
22254 # Engine returns NO_RESULTS_ON_PAGE if there
22255 # are no results in the response.
22256 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
22257 # value format. For example:
22258 #
22259 # &quot;data&quot;: [
22260 # {
22261 # &quot;key&quot;: &quot;scope&quot;,
22262 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
22263 # }
22264 {
22265 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
22266 # returned. For example, for warnings where there are no results in a list
22267 # request for a particular zone, this key might be scope and
22268 # the key value might be the zone name. Other examples might be a key
22269 # indicating a deprecated resource and a suggested replacement, or a
22270 # warning about invalid network settings (for example, if an instance
22271 # attempts to perform IP forwarding but is not enabled for IP forwarding).
22272 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
22273 },
22274 ],
22275 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
22276 },
22277 ],
22278 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
22279 # applicable when performing per-zone operations.
22280 }</pre>
22281 </div>
22282
22283 <div class="method">
22284 <code class="details" id="stop">stop(project, zone, instance, discardLocalSsd=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)</code>
22285 <pre>Stops a running instance, shutting it down cleanly, and allows
22286 you to restart the instance at a later time. Stopped instances do not incur
22287 VM usage charges while they are stopped. However, resources that the VM is
22288 using, such as persistent disks and static IP addresses, will continue to
22289 be charged until they are deleted. For more information, seeStopping
22290 an instance.
22291
22292 Args:
22293 project: string, Project ID for this request. (required)
22294 zone: string, The name of the zone for this request. (required)
22295 instance: string, Name of the instance resource to stop. (required)
22296 discardLocalSsd: boolean, This property is required if the instance has any attached Local SSD disks.
22297 If false, Local SSD data will be preserved when the instance is suspended.
22298 If true, the contents of any attached Local SSD disks will be discarded.
22299 noGracefulShutdown: boolean, If set to true, Graceful Shutdown is skipped.
22300 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
22301 that if you must retry your request, the server will know to ignore the
22302 request if it has already been completed.
22303
22304 For example, consider a situation where you make an initial request and
22305 the request times out. If you make the request again with the same
22306 request ID, the server can check if original operation with the same
22307 request ID was received, and if so, will ignore the second request. This
22308 prevents clients from accidentally creating duplicate commitments.
22309
22310 The request ID must be
22311 a valid UUID with the exception that zero UUID is not supported
22312 (00000000-0000-0000-0000-000000000000).
22313 x__xgafv: string, V1 error format.
22314 Allowed values
22315 1 - v1 error format
22316 2 - v2 error format
22317
22318 Returns:
22319 An object of the form:
22320
22321 { # Represents an Operation resource.
22322 #
22323 # Google Compute Engine has three Operation resources:
22324 #
22325 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
22326 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
22327 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
22328 #
22329 # You can use an operation resource to manage asynchronous API requests.
22330 # For more information, readHandling
22331 # API responses.
22332 #
22333 # Operations can be global, regional or zonal.
22334 #
22335 # - For global operations, use the `globalOperations`
22336 # resource.
22337 # - For regional operations, use the
22338 # `regionOperations` resource.
22339 # - For zonal operations, use
22340 # the `zoneOperations` resource.
22341 #
22342 #
22343 #
22344 # For more information, read
22345 # Global, Regional, and Zonal Resources.
22346 #
22347 # Note that completed Operation resources have a limited
22348 # retention period.
22349 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
22350 # Not present otherwise.
22351 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
22352 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
22353 # set when the operation is created.
22354 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
22355 # text format.
22356 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
22357 # this field will be populated.
22358 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
22359 # operation.
22360 {
22361 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
22362 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
22363 # details. There is a set of defined message types to use for providing
22364 # details.The syntax depends on the error code. For example,
22365 # QuotaExceededInfo will have details when the error code is
22366 # QUOTA_EXCEEDED.
22367 {
22368 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
22369 #
22370 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
22371 # is not enabled:
22372 #
22373 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
22374 # &quot;domain&quot;: &quot;googleapis.com&quot;
22375 # &quot;metadata&quot;: {
22376 # &quot;resource&quot;: &quot;projects/123&quot;,
22377 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
22378 # }
22379 # }
22380 #
22381 # This response indicates that the pubsub.googleapis.com API is not enabled.
22382 #
22383 # Example of an error that is returned when attempting to create a Spanner
22384 # instance in a region that is out of stock:
22385 #
22386 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
22387 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
22388 # &quot;metadata&quot;: {
22389 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
22390 # }
22391 # }
22392 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
22393 # is typically the registered service name of the tool or product that
22394 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
22395 # generated by some common infrastructure, the error domain must be a
22396 # globally unique value that identifies the infrastructure. For Google API
22397 # infrastructure, the error domain is &quot;googleapis.com&quot;.
22398 &quot;metadatas&quot;: { # Additional structured details about this error.
22399 #
22400 # Keys must match a regular expression of `a-z+` but should
22401 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
22402 # length. When identifying the current value of an exceeded limit, the units
22403 # should be contained in the key, not the value. For example, rather than
22404 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
22405 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
22406 # instances that can be created in a single (batch) request.
22407 &quot;a_key&quot;: &quot;A String&quot;,
22408 },
22409 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
22410 # proximate cause of the error. Error reasons are unique within a particular
22411 # domain of errors. This should be at most 63 characters and match a
22412 # regular expression of `A-Z+[A-Z0-9]`, which represents
22413 # UPPER_SNAKE_CASE.
22414 },
22415 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
22416 #
22417 # For example, if a quota check failed with an error indicating the calling
22418 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
22419 # directly to the right place in the developer console to flip the bit.
22420 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
22421 { # Describes a URL link.
22422 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
22423 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
22424 },
22425 ],
22426 },
22427 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
22428 # which can be attached to an RPC error.
22429 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
22430 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
22431 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
22432 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
22433 },
22434 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
22435 &quot;dimensions&quot;: { # The map holding related quota dimensions.
22436 &quot;a_key&quot;: &quot;A String&quot;,
22437 },
22438 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
22439 # type or metric.
22440 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
22441 # or metric.
22442 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
22443 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
22444 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
22445 },
22446 },
22447 ],
22448 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
22449 # This property is optional.
22450 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
22451 },
22452 ],
22453 },
22454 &quot;getVersionOperationMetadata&quot;: {
22455 &quot;inlineSbomInfo&quot;: {
22456 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
22457 # appropriate identifiers.
22458 &quot;a_key&quot;: &quot;A String&quot;,
22459 },
22460 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
22461 # identifiers.
22462 &quot;a_key&quot;: &quot;A String&quot;,
22463 },
22464 },
22465 },
22466 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
22467 # message that was returned, such as `NOT FOUND`.
22468 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
22469 # status code that was returned. For example, a `404` means the
22470 # resource was not found.
22471 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
22472 # defined by the server.
22473 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
22474 # This value is inRFC3339
22475 # text format.
22476 &quot;instancesBulkInsertOperationMetadata&quot;: {
22477 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
22478 # Example key: zones/us-central1-a
22479 &quot;a_key&quot;: {
22480 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
22481 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
22482 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
22483 # error.
22484 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
22485 # if the flow is rolling forward or rolling back.
22486 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
22487 },
22488 },
22489 },
22490 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
22491 # Operation resources.
22492 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
22493 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
22494 # group of operations results from a `bulkInsert` API request.
22495 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
22496 # `update`, or `delete`, and so on.
22497 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
22498 # There is no requirement that this be linear or support any granularity of
22499 # operations. This should not be used to guess when the operation will be
22500 # complete. This number should monotonically increase as the operation
22501 # progresses.
22502 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
22503 # applicable when performing regional operations.
22504 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
22505 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
22506 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
22507 # this field will contain information on all underlying zonal actions and
22508 # their state.
22509 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
22510 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
22511 # Example key: zones/us-central1-a
22512 &quot;a_key&quot;: {
22513 &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
22514 # populated.
22515 # different programming environments, including REST APIs and RPC APIs. It is
22516 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
22517 # three pieces of data: error code, error message, and error details.
22518 #
22519 # You can find out more about this error model and how to work with it in the
22520 # [API Design Guide](https://cloud.google.com/apis/design/errors).
22521 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
22522 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
22523 # message types for APIs to use.
22524 {
22525 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
22526 },
22527 ],
22528 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
22529 # user-facing error message should be localized and sent in the
22530 # google.rpc.Status.details field, or localized by the client.
22531 },
22532 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
22533 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
22534 },
22535 },
22536 },
22537 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
22538 # This value is inRFC3339
22539 # text format.
22540 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
22541 # following:
22542 # `PENDING`, `RUNNING`, or `DONE`.
22543 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
22544 # operation.
22545 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
22546 # of the target resource.
22547 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
22548 # operations related to creating a snapshot, this points to the disk
22549 # that the snapshot was created from.
22550 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
22551 # `[email protected]` or
22552 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
22553 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
22554 # operation, this field will be populated.
22555 {
22556 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
22557 # Engine returns NO_RESULTS_ON_PAGE if there
22558 # are no results in the response.
22559 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
22560 # value format. For example:
22561 #
22562 # &quot;data&quot;: [
22563 # {
22564 # &quot;key&quot;: &quot;scope&quot;,
22565 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
22566 # }
22567 {
22568 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
22569 # returned. For example, for warnings where there are no results in a list
22570 # request for a particular zone, this key might be scope and
22571 # the key value might be the zone name. Other examples might be a key
22572 # indicating a deprecated resource and a suggested replacement, or a
22573 # warning about invalid network settings (for example, if an instance
22574 # attempts to perform IP forwarding but is not enabled for IP forwarding).
22575 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
22576 },
22577 ],
22578 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
22579 },
22580 ],
22581 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
22582 # applicable when performing per-zone operations.
22583 }</pre>
22584 </div>
22585
22586 <div class="method">
22587 <code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</code>
22588 <pre>This method suspends a running instance, saving its state to persistent
22589 storage, and allows you to resume the instance at a later time. Suspended
22590 instances have no compute costs (cores or RAM), and incur only storage
22591 charges for the saved VM memory and localSSD data. Any charged resources
22592 the virtual machine was using, such as persistent disks and static IP
22593 addresses, will continue to be charged while the instance is suspended.
22594 For more information, see
22595 Suspending and resuming an instance.
22596
22597 Args:
22598 project: string, Project ID for this request. (required)
22599 zone: string, The name of the zone for this request. (required)
22600 instance: string, Name of the instance resource to suspend. (required)
22601 discardLocalSsd: boolean, This property is required if the instance has any attached Local SSD disks.
22602 If false, Local SSD data will be preserved when the instance is suspended.
22603 If true, the contents of any attached Local SSD disks will be discarded.
22604 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
22605 that if you must retry your request, the server will know to ignore the
22606 request if it has already been completed.
22607
22608 For example, consider a situation where you make an initial request and
22609 the request times out. If you make the request again with the same
22610 request ID, the server can check if original operation with the same
22611 request ID was received, and if so, will ignore the second request. This
22612 prevents clients from accidentally creating duplicate commitments.
22613
22614 The request ID must be
22615 a valid UUID with the exception that zero UUID is not supported
22616 (00000000-0000-0000-0000-000000000000).
22617 x__xgafv: string, V1 error format.
22618 Allowed values
22619 1 - v1 error format
22620 2 - v2 error format
22621
22622 Returns:
22623 An object of the form:
22624
22625 { # Represents an Operation resource.
22626 #
22627 # Google Compute Engine has three Operation resources:
22628 #
22629 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
22630 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
22631 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
22632 #
22633 # You can use an operation resource to manage asynchronous API requests.
22634 # For more information, readHandling
22635 # API responses.
22636 #
22637 # Operations can be global, regional or zonal.
22638 #
22639 # - For global operations, use the `globalOperations`
22640 # resource.
22641 # - For regional operations, use the
22642 # `regionOperations` resource.
22643 # - For zonal operations, use
22644 # the `zoneOperations` resource.
22645 #
22646 #
22647 #
22648 # For more information, read
22649 # Global, Regional, and Zonal Resources.
22650 #
22651 # Note that completed Operation resources have a limited
22652 # retention period.
22653 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
22654 # Not present otherwise.
22655 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
22656 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
22657 # set when the operation is created.
22658 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
22659 # text format.
22660 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
22661 # this field will be populated.
22662 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
22663 # operation.
22664 {
22665 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
22666 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
22667 # details. There is a set of defined message types to use for providing
22668 # details.The syntax depends on the error code. For example,
22669 # QuotaExceededInfo will have details when the error code is
22670 # QUOTA_EXCEEDED.
22671 {
22672 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
22673 #
22674 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
22675 # is not enabled:
22676 #
22677 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
22678 # &quot;domain&quot;: &quot;googleapis.com&quot;
22679 # &quot;metadata&quot;: {
22680 # &quot;resource&quot;: &quot;projects/123&quot;,
22681 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
22682 # }
22683 # }
22684 #
22685 # This response indicates that the pubsub.googleapis.com API is not enabled.
22686 #
22687 # Example of an error that is returned when attempting to create a Spanner
22688 # instance in a region that is out of stock:
22689 #
22690 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
22691 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
22692 # &quot;metadata&quot;: {
22693 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
22694 # }
22695 # }
22696 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
22697 # is typically the registered service name of the tool or product that
22698 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
22699 # generated by some common infrastructure, the error domain must be a
22700 # globally unique value that identifies the infrastructure. For Google API
22701 # infrastructure, the error domain is &quot;googleapis.com&quot;.
22702 &quot;metadatas&quot;: { # Additional structured details about this error.
22703 #
22704 # Keys must match a regular expression of `a-z+` but should
22705 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
22706 # length. When identifying the current value of an exceeded limit, the units
22707 # should be contained in the key, not the value. For example, rather than
22708 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
22709 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
22710 # instances that can be created in a single (batch) request.
22711 &quot;a_key&quot;: &quot;A String&quot;,
22712 },
22713 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
22714 # proximate cause of the error. Error reasons are unique within a particular
22715 # domain of errors. This should be at most 63 characters and match a
22716 # regular expression of `A-Z+[A-Z0-9]`, which represents
22717 # UPPER_SNAKE_CASE.
22718 },
22719 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
22720 #
22721 # For example, if a quota check failed with an error indicating the calling
22722 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
22723 # directly to the right place in the developer console to flip the bit.
22724 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
22725 { # Describes a URL link.
22726 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
22727 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
22728 },
22729 ],
22730 },
22731 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
22732 # which can be attached to an RPC error.
22733 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
22734 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
22735 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
22736 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
22737 },
22738 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
22739 &quot;dimensions&quot;: { # The map holding related quota dimensions.
22740 &quot;a_key&quot;: &quot;A String&quot;,
22741 },
22742 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
22743 # type or metric.
22744 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
22745 # or metric.
22746 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
22747 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
22748 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
22749 },
22750 },
22751 ],
22752 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
22753 # This property is optional.
22754 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
22755 },
22756 ],
22757 },
22758 &quot;getVersionOperationMetadata&quot;: {
22759 &quot;inlineSbomInfo&quot;: {
22760 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
22761 # appropriate identifiers.
22762 &quot;a_key&quot;: &quot;A String&quot;,
22763 },
22764 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
22765 # identifiers.
22766 &quot;a_key&quot;: &quot;A String&quot;,
22767 },
22768 },
22769 },
22770 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
22771 # message that was returned, such as `NOT FOUND`.
22772 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
22773 # status code that was returned. For example, a `404` means the
22774 # resource was not found.
22775 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
22776 # defined by the server.
22777 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
22778 # This value is inRFC3339
22779 # text format.
22780 &quot;instancesBulkInsertOperationMetadata&quot;: {
22781 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
22782 # Example key: zones/us-central1-a
22783 &quot;a_key&quot;: {
22784 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
22785 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
22786 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
22787 # error.
22788 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
22789 # if the flow is rolling forward or rolling back.
22790 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
22791 },
22792 },
22793 },
22794 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
22795 # Operation resources.
22796 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
22797 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
22798 # group of operations results from a `bulkInsert` API request.
22799 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
22800 # `update`, or `delete`, and so on.
22801 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
22802 # There is no requirement that this be linear or support any granularity of
22803 # operations. This should not be used to guess when the operation will be
22804 # complete. This number should monotonically increase as the operation
22805 # progresses.
22806 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
22807 # applicable when performing regional operations.
22808 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
22809 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
22810 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
22811 # this field will contain information on all underlying zonal actions and
22812 # their state.
22813 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
22814 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
22815 # Example key: zones/us-central1-a
22816 &quot;a_key&quot;: {
22817 &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
22818 # populated.
22819 # different programming environments, including REST APIs and RPC APIs. It is
22820 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
22821 # three pieces of data: error code, error message, and error details.
22822 #
22823 # You can find out more about this error model and how to work with it in the
22824 # [API Design Guide](https://cloud.google.com/apis/design/errors).
22825 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
22826 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
22827 # message types for APIs to use.
22828 {
22829 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
22830 },
22831 ],
22832 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
22833 # user-facing error message should be localized and sent in the
22834 # google.rpc.Status.details field, or localized by the client.
22835 },
22836 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
22837 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
22838 },
22839 },
22840 },
22841 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
22842 # This value is inRFC3339
22843 # text format.
22844 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
22845 # following:
22846 # `PENDING`, `RUNNING`, or `DONE`.
22847 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
22848 # operation.
22849 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
22850 # of the target resource.
22851 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
22852 # operations related to creating a snapshot, this points to the disk
22853 # that the snapshot was created from.
22854 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
22855 # `[email protected]` or
22856 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
22857 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
22858 # operation, this field will be populated.
22859 {
22860 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
22861 # Engine returns NO_RESULTS_ON_PAGE if there
22862 # are no results in the response.
22863 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
22864 # value format. For example:
22865 #
22866 # &quot;data&quot;: [
22867 # {
22868 # &quot;key&quot;: &quot;scope&quot;,
22869 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
22870 # }
22871 {
22872 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
22873 # returned. For example, for warnings where there are no results in a list
22874 # request for a particular zone, this key might be scope and
22875 # the key value might be the zone name. Other examples might be a key
22876 # indicating a deprecated resource and a suggested replacement, or a
22877 # warning about invalid network settings (for example, if an instance
22878 # attempts to perform IP forwarding but is not enabled for IP forwarding).
22879 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
22880 },
22881 ],
22882 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
22883 },
22884 ],
22885 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
22886 # applicable when performing per-zone operations.
22887 }</pre>
22888 </div>
22889
22890 <div class="method">
22891 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
22892 <pre>Returns permissions that a caller has on the specified resource.
22893
22894 Args:
22895 project: string, Project ID for this request. (required)
22896 zone: string, The name of the zone for this request. (required)
22897 resource: string, Name or id of the resource for this request. (required)
22898 body: object, The request body.
22899 The object takes the form of:
22900
22901 {
22902 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
22903 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
22904 &quot;A String&quot;,
22905 ],
22906 }
22907
22908 x__xgafv: string, V1 error format.
22909 Allowed values
22910 1 - v1 error format
22911 2 - v2 error format
22912
22913 Returns:
22914 An object of the form:
22915
22916 {
22917 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
22918 # allowed.
22919 &quot;A String&quot;,
22920 ],
22921 }</pre>
22922 </div>
22923
22924 <div class="method">
22925 <code class="details" id="update">update(project, zone, instance, body=None, clearSecureTag=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</code>
22926 <pre>Updates an instance only if the necessary resources are available. This
22927 method can update only a specific set of instance properties. See
22928 Updating a running instance for a list of updatable instance
22929 properties.
22930
22931 Args:
22932 project: string, Project ID for this request. (required)
22933 zone: string, The name of the zone for this request. (required)
22934 instance: string, Name of the instance resource to update. (required)
22935 body: object, The request body.
22936 The object takes the form of:
22937
22938 { # Represents an Instance resource.
22939 #
22940 # An instance is a virtual machine that is hosted on Google Cloud Platform.
22941 # For more information, readVirtual Machine Instances.
22942 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
22943 # Options that would traditionally be configured in a BIOS belong
22944 # here. Features that require operating system support may have
22945 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
22946 # disabled).
22947 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
22948 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
22949 &quot;enableWatchdogTimer&quot;: True or False, # Whether to enable the watchdog timer.
22950 &quot;numaNodeCount&quot;: 42, # The number of vNUMA nodes.
22951 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
22952 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
22953 # multithreading (SMT) set this to 1. If unset, the maximum number
22954 # of threads supported per core by the underlying processor is
22955 # assumed.
22956 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
22957 # Supported modes include:
22958 # * ALL_CORE_MAX
22959 #
22960 # Using empty string or not setting this field will use the platform-specific
22961 # default turbo mode.
22962 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
22963 # the number of threads per core to compute the total number of virtual
22964 # CPUs to expose to the instance. If unset, the number of cores is
22965 # inferred from the instance&#x27;s nominal CPU count and the underlying
22966 # platform&#x27;s SMT width.
22967 },
22968 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
22969 # destination or source IPs. This is required if you plan to use this
22970 # instance to forward routes. For more information, seeEnabling IP Forwarding.
22971 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
22972 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
22973 &quot;confidentialParavisorConfig&quot;: { # A set of Confidential Paravisor (SVSM) options. # Defines a set of Confidential Paravisor (SVSM) options.
22974 &quot;confidentialTpmType&quot;: &quot;A String&quot;,
22975 &quot;sevSnpIrqMode&quot;: &quot;A String&quot;,
22976 },
22977 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
22978 },
22979 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
22980 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
22981 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
22982 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
22983 # create the resource.
22984 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
22985 # created before you can assign them.
22986 { # An instance-attached disk resource.
22987 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
22988 # or X86_64.
22989 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
22990 # deleted (but not when the disk is detached from the instance).
22991 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
22992 # partition of the disk for its root filesystem.
22993 &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
22994 # running within the instance. This name can be used to reference the device
22995 # for mounting, resizing, and so on, from within the instance.
22996 #
22997 # If not specified, the server chooses a default device name to apply to this
22998 # disk, in the form persistent-disk-x, where x is a number
22999 # assigned by Google Compute Engine. This field is only applicable for
23000 # persistent disks.
23001 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
23002 # encryption key.
23003 #
23004 # If you are creating a new disk, this field encrypts the new disk using
23005 # an encryption key that you provide. If you are attaching an existing
23006 # disk that is already encrypted, this field decrypts the disk using
23007 # the customer-supplied encryption key.
23008 #
23009 # If you encrypt a disk using a customer-supplied key, you must provide the
23010 # same key again when you attempt to use this resource at a later time. For
23011 # example, you must provide the key when you create a snapshot or an image
23012 # from the disk or when you attach the disk to a virtual machine instance.
23013 #
23014 # If you do not provide an encryption key, then the disk will be encrypted
23015 # using an automatically generated key and you do not need to provide a key
23016 # to use the disk later.
23017 #
23018 # Note:
23019 #
23020 # Instance templates do not storecustomer-supplied
23021 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
23022 #
23023 # You cannot create VMs that have disks with customer-supplied keys using
23024 # the bulk
23025 # insert method.
23026 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
23027 # For example:
23028 #
23029 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
23030 # key_region/cryptoKeys/key
23031 #
23032 # The fully-qualifed key name may be returned for resource GET requests. For
23033 # example:
23034 #
23035 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
23036 # key_region/cryptoKeys/key
23037 # /cryptoKeyVersions/1
23038 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
23039 # key. If absent, the Compute Engine default service account is used.
23040 # For example:
23041 #
23042 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
23043 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
23044 # encryption key, encoded in RFC
23045 # 4648 base64 to either encrypt or decrypt this resource. You can
23046 # provide either the rawKey or thersaEncryptedKey.
23047 # For example:
23048 #
23049 # &quot;rawKey&quot;:
23050 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
23051 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
23052 # customer-supplied encryption key to either encrypt or decrypt this
23053 # resource. You can provide either the rawKey or thersaEncryptedKey.
23054 # For example:
23055 #
23056 # &quot;rsaEncryptedKey&quot;:
23057 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
23058 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
23059 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
23060 #
23061 # The key must meet the following requirements before you can provide it to
23062 # Compute Engine:
23063 #
23064 # 1. The key is wrapped using a RSA public key certificate provided by
23065 # Google.
23066 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
23067 # encoding.
23068 #
23069 # Gets the RSA public key certificate provided by Google at:
23070 #
23071 #
23072 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
23073 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
23074 # 4648 base64 encoded SHA-256 hash of the customer-supplied
23075 # encryption key that protects this resource.
23076 },
23077 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
23078 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
23079 # currently attached to another instance. If you try to force attach a zonal
23080 # disk to an instance, you will receive an error.
23081 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
23082 # only for bootable images. Read
23083 # Enabling guest operating system features to see a list of available
23084 # options.
23085 { # Guest OS features.
23086 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
23087 # separate values. Set to one or more of the following values:
23088 #
23089 # - VIRTIO_SCSI_MULTIQUEUE
23090 # - WINDOWS
23091 # - MULTI_IP_SUBNET
23092 # - UEFI_COMPATIBLE
23093 # - GVNIC
23094 # - SEV_CAPABLE
23095 # - SUSPEND_RESUME_COMPATIBLE
23096 # - SEV_LIVE_MIGRATABLE_V2
23097 # - SEV_SNP_CAPABLE
23098 # - TDX_CAPABLE
23099 # - IDPF
23100 # - SNP_SVSM_CAPABLE
23101 # - CCA_CAPABLE
23102 #
23103 #
23104 # For more information, see
23105 # Enabling guest operating system features.
23106 },
23107 ],
23108 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
23109 # boot disk. If you have many disks attached to an instance, each
23110 # disk would have a unique index number.
23111 &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
23112 # alongside the new instance. Use initialization parameters to create boot
23113 # disks or local SSDs attached to the new instance.
23114 #
23115 # This property is mutually exclusive with the source property;
23116 # you can only define one or the other, but not both.
23117 # alongside the new instance. Use initialization parameters to create boot
23118 # disks or local SSDs attached to the new instance.
23119 #
23120 # This field is persisted and returned for instanceTemplate and not returned
23121 # in the context of instance.
23122 #
23123 # This property is mutually exclusive with the source property;
23124 # you can only define one or the other, but not both.
23125 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
23126 # arm64 or x86_64.
23127 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
23128 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
23129 # of the instance. If a disk with the same name already exists in the given
23130 # region, the existing disk is attached to the new instance and the
23131 # new disk is not created.
23132 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
23133 # 10 GB. If you specify a sourceImage, which is required for
23134 # boot disks, the default size is the size of the sourceImage.
23135 # If you do not specify a sourceImage, the default disk size
23136 # is 500 GB.
23137 &quot;diskType&quot;: &quot;A String&quot;,
23138 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
23139 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
23140 # only for bootable images. Read
23141 # Enabling guest operating system features to see a list of available
23142 # options.
23143 #
23144 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
23145 { # Guest OS features.
23146 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
23147 # separate values. Set to one or more of the following values:
23148 #
23149 # - VIRTIO_SCSI_MULTIQUEUE
23150 # - WINDOWS
23151 # - MULTI_IP_SUBNET
23152 # - UEFI_COMPATIBLE
23153 # - GVNIC
23154 # - SEV_CAPABLE
23155 # - SUSPEND_RESUME_COMPATIBLE
23156 # - SEV_LIVE_MIGRATABLE_V2
23157 # - SEV_SNP_CAPABLE
23158 # - TDX_CAPABLE
23159 # - IDPF
23160 # - SNP_SVSM_CAPABLE
23161 # - CCA_CAPABLE
23162 #
23163 #
23164 # For more information, see
23165 # Enabling guest operating system features.
23166 },
23167 ],
23168 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
23169 # which is either SCSI or NVME. The default isSCSI.
23170 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
23171 # persistent disks.
23172 &quot;a_key&quot;: &quot;A String&quot;,
23173 },
23174 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
23175 # disk.
23176 &quot;A String&quot;,
23177 ],
23178 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
23179 &quot;A String&quot;,
23180 ],
23181 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
23182 # more than one instance.
23183 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
23184 # is to use the existing disk.
23185 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
23186 # of I/O operations per second that the disk can handle. Values must be
23187 # between 10,000 and 120,000. For more details, see theExtreme persistent
23188 # disk documentation.
23189 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
23190 # number of throughput mb per second that the disk can handle. Values must
23191 # greater than or equal to 1.
23192 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
23193 # the URLs of the zones where the disk should be replicated to.
23194 # You must provide exactly two replica zones, and one zone must be the same
23195 # as the instance zone.
23196 &quot;A String&quot;,
23197 ],
23198 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
23199 # have the same definition as resource
23200 # manager tags. Keys and values can be either in numeric format,
23201 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
23202 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
23203 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
23204 # empty.
23205 &quot;a_key&quot;: &quot;A String&quot;,
23206 },
23207 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
23208 # Specified using the full or partial URL. For instance template, specify
23209 # only the resource policy name.
23210 &quot;A String&quot;,
23211 ],
23212 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
23213 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
23214 # is required.
23215 #
23216 # To create a disk with one of the public operating system
23217 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
23218 #
23219 # projects/debian-cloud/global/images/family/debian-9
23220 #
23221 #
23222 # Alternatively, use a specific version of a public operating system image:
23223 #
23224 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
23225 #
23226 #
23227 # To create a disk with a custom image that you created, specify the
23228 # image name in the following format:
23229 #
23230 # global/images/my-custom-image
23231 #
23232 #
23233 # You can also specify a custom image by its image family, which returns
23234 # the latest version of the image in that family. Replace the image name
23235 # with family/family-name:
23236 #
23237 # global/images/family/my-image-family
23238 #
23239 #
23240 # If the source image is deleted later, this field will not be set.
23241 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
23242 # encryption key of the source image. Required if the source image is
23243 # protected by a customer-supplied encryption key.
23244 #
23245 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
23246 # encryption keys, so you cannot create disks for instances in a managed instance group if the
23247 # source images are encrypted with your own keys.
23248 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
23249 # For example:
23250 #
23251 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
23252 # key_region/cryptoKeys/key
23253 #
23254 # The fully-qualifed key name may be returned for resource GET requests. For
23255 # example:
23256 #
23257 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
23258 # key_region/cryptoKeys/key
23259 # /cryptoKeyVersions/1
23260 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
23261 # key. If absent, the Compute Engine default service account is used.
23262 # For example:
23263 #
23264 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
23265 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
23266 # encryption key, encoded in RFC
23267 # 4648 base64 to either encrypt or decrypt this resource. You can
23268 # provide either the rawKey or thersaEncryptedKey.
23269 # For example:
23270 #
23271 # &quot;rawKey&quot;:
23272 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
23273 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
23274 # customer-supplied encryption key to either encrypt or decrypt this
23275 # resource. You can provide either the rawKey or thersaEncryptedKey.
23276 # For example:
23277 #
23278 # &quot;rsaEncryptedKey&quot;:
23279 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
23280 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
23281 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
23282 #
23283 # The key must meet the following requirements before you can provide it to
23284 # Compute Engine:
23285 #
23286 # 1. The key is wrapped using a RSA public key certificate provided by
23287 # Google.
23288 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
23289 # encoding.
23290 #
23291 # Gets the RSA public key certificate provided by Google at:
23292 #
23293 #
23294 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
23295 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
23296 # 4648 base64 encoded SHA-256 hash of the customer-supplied
23297 # encryption key that protects this resource.
23298 },
23299 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
23300 # instance boot disk, one of initializeParams.sourceSnapshot
23301 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
23302 # is required.
23303 #
23304 # To create a disk with a snapshot that you created, specify the
23305 # snapshot name in the following format:
23306 #
23307 # us-central1-a/instantSnapshots/my-backup
23308 #
23309 #
23310 # If the source instant-snapshot is deleted later, this field will not be
23311 # set.
23312 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
23313 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
23314 # is required.
23315 #
23316 # To create a disk with a snapshot that you created, specify the
23317 # snapshot name in the following format:
23318 #
23319 # global/snapshots/my-backup
23320 #
23321 #
23322 # If the source snapshot is deleted later, this field will not be set.
23323 #
23324 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
23325 # an image instead when you create VMs using
23326 # the bulk
23327 # insert method.
23328 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
23329 # encryption key of the source snapshot.
23330 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
23331 # For example:
23332 #
23333 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
23334 # key_region/cryptoKeys/key
23335 #
23336 # The fully-qualifed key name may be returned for resource GET requests. For
23337 # example:
23338 #
23339 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
23340 # key_region/cryptoKeys/key
23341 # /cryptoKeyVersions/1
23342 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
23343 # key. If absent, the Compute Engine default service account is used.
23344 # For example:
23345 #
23346 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
23347 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
23348 # encryption key, encoded in RFC
23349 # 4648 base64 to either encrypt or decrypt this resource. You can
23350 # provide either the rawKey or thersaEncryptedKey.
23351 # For example:
23352 #
23353 # &quot;rawKey&quot;:
23354 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
23355 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
23356 # customer-supplied encryption key to either encrypt or decrypt this
23357 # resource. You can provide either the rawKey or thersaEncryptedKey.
23358 # For example:
23359 #
23360 # &quot;rsaEncryptedKey&quot;:
23361 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
23362 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
23363 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
23364 #
23365 # The key must meet the following requirements before you can provide it to
23366 # Compute Engine:
23367 #
23368 # 1. The key is wrapped using a RSA public key certificate provided by
23369 # Google.
23370 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
23371 # encoding.
23372 #
23373 # Gets the RSA public key certificate provided by Google at:
23374 #
23375 #
23376 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
23377 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
23378 # 4648 base64 encoded SHA-256 hash of the customer-supplied
23379 # encryption key that protects this resource.
23380 },
23381 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
23382 # this as a partial or full URL to the resource. For example, the following
23383 # are valid values:
23384 #
23385 #
23386 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
23387 # - projects/project/zones/zone/storagePools/storagePool
23388 # - zones/zone/storagePools/storagePool
23389 },
23390 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
23391 # either SCSI or NVME. For most machine types, the
23392 # default is SCSI. Local SSDs can use either NVME or SCSI.
23393 # In certain configurations, persistent disks can use NVMe. For more
23394 # information, seeAbout
23395 # persistent disks.
23396 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
23397 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
23398 &quot;A String&quot;,
23399 ],
23400 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
23401 # disk is not allowed to be detached from the instance, or to be used as the
23402 # source of the snapshot creation, and the image creation. The instance with
23403 # at least one locked attached disk is not allow to be used as source of
23404 # machine image creation, instant snapshot creation, and not allowed to be
23405 # deleted with --keep-disk parameter set to true for locked disks.
23406 &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
23407 # in READ_WRITE mode.
23408 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
23409 # field is set to PRESERVED if the LocalSSD data has been saved
23410 # to a persistent location by customer request. (see the
23411 # discard_local_ssd option on Stop/Suspend).
23412 # Read-only in the api.
23413 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
23414 # these are public keys which are safe to store in public
23415 &quot;dbs&quot;: [ # The Key Database (db).
23416 {
23417 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
23418 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
23419 },
23420 ],
23421 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
23422 {
23423 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
23424 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
23425 },
23426 ],
23427 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
23428 {
23429 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
23430 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
23431 },
23432 ],
23433 &quot;pk&quot;: { # The Platform Key (PK).
23434 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
23435 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
23436 },
23437 },
23438 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
23439 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
23440 # is required.
23441 #
23442 # If desired, you can also attach existing non-root persistent disks using
23443 # this property. This field is only applicable for persistent disks.
23444 #
23445 # Note that for InstanceTemplate, specify the disk name for zonal disk,
23446 # and the URL for regional disk.
23447 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
23448 },
23449 ],
23450 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
23451 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
23452 },
23453 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source
23454 # machine image should erase Windows specific VSS signature.
23455 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
23456 # the instance&#x27;s contents and used for optimistic locking. The
23457 # fingerprint is initially generated by Compute Engine and changes after
23458 # every request to modify or update the instance. You must always provide an
23459 # up-to-date fingerprint hash in order to update the instance.
23460 #
23461 # To see the latest fingerprint, make get() request to the
23462 # instance.
23463 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
23464 { # A specification of the type and number of accelerator cards attached to the
23465 # instance.
23466 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
23467 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
23468 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
23469 # If you are creating an instance template, specify only the
23470 # accelerator name.
23471 # See GPUs on Compute Engine
23472 # for a full list of accelerator types.
23473 },
23474 ],
23475 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
23476 # RFC1035 compliant. If hostname is not specified, the default hostname is
23477 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
23478 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
23479 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
23480 # defined by the server.
23481 &quot;identity&quot;: &quot;A String&quot;,
23482 &quot;identityCertificate&quot;: True or False,
23483 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
23484 # encryption key.
23485 #
23486 # If you are creating a new instance, this field will encrypt the local SSD
23487 # and in-memory contents of the instance during the suspend operation.
23488 #
23489 # If you do not provide an encryption key when creating the instance, then
23490 # the local SSD and in-memory contents will be encrypted using
23491 # an automatically generated key during the suspend operation.
23492 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
23493 # For example:
23494 #
23495 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
23496 # key_region/cryptoKeys/key
23497 #
23498 # The fully-qualifed key name may be returned for resource GET requests. For
23499 # example:
23500 #
23501 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
23502 # key_region/cryptoKeys/key
23503 # /cryptoKeyVersions/1
23504 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
23505 # key. If absent, the Compute Engine default service account is used.
23506 # For example:
23507 #
23508 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
23509 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
23510 # encryption key, encoded in RFC
23511 # 4648 base64 to either encrypt or decrypt this resource. You can
23512 # provide either the rawKey or thersaEncryptedKey.
23513 # For example:
23514 #
23515 # &quot;rawKey&quot;:
23516 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
23517 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
23518 # customer-supplied encryption key to either encrypt or decrypt this
23519 # resource. You can provide either the rawKey or thersaEncryptedKey.
23520 # For example:
23521 #
23522 # &quot;rsaEncryptedKey&quot;:
23523 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
23524 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
23525 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
23526 #
23527 # The key must meet the following requirements before you can provide it to
23528 # Compute Engine:
23529 #
23530 # 1. The key is wrapped using a RSA public key certificate provided by
23531 # Google.
23532 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
23533 # encoding.
23534 #
23535 # Gets the RSA public key certificate provided by Google at:
23536 #
23537 #
23538 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
23539 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
23540 # 4648 base64 encoded SHA-256 hash of the customer-supplied
23541 # encryption key that protects this resource.
23542 },
23543 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
23544 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
23545 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
23546 # for instances.
23547 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
23548 # the label&#x27;s contents and used for optimistic locking. The
23549 # fingerprint is initially generated by Compute Engine and changes after
23550 # every request to modify or update labels. You must always provide an
23551 # up-to-date fingerprint hash in order to update or change labels.
23552 #
23553 # To see the latest fingerprint, make get() request to the
23554 # instance.
23555 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
23556 # the setLabels method.
23557 &quot;a_key&quot;: &quot;A String&quot;,
23558 },
23559 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
23560 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
23561 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
23562 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
23563 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
23564 # when the instance is created. For example, the following is a valid partial
23565 # url to a predefined
23566 # machine type:
23567 #
23568 # zones/us-central1-f/machineTypes/n1-standard-1
23569 #
23570 #
23571 # To create acustom
23572 # machine type, provide a URL to a machine type in the following format,
23573 # where CPUS is 1 or an even number up to 32 (2,
23574 # 4, 6, ... 24, etc), and MEMORY is the total
23575 # memory for this instance. Memory must be a multiple of 256 MB and must
23576 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
23577 #
23578 # zones/zone/machineTypes/custom-CPUS-MEMORY
23579 #
23580 #
23581 # For example: zones/us-central1-f/machineTypes/custom-4-5120
23582 # For a full list of restrictions, read theSpecifications
23583 # for custom machine types.
23584 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
23585 # to this instance. This includes metadata keys that were explicitly defined
23586 # for the instance.
23587 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
23588 # the metadata&#x27;s contents and used for optimistic locking. The
23589 # fingerprint is initially generated by Compute Engine and changes after
23590 # every request to modify or update metadata. You must always provide an
23591 # up-to-date fingerprint hash in order to update or change metadata,
23592 # otherwise the request will fail with error412 conditionNotMet.
23593 #
23594 # To see the latest fingerprint, make a get() request to
23595 # retrieve the resource.
23596 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
23597 # less than 512 KB.
23598 { # Metadata
23599 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
23600 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
23601 # This is reflected as part of a URL in the metadata server. Additionally, to
23602 # avoid ambiguity, keys must not conflict with any other metadata keys
23603 # for the project.
23604 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
23605 # have meaning as interpreted by the image running in the instance. The
23606 # only restriction placed on values is that their size must be less than
23607 # or equal to 262144 bytes (256 KiB).
23608 },
23609 ],
23610 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
23611 # for metadata.
23612 },
23613 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
23614 # platform for the VM instance. Applicable values are the friendly names
23615 # of CPU platforms, such as minCpuPlatform: &quot;Intel
23616 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
23617 # Bridge&quot;.
23618 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
23619 # the resource. The resource name must be 1-63 characters long, and comply
23620 # withRFC1035.
23621 # Specifically, the name must be 1-63 characters long and match the regular
23622 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
23623 # character must be a lowercase letter, and all following characters must be
23624 # a dash, lowercase letter, or digit, except the last character, which cannot
23625 # be a dash.
23626 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
23627 # interfaces are configured to interact with other network services, such as
23628 # connecting to the internet. Multiple interfaces are supported
23629 # per instance.
23630 { # A network interface resource attached to an instance.
23631 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
23632 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
23633 # no external internet access.
23634 { # An access configuration attached to an instance&#x27;s network interface.
23635 # Only one access config per instance is supported.
23636 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
23637 # The first IPv6 address of the external IPv6 range associated
23638 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
23639 # use a static external IP address, it must be unused and in the same region
23640 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
23641 # assign an external IPv6 address from the instance&#x27;s subnetwork.
23642 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
23643 # external IPv6 range.
23644 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
23645 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
23646 # (IPv4), the default and recommended name is External NAT, but
23647 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
23648 # recommend name is External IPv6.
23649 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
23650 # address associated with this instance. Specify an unused static
23651 # external IP address available to the project or leave this field undefined
23652 # to use an IP from a shared ephemeral IP address pool. If you specify a
23653 # static external IP address, it must live in the same region as the zone of
23654 # the instance.
23655 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
23656 # configuration and can only take the following values: PREMIUM,STANDARD.
23657 #
23658 # If an AccessConfig is specified without a valid external IP address, an
23659 # ephemeral IP will be created with this networkTier.
23660 #
23661 # If an AccessConfig with a valid external IP address is specified, it must
23662 # match that of the networkTier associated with the Address resource owning
23663 # that IP.
23664 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
23665 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
23666 #
23667 # 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
23668 # first IP in associated external IPv6 range.
23669 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
23670 # config.
23671 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
23672 # external IP address of this access configuration.
23673 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
23674 # external IP address of the instance to a DNS domain name.
23675 #
23676 # This field is not used in ipv6AccessConfig. A default PTR
23677 # record will be created if the VM has external IPv6 range associated.
23678 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
23679 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
23680 },
23681 ],
23682 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
23683 # You can only specify this field for network interfaces in VPC networks.
23684 { # An alias IP range attached to an instance&#x27;s network interface.
23685 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
23686 # must belong to the specified subnetwork and cannot contain IP addresses
23687 # reserved by system or used by other network interfaces. This range may be
23688 # 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).
23689 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
23690 # alias range. If not specified, the primary range of the subnetwork is used.
23691 },
23692 ],
23693 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
23694 # You can only specify this field for network interfaces in VPC networks.
23695 { # An alias IP range attached to an instance&#x27;s network interface.
23696 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
23697 # must belong to the specified subnetwork and cannot contain IP addresses
23698 # reserved by system or used by other network interfaces. This range may be
23699 # 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).
23700 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
23701 # alias range. If not specified, the primary range of the subnetwork is used.
23702 },
23703 ],
23704 &quot;dns64Eligible&quot;: True or False, # If true, this network interface is eligible for DNS64.
23705 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
23706 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
23707 # with network_attachment.
23708 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
23709 # This field will be ignored when inserting an Instance or
23710 # adding a NetworkInterface. An up-to-date
23711 # 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.
23712 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
23713 # or not. If enabled, also indicates the version of IGMP supported.
23714 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
23715 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
23716 # one IPv6 access config, DIRECT_IPV6, is supported. If there
23717 # is no ipv6AccessConfig specified, then this instance will
23718 # have no external IPv6 Internet access.
23719 { # An access configuration attached to an instance&#x27;s network interface.
23720 # Only one access config per instance is supported.
23721 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
23722 # The first IPv6 address of the external IPv6 range associated
23723 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
23724 # use a static external IP address, it must be unused and in the same region
23725 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
23726 # assign an external IPv6 address from the instance&#x27;s subnetwork.
23727 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
23728 # external IPv6 range.
23729 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
23730 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
23731 # (IPv4), the default and recommended name is External NAT, but
23732 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
23733 # recommend name is External IPv6.
23734 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
23735 # address associated with this instance. Specify an unused static
23736 # external IP address available to the project or leave this field undefined
23737 # to use an IP from a shared ephemeral IP address pool. If you specify a
23738 # static external IP address, it must live in the same region as the zone of
23739 # the instance.
23740 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
23741 # configuration and can only take the following values: PREMIUM,STANDARD.
23742 #
23743 # If an AccessConfig is specified without a valid external IP address, an
23744 # ephemeral IP will be created with this networkTier.
23745 #
23746 # If an AccessConfig with a valid external IP address is specified, it must
23747 # match that of the networkTier associated with the Address resource owning
23748 # that IP.
23749 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
23750 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
23751 #
23752 # 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
23753 # first IP in associated external IPv6 range.
23754 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
23755 # config.
23756 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
23757 # external IP address of this access configuration.
23758 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
23759 # external IP address of the instance to a DNS domain name.
23760 #
23761 # This field is not used in ipv6AccessConfig. A default PTR
23762 # record will be created if the VM has external IPv6 range associated.
23763 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
23764 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
23765 },
23766 ],
23767 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
23768 # accessed from the Internet. This field is always inherited from its
23769 # subnetwork.
23770 #
23771 # Valid only if stackType is IPV4_IPV6.
23772 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
23773 # use a static internal IP address, it must be unused and in the same region
23774 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
23775 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
23776 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
23777 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
23778 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
23779 # server. For a VM, the network interface uses the nicN naming
23780 # format. Where N is a value between 0 and7. The default interface value is nic0.
23781 &quot;nat64Eligible&quot;: True or False, # If true, this network interface is eligible for NAT64.
23782 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
23783 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
23784 # instance, if neither the network nor the subnetwork is specified, the
23785 # default network global/networks/default is used. If the
23786 # selected project doesn&#x27;t have the default network, you must specify a
23787 # network or subnet. If the network is not specified but the subnetwork is
23788 # specified, the network is inferred.
23789 #
23790 # If you specify this property, you can specify the network as
23791 # a full or partial URL. For example, the following are all valid URLs:
23792 #
23793 #
23794 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
23795 # - projects/project/global/networks/network
23796 # - global/networks/default
23797 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
23798 # to in the following format:
23799 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
23800 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
23801 # interface. If not specified by the user, an unused internal IP is
23802 # assigned by the system.
23803 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
23804 # VirtioNet.
23805 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
23806 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
23807 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
23808 # if not specified by the users.
23809 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
23810 # interface. Can only be used with network_attachment. It is not possible to
23811 # use on its own however, network_attachment can be used without
23812 # service_class_id.
23813 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
23814 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
23815 #
23816 # This field can be both set at instance creation and update network
23817 # interface operations.
23818 &quot;subinterfaces&quot;: [ # SubInterfaces help enable L2 communication for the instance over
23819 # subnetworks that support L2. Every network interface will get a default
23820 # untagged (vlan not specified) subinterface. Users can specify additional
23821 # tagged subinterfaces which are sub-fields to the Network Interface.
23822 {
23823 &quot;ipAddress&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this
23824 # subinterface. If specified, ip_allocation_mode should be set to
23825 # ALLOCATE_IP.
23826 &quot;ipAllocationMode&quot;: &quot;A String&quot;,
23827 &quot;subnetwork&quot;: &quot;A String&quot;, # If specified, this subnetwork must belong to the same network
23828 # as that of the network interface.
23829 # If not specified the subnet of network interface will be used.
23830 # If you specify this property, you can specify the subnetwork as a full
23831 # or partial URL. For example, the following are all valid URLs:
23832 #
23833 #
23834 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
23835 # - regions/region/subnetworks/subnetwork
23836 &quot;vlan&quot;: 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which
23837 # this subinterface is connecting.
23838 },
23839 ],
23840 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
23841 # resource is inlegacy
23842 # mode, do not specify this field. If the network is in auto subnet
23843 # mode, specifying the subnetwork is optional. If the network is in custom
23844 # subnet mode, specifying the subnetwork is required. If you specify this
23845 # field, you can specify the subnetwork as a full or partial URL. For
23846 # example, the following are all valid URLs:
23847 #
23848 #
23849 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
23850 # - regions/region/subnetworks/subnetwork
23851 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
23852 # from 2 to 255 inclusively.
23853 },
23854 ],
23855 &quot;networkPerformanceConfig&quot;: {
23856 &quot;externalIpEgressBandwidthTier&quot;: &quot;A String&quot;,
23857 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
23858 },
23859 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
23860 # as part of resource payload.
23861 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
23862 # Instances.Insert API.
23863 # as a count of seconds and fractions of seconds at nanosecond
23864 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
23865 # or &quot;month&quot;. Range is approximately 10,000 years.
23866 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
23867 # Durations less than one second are represented with a 0
23868 # `seconds` field and a positive `nanos` field. Must be from 0
23869 # to 999,999,999 inclusive.
23870 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
23871 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
23872 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
23873 },
23874 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
23875 # have the same definition as resource
23876 # manager tags. Keys and values can be either in numeric format,
23877 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
23878 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
23879 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
23880 # PATCH) when empty.
23881 &quot;a_key&quot;: &quot;A String&quot;,
23882 },
23883 },
23884 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance. A map from a subdomain
23885 # (namespace) to entries map.
23886 &quot;a_key&quot;: {
23887 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
23888 # It accepts any value including google.protobuf.Struct.
23889 &quot;a_key&quot;: &quot;&quot;,
23890 },
23891 },
23892 },
23893 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
23894 &quot;preservedStateSizeGb&quot;: &quot;A String&quot;, # Output only. Total amount of preserved state for SUSPENDED instances.
23895 # Read-only in the api.
23896 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
23897 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
23898 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
23899 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
23900 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
23901 # Consuming reserved instances for examples.
23902 &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
23903 # the name of your reservation as its value.
23904 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
23905 # either a name to a reservation in the same project or
23906 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
23907 # shared reservation in the same zone but in a different project.
23908 &quot;A String&quot;,
23909 ],
23910 },
23911 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
23912 &quot;A String&quot;,
23913 ],
23914 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
23915 # compared to the values requested by user in the corresponding input only
23916 # field.
23917 # Use this sub-message for actual values set on Instance attributes as compared
23918 # to the value requested by the user (intent) in their instance CRUD calls.
23919 &quot;acceleratorStatus&quot;: [ # Output only. [Output Only] Accelerators status show results of GPU scans. These scans
23920 # are specialized diagnostic tests designed to uncover latent manufacturing
23921 # defects or other issues that could potentially lead to data corruption or
23922 # impede the customer&#x27;s ability to efficiently execute GPU workloads.
23923 { # The status of an individual accelerator resource.
23924 &quot;passedScans&quot;: [ # The details of scans that passed for an accelerator.
23925 {
23926 &quot;endTime&quot;: &quot;A String&quot;, # The end time of the passed scan inRFC3339 text format.
23927 &quot;name&quot;: &quot;A String&quot;,
23928 &quot;startTime&quot;: &quot;A String&quot;, # The start time of the passed scan inRFC3339 text format.
23929 &quot;version&quot;: &quot;A String&quot;,
23930 },
23931 ],
23932 &quot;recommendedScans&quot;: [ # The details of recommended scans for an accelerator.
23933 {
23934 &quot;estimatedDuration&quot;: { # A Duration represents a fixed-length span of time represented
23935 # as a count of seconds and fractions of seconds at nanosecond
23936 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
23937 # or &quot;month&quot;. Range is approximately 10,000 years.
23938 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
23939 # Durations less than one second are represented with a 0
23940 # `seconds` field and a positive `nanos` field. Must be from 0
23941 # to 999,999,999 inclusive.
23942 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
23943 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
23944 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
23945 },
23946 &quot;name&quot;: &quot;A String&quot;,
23947 &quot;version&quot;: &quot;A String&quot;,
23948 },
23949 ],
23950 &quot;serialNumber&quot;: &quot;A String&quot;, # The serial number of the accelerator.
23951 &quot;uuid&quot;: &quot;A String&quot;, # The UUID of the accelerator.
23952 },
23953 ],
23954 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this instance
23955 # is consuming from.
23956 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
23957 # instance is consuming from.
23958 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
23959 # zonal instance settings, and instance-level predefined metadata keys to
23960 # provide the overridden value for those metadata keys at the instance level.
23961 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
23962 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
23963 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
23964 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
23965 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
23966 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
23967 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
23968 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
23969 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
23970 },
23971 &quot;lastInstanceTerminationDetails&quot;: { # Output only. [Output Only] Contains last termination details why the instance was
23972 # terminated.
23973 &quot;terminationReason&quot;: &quot;A String&quot;, # Reason for termination
23974 },
23975 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
23976 # center, including the block, sub-block, and host. The field is formatted as
23977 # follows: blockId/subBlockId/hostId.
23978 &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
23979 # Engine cluster, as well as the ID of the block, sub-block, and host on
23980 # which the running instance is located.
23981 # running.
23982 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
23983 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
23984 # example
23985 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
23986 # the location ID of the topologies.
23987 &quot;a_key&quot;: &quot;A String&quot;,
23988 },
23989 },
23990 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
23991 # located. Instances within the same block experience low network latency.
23992 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
23993 # running instance is located.
23994 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
23995 # Instances on the same host experience the lowest possible network
23996 # latency.
23997 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
23998 # located. Instances in the same sub-block experience lower network latency
23999 # than instances in the same block.
24000 },
24001 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
24002 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
24003 # instance is consuming from.
24004 &quot;consumedReservationBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation block that this
24005 # instance is consuming from.
24006 &quot;consumedReservationSubBlock&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation sub-block that
24007 # this instance is consuming from.
24008 },
24009 &quot;scheduling&quot;: {
24010 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
24011 # must be a number between 1 and the number of availability domains
24012 # specified in the spread placement policy attached to the instance.
24013 &quot;terminationTimestamp&quot;: &quot;A String&quot;, # Time in future when the instance will be terminated inRFC3339 text format.
24014 },
24015 &quot;serviceIntegrationStatuses&quot;: { # [Output Only] Represents the status of the service integration specs
24016 # defined by the user in instance.serviceIntegrationSpecs.
24017 &quot;a_key&quot;: { # Represents the status of integration between instance and another service.
24018 # See go/gce-backupdr-design for more details.
24019 &quot;backupDr&quot;: { # Message defining compute perspective of the result of integration with
24020 # Backup and DR. FAILED status indicates that the operation specified did
24021 # not complete correctly and should be retried with the same value.
24022 &quot;integrationDetails&quot;: &quot;A String&quot;, # The PlanReference object created by Backup and DR to maintain the
24023 # actual status of backups. May still be present if removing the backup
24024 # plan fails.
24025 &quot;state&quot;: &quot;A String&quot;, # Enum representing the registration state of a Backup and DR backup plan
24026 # for the instance.
24027 },
24028 },
24029 },
24030 &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.
24031 # programmed stop scheduled.
24032 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when
24033 # `stop_state=PENDING_STOP`.
24034 # as a count of seconds and fractions of seconds at nanosecond
24035 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
24036 # or &quot;month&quot;. Range is approximately 10,000 years.
24037 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
24038 # Durations less than one second are represented with a 0
24039 # `seconds` field and a positive `nanos` field. Must be from 0
24040 # to 999,999,999 inclusive.
24041 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
24042 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
24043 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
24044 },
24045 &quot;requestTimestamp&quot;: &quot;A String&quot;, # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.
24046 &quot;stopState&quot;: &quot;A String&quot;, # Current stopping state of the instance.
24047 &quot;targetState&quot;: &quot;A String&quot;, # Target instance state.
24048 },
24049 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
24050 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
24051 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
24052 # This value is inRFC3339
24053 # text format.
24054 # DEPRECATED: Use window_start_time instead.
24055 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
24056 # This timestamp value is in RFC3339 text format.
24057 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
24058 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
24059 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
24060 &quot;A String&quot;,
24061 ],
24062 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
24063 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
24064 # DEPRECATED: Use window_start_time instead.
24065 # TimeWindow is a container for two strings that represent timestamps in
24066 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
24067 &quot;earliest&quot;: &quot;A String&quot;,
24068 &quot;latest&quot;: &quot;A String&quot;,
24069 },
24070 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
24071 # This value is inRFC3339
24072 # text format.
24073 # DEPRECATED: Use window_start_time instead.
24074 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
24075 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
24076 # This timestamp value is in RFC3339 text format.
24077 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
24078 # This timestamp value is in RFC3339 text format.
24079 },
24080 },
24081 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
24082 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
24083 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
24084 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
24085 # terminated by Compute Engine (not terminated by a user). You can only set
24086 # the automatic restart option for standard instances.Preemptible instances
24087 # cannot be automatically restarted.
24088 #
24089 # By default, this is set to true so an instance is
24090 # automatically restarted if it is terminated by Compute Engine.
24091 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
24092 # must be a number between 1 and the number of availability domains
24093 # specified in the spread placement policy attached to the instance.
24094 &quot;currentCpus&quot;: 42, # Current number of vCPUs available for VM.
24095 # 0 or unset means default vCPUs of the current machine type.
24096 &quot;currentMemoryMb&quot;: &quot;A String&quot;, # Current amount of memory (in MB) available for VM.
24097 # 0 or unset means default amount of memory of the current machine type.
24098 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
24099 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
24100 &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
24101 # graceful shutdown isn&#x27;t complete after this time, then the instance
24102 # transitions to the STOPPING state.
24103 # as a count of seconds and fractions of seconds at nanosecond
24104 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
24105 # or &quot;month&quot;. Range is approximately 10,000 years.
24106 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
24107 # Durations less than one second are represented with a 0
24108 # `seconds` field and a positive `nanos` field. Must be from 0
24109 # to 999,999,999 inclusive.
24110 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
24111 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
24112 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
24113 },
24114 },
24115 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
24116 # within the range of [90, 330] with the increment of 30, if unset, the
24117 # default behavior of host error recovery will be used.
24118 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
24119 &quot;latencyTolerant&quot;: True or False, # Defines whether the instance is tolerant of higher cpu latency. This can
24120 # only be set during instance creation, or when the instance is not currently
24121 # running. It must not be set if thepreemptible option is
24122 # also set.
24123 &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
24124 # recovery of the Local Ssd state is attempted. Its value should be in
24125 # between 0 and 168 hours with hour granularity and the default value being 1
24126 # hour.
24127 # as a count of seconds and fractions of seconds at nanosecond
24128 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
24129 # or &quot;month&quot;. Range is approximately 10,000 years.
24130 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
24131 # Durations less than one second are represented with a 0
24132 # `seconds` field and a positive `nanos` field. Must be from 0
24133 # to 999,999,999 inclusive.
24134 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
24135 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
24136 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
24137 },
24138 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
24139 # resources.
24140 # This field is for use by internal tools that use the public API.
24141 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
24142 # be scheduled for maintenance.
24143 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
24144 # are: `PERIODIC`.
24145 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
24146 # the instance termination action will be performed at the end of the run
24147 # duration.
24148 # as a count of seconds and fractions of seconds at nanosecond
24149 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
24150 # or &quot;month&quot;. Range is approximately 10,000 years.
24151 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
24152 # Durations less than one second are represented with a 0
24153 # `seconds` field and a positive `nanos` field. Must be from 0
24154 # to 999,999,999 inclusive.
24155 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
24156 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
24157 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
24158 },
24159 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
24160 # on a sole-tenant node.
24161 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
24162 # affinity for more information.
24163 # Overrides reservationAffinity.
24164 { # Node Affinity: the configuration of desired nodes onto which this Instance
24165 # could be scheduled.
24166 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
24167 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
24168 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
24169 &quot;A String&quot;,
24170 ],
24171 },
24172 ],
24173 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
24174 # the default behavior is MIGRATE. Forpreemptible instances,
24175 # the default and only possible behavior is TERMINATE. For more
24176 # information, see
24177 # Set
24178 # VM host maintenance policy.
24179 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
24180 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
24181 # else, the Local SSD data will be preserved when the instance is stopped
24182 # at the end of the run duration/termination time.
24183 },
24184 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
24185 # instance creation or while the instance isstopped and
24186 # therefore, in a `TERMINATED` state. SeeInstance Life
24187 # Cycle for more information on the possible instance states.
24188 &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
24189 # Off signal is triggered for Spot
24190 # VMs only. If not specified, there will be no wait before the G2 Soft
24191 # Off signal is triggered.
24192 # as a count of seconds and fractions of seconds at nanosecond
24193 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
24194 # or &quot;month&quot;. Range is approximately 10,000 years.
24195 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
24196 # Durations less than one second are represented with a 0
24197 # `seconds` field and a positive `nanos` field. Must be from 0
24198 # to 999,999,999 inclusive.
24199 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
24200 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
24201 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
24202 },
24203 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
24204 &quot;shutdownTimeout&quot;: { # A Duration represents a fixed-length span of time represented # DEPRECATED: please use skipGuestOsShutdown.
24205 # Timeout between GCE ACPI G2 Soft
24206 # Off and ACPI G3 Mechanical
24207 # Off during shutdown operation of VM.
24208 #
24209 # For Standard VMs values between 0s and 120s are allowed. For Spot and
24210 # Preemptible VMs supported values are between 0s and 30s.
24211 #
24212 # If no value is specified for shutdownDuration, default values are 90s for
24213 # Standard VMs and 30s for Spot/Preemptible VMs.
24214 # as a count of seconds and fractions of seconds at nanosecond
24215 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
24216 # or &quot;month&quot;. Range is approximately 10,000 years.
24217 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
24218 # Durations less than one second are represented with a 0
24219 # `seconds` field and a positive `nanos` field. Must be from 0
24220 # to 999,999,999 inclusive.
24221 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
24222 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
24223 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
24224 },
24225 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
24226 # Off and ACPI G3 Mechanical
24227 # Off for Standard VMs and 30 seconds for Spot VMs.
24228 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
24229 # termination action will be performed at the termination time.
24230 &quot;vsockMode&quot;: { # Message to control the enablement of the vsock device. # The vsock mode of the instance.
24231 &quot;mode&quot;: &quot;A String&quot;,
24232 },
24233 &quot;windowsLicenseOptimizationMode&quot;: &quot;A String&quot;, # Represents the Windows Server License Optimization Mode of the VM. If
24234 # unspecified, the default mode is `OFF`.
24235 },
24236 &quot;secureTags&quot;: [ # [Input Only] Secure tags to apply to this instance. These can be later
24237 # modified by the update method.
24238 # Maximum number of secure tags allowed is 50.
24239 &quot;A String&quot;,
24240 ],
24241 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
24242 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
24243 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
24244 # this instance. Only one service account per VM instance is supported.
24245 #
24246 # Service accounts generate access tokens that can be accessed
24247 # through the metadata server and used to authenticate applications on the
24248 # instance. SeeService Accounts
24249 # for more information.
24250 { # A service account.
24251 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
24252 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
24253 &quot;A String&quot;,
24254 ],
24255 },
24256 ],
24257 &quot;serviceIntegrationSpecs&quot;: { # Mapping of user-defined keys to specifications for service integrations.
24258 # Currently only a single key-value pair is supported.
24259 &quot;a_key&quot;: { # Specifies the parameters to configure an integration with instances.
24260 &quot;backupDr&quot;: { # Specifies parameters to Backup and DR to attach a BackupPlan to a compute
24261 # instance for managed VM backup.
24262 &quot;plan&quot;: &quot;A String&quot;, # The BackupPlan resource to attach to the instance. Specified as a
24263 # resource reference in instances, and regional instance templates, and as
24264 # just the plan name in global instance templates
24265 },
24266 },
24267 },
24268 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
24269 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
24270 # default.
24271 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
24272 # default.
24273 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
24274 # default.
24275 },
24276 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
24277 # Instance boot integrity is measured.
24278 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
24279 # measurements from the VM instance&#x27;s most recent boot.
24280 },
24281 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Output only. Deprecating, please use shielded_instance_config.
24282 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
24283 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
24284 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
24285 },
24286 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which # Output only. Deprecating, please use shielded_instance_integrity_policy.
24287 # VM instance boot integrity is measured.
24288 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
24289 # measurements from the VM instance&#x27;s most recent boot.
24290 },
24291 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
24292 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
24293 # machine image.
24294 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
24295 # For example:
24296 #
24297 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
24298 # key_region/cryptoKeys/key
24299 #
24300 # The fully-qualifed key name may be returned for resource GET requests. For
24301 # example:
24302 #
24303 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
24304 # key_region/cryptoKeys/key
24305 # /cryptoKeyVersions/1
24306 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
24307 # key. If absent, the Compute Engine default service account is used.
24308 # For example:
24309 #
24310 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
24311 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
24312 # encryption key, encoded in RFC
24313 # 4648 base64 to either encrypt or decrypt this resource. You can
24314 # provide either the rawKey or thersaEncryptedKey.
24315 # For example:
24316 #
24317 # &quot;rawKey&quot;:
24318 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
24319 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
24320 # customer-supplied encryption key to either encrypt or decrypt this
24321 # resource. You can provide either the rawKey or thersaEncryptedKey.
24322 # For example:
24323 #
24324 # &quot;rsaEncryptedKey&quot;:
24325 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
24326 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
24327 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
24328 #
24329 # The key must meet the following requirements before you can provide it to
24330 # Compute Engine:
24331 #
24332 # 1. The key is wrapped using a RSA public key certificate provided by
24333 # Google.
24334 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
24335 # encoding.
24336 #
24337 # Gets the RSA public key certificate provided by Google at:
24338 #
24339 #
24340 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
24341 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
24342 # 4648 base64 encoded SHA-256 hash of the customer-supplied
24343 # encryption key that protects this resource.
24344 },
24345 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
24346 # Engine has detected suspicious activity.
24347 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
24348 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
24349 # instance, see
24350 # Instance life cycle.
24351 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
24352 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
24353 # sources or targets for network firewalls and are specified by the client
24354 # during instance creation. The tags can be later modified by the setTags
24355 # method. Each tag within the list must comply withRFC1035.
24356 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
24357 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
24358 # the tags&#x27; contents and used for optimistic locking. The
24359 # fingerprint is initially generated by Compute Engine and changes after
24360 # every request to modify or update tags. You must always provide an
24361 # up-to-date fingerprint hash in order to update or change tags.
24362 #
24363 # To see the latest fingerprint, make get() request to the
24364 # instance.
24365 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
24366 # with RFC1035.
24367 &quot;A String&quot;,
24368 ],
24369 },
24370 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. [Output Only] DEPRECATED: Please useresource_status.upcoming_maintenance instead. Specifies
24371 # upcoming maintenance for the instance.
24372 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
24373 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
24374 # This value is inRFC3339
24375 # text format.
24376 # DEPRECATED: Use window_start_time instead.
24377 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
24378 # This timestamp value is in RFC3339 text format.
24379 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
24380 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
24381 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
24382 &quot;A String&quot;,
24383 ],
24384 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
24385 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
24386 # DEPRECATED: Use window_start_time instead.
24387 # TimeWindow is a container for two strings that represent timestamps in
24388 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
24389 &quot;earliest&quot;: &quot;A String&quot;,
24390 &quot;latest&quot;: &quot;A String&quot;,
24391 },
24392 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
24393 # This value is inRFC3339
24394 # text format.
24395 # DEPRECATED: Use window_start_time instead.
24396 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
24397 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
24398 # This timestamp value is in RFC3339 text format.
24399 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
24400 # This timestamp value is in RFC3339 text format.
24401 },
24402 &quot;workloadIdentityConfig&quot;: {
24403 &quot;identity&quot;: &quot;A String&quot;,
24404 &quot;identityCertificateEnabled&quot;: True or False,
24405 },
24406 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
24407 # You must specify this field as part of the HTTP request URL. It is
24408 # not settable as a field in the request body.
24409 }
24410
24411 clearSecureTag: boolean, Whether to clear secure tags from the instance.
24412
24413 This property if set to true will clear secure tags regardless of theresource.secure_tags.
24414 discardLocalSsd: boolean, Whether to discard local SSDs from the instance during restart
24415 default value is false.
24416 minimalAction: string, Specifies the action to take when updating an instance even if the
24417 updated properties do not require it. If not specified, then
24418 Compute Engine acts based on the minimum action that the updated
24419 properties require.
24420 Allowed values
24421 INVALID -
24422 NO_EFFECT - No changes can be made to the instance.
24423 REFRESH - The instance will not restart.
24424 RESTART - The instance will restart, potentially on a different host.
24425 mostDisruptiveAllowedAction: string, Specifies the most disruptive action that can be taken on the instance
24426 as part of the update. Compute Engine returns an error if the
24427 instance properties require a more disruptive action as part of the
24428 instance update. Valid options from lowest to highest are
24429 NO_EFFECT, REFRESH, and RESTART.
24430 Allowed values
24431 INVALID -
24432 NO_EFFECT - No changes can be made to the instance.
24433 REFRESH - The instance will not restart.
24434 RESTART - The instance will restart, potentially on a different host.
24435 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
24436 that if you must retry your request, the server will know to ignore the
24437 request if it has already been completed.
24438
24439 For example, consider a situation where you make an initial request and
24440 the request times out. If you make the request again with the same
24441 request ID, the server can check if original operation with the same
24442 request ID was received, and if so, will ignore the second request. This
24443 prevents clients from accidentally creating duplicate commitments.
24444
24445 The request ID must be
24446 a valid UUID with the exception that zero UUID is not supported
24447 (00000000-0000-0000-0000-000000000000).
24448 x__xgafv: string, V1 error format.
24449 Allowed values
24450 1 - v1 error format
24451 2 - v2 error format
24452
24453 Returns:
24454 An object of the form:
24455
24456 { # Represents an Operation resource.
24457 #
24458 # Google Compute Engine has three Operation resources:
24459 #
24460 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
24461 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
24462 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
24463 #
24464 # You can use an operation resource to manage asynchronous API requests.
24465 # For more information, readHandling
24466 # API responses.
24467 #
24468 # Operations can be global, regional or zonal.
24469 #
24470 # - For global operations, use the `globalOperations`
24471 # resource.
24472 # - For regional operations, use the
24473 # `regionOperations` resource.
24474 # - For zonal operations, use
24475 # the `zoneOperations` resource.
24476 #
24477 #
24478 #
24479 # For more information, read
24480 # Global, Regional, and Zonal Resources.
24481 #
24482 # Note that completed Operation resources have a limited
24483 # retention period.
24484 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
24485 # Not present otherwise.
24486 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
24487 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
24488 # set when the operation is created.
24489 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
24490 # text format.
24491 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
24492 # this field will be populated.
24493 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
24494 # operation.
24495 {
24496 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
24497 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
24498 # details. There is a set of defined message types to use for providing
24499 # details.The syntax depends on the error code. For example,
24500 # QuotaExceededInfo will have details when the error code is
24501 # QUOTA_EXCEEDED.
24502 {
24503 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
24504 #
24505 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
24506 # is not enabled:
24507 #
24508 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
24509 # &quot;domain&quot;: &quot;googleapis.com&quot;
24510 # &quot;metadata&quot;: {
24511 # &quot;resource&quot;: &quot;projects/123&quot;,
24512 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
24513 # }
24514 # }
24515 #
24516 # This response indicates that the pubsub.googleapis.com API is not enabled.
24517 #
24518 # Example of an error that is returned when attempting to create a Spanner
24519 # instance in a region that is out of stock:
24520 #
24521 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
24522 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
24523 # &quot;metadata&quot;: {
24524 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
24525 # }
24526 # }
24527 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
24528 # is typically the registered service name of the tool or product that
24529 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
24530 # generated by some common infrastructure, the error domain must be a
24531 # globally unique value that identifies the infrastructure. For Google API
24532 # infrastructure, the error domain is &quot;googleapis.com&quot;.
24533 &quot;metadatas&quot;: { # Additional structured details about this error.
24534 #
24535 # Keys must match a regular expression of `a-z+` but should
24536 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
24537 # length. When identifying the current value of an exceeded limit, the units
24538 # should be contained in the key, not the value. For example, rather than
24539 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
24540 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
24541 # instances that can be created in a single (batch) request.
24542 &quot;a_key&quot;: &quot;A String&quot;,
24543 },
24544 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
24545 # proximate cause of the error. Error reasons are unique within a particular
24546 # domain of errors. This should be at most 63 characters and match a
24547 # regular expression of `A-Z+[A-Z0-9]`, which represents
24548 # UPPER_SNAKE_CASE.
24549 },
24550 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
24551 #
24552 # For example, if a quota check failed with an error indicating the calling
24553 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
24554 # directly to the right place in the developer console to flip the bit.
24555 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
24556 { # Describes a URL link.
24557 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
24558 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
24559 },
24560 ],
24561 },
24562 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
24563 # which can be attached to an RPC error.
24564 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
24565 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
24566 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
24567 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
24568 },
24569 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
24570 &quot;dimensions&quot;: { # The map holding related quota dimensions.
24571 &quot;a_key&quot;: &quot;A String&quot;,
24572 },
24573 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
24574 # type or metric.
24575 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
24576 # or metric.
24577 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
24578 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
24579 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
24580 },
24581 },
24582 ],
24583 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
24584 # This property is optional.
24585 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
24586 },
24587 ],
24588 },
24589 &quot;getVersionOperationMetadata&quot;: {
24590 &quot;inlineSbomInfo&quot;: {
24591 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
24592 # appropriate identifiers.
24593 &quot;a_key&quot;: &quot;A String&quot;,
24594 },
24595 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
24596 # identifiers.
24597 &quot;a_key&quot;: &quot;A String&quot;,
24598 },
24599 },
24600 },
24601 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
24602 # message that was returned, such as `NOT FOUND`.
24603 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
24604 # status code that was returned. For example, a `404` means the
24605 # resource was not found.
24606 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
24607 # defined by the server.
24608 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
24609 # This value is inRFC3339
24610 # text format.
24611 &quot;instancesBulkInsertOperationMetadata&quot;: {
24612 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
24613 # Example key: zones/us-central1-a
24614 &quot;a_key&quot;: {
24615 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
24616 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
24617 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
24618 # error.
24619 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
24620 # if the flow is rolling forward or rolling back.
24621 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
24622 },
24623 },
24624 },
24625 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
24626 # Operation resources.
24627 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
24628 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
24629 # group of operations results from a `bulkInsert` API request.
24630 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
24631 # `update`, or `delete`, and so on.
24632 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
24633 # There is no requirement that this be linear or support any granularity of
24634 # operations. This should not be used to guess when the operation will be
24635 # complete. This number should monotonically increase as the operation
24636 # progresses.
24637 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
24638 # applicable when performing regional operations.
24639 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
24640 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
24641 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
24642 # this field will contain information on all underlying zonal actions and
24643 # their state.
24644 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
24645 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
24646 # Example key: zones/us-central1-a
24647 &quot;a_key&quot;: {
24648 &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
24649 # populated.
24650 # different programming environments, including REST APIs and RPC APIs. It is
24651 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
24652 # three pieces of data: error code, error message, and error details.
24653 #
24654 # You can find out more about this error model and how to work with it in the
24655 # [API Design Guide](https://cloud.google.com/apis/design/errors).
24656 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
24657 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
24658 # message types for APIs to use.
24659 {
24660 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
24661 },
24662 ],
24663 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
24664 # user-facing error message should be localized and sent in the
24665 # google.rpc.Status.details field, or localized by the client.
24666 },
24667 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
24668 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
24669 },
24670 },
24671 },
24672 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
24673 # This value is inRFC3339
24674 # text format.
24675 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
24676 # following:
24677 # `PENDING`, `RUNNING`, or `DONE`.
24678 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
24679 # operation.
24680 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
24681 # of the target resource.
24682 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
24683 # operations related to creating a snapshot, this points to the disk
24684 # that the snapshot was created from.
24685 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
24686 # `[email protected]` or
24687 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
24688 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
24689 # operation, this field will be populated.
24690 {
24691 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
24692 # Engine returns NO_RESULTS_ON_PAGE if there
24693 # are no results in the response.
24694 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
24695 # value format. For example:
24696 #
24697 # &quot;data&quot;: [
24698 # {
24699 # &quot;key&quot;: &quot;scope&quot;,
24700 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
24701 # }
24702 {
24703 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
24704 # returned. For example, for warnings where there are no results in a list
24705 # request for a particular zone, this key might be scope and
24706 # the key value might be the zone name. Other examples might be a key
24707 # indicating a deprecated resource and a suggested replacement, or a
24708 # warning about invalid network settings (for example, if an instance
24709 # attempts to perform IP forwarding but is not enabled for IP forwarding).
24710 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
24711 },
24712 ],
24713 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
24714 },
24715 ],
24716 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
24717 # applicable when performing per-zone operations.
24718 }</pre>
24719 </div>
24720
24721 <div class="method">
24722 <code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>
24723 <pre>Updates the specified access config from an instance&#x27;s network interface
24724 with the data included in the request. This method supportsPATCH
24725 semantics and uses theJSON merge
24726 patch format and processing rules.
24727
24728 Args:
24729 project: string, Project ID for this request. (required)
24730 zone: string, The name of the zone for this request. (required)
24731 instance: string, The instance name for this request. (required)
24732 networkInterface: string, The name of the network interface where the access config is attached. (required)
24733 body: object, The request body.
24734 The object takes the form of:
24735
24736 { # An access configuration attached to an instance&#x27;s network interface.
24737 # Only one access config per instance is supported.
24738 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
24739 # The first IPv6 address of the external IPv6 range associated
24740 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
24741 # use a static external IP address, it must be unused and in the same region
24742 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
24743 # assign an external IPv6 address from the instance&#x27;s subnetwork.
24744 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
24745 # external IPv6 range.
24746 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
24747 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
24748 # (IPv4), the default and recommended name is External NAT, but
24749 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
24750 # recommend name is External IPv6.
24751 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
24752 # address associated with this instance. Specify an unused static
24753 # external IP address available to the project or leave this field undefined
24754 # to use an IP from a shared ephemeral IP address pool. If you specify a
24755 # static external IP address, it must live in the same region as the zone of
24756 # the instance.
24757 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
24758 # configuration and can only take the following values: PREMIUM,STANDARD.
24759 #
24760 # If an AccessConfig is specified without a valid external IP address, an
24761 # ephemeral IP will be created with this networkTier.
24762 #
24763 # If an AccessConfig with a valid external IP address is specified, it must
24764 # match that of the networkTier associated with the Address resource owning
24765 # that IP.
24766 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
24767 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
24768 #
24769 # 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
24770 # first IP in associated external IPv6 range.
24771 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
24772 # config.
24773 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
24774 # external IP address of this access configuration.
24775 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
24776 # external IP address of the instance to a DNS domain name.
24777 #
24778 # This field is not used in ipv6AccessConfig. A default PTR
24779 # record will be created if the VM has external IPv6 range associated.
24780 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
24781 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
24782 }
24783
24784 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
24785 that if you must retry your request, the server will know to ignore the
24786 request if it has already been completed.
24787
24788 For example, consider a situation where you make an initial request and
24789 the request times out. If you make the request again with the same
24790 request ID, the server can check if original operation with the same
24791 request ID was received, and if so, will ignore the second request. This
24792 prevents clients from accidentally creating duplicate commitments.
24793
24794 The request ID must be
24795 a valid UUID with the exception that zero UUID is not supported
24796 (00000000-0000-0000-0000-000000000000).
24797 x__xgafv: string, V1 error format.
24798 Allowed values
24799 1 - v1 error format
24800 2 - v2 error format
24801
24802 Returns:
24803 An object of the form:
24804
24805 { # Represents an Operation resource.
24806 #
24807 # Google Compute Engine has three Operation resources:
24808 #
24809 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
24810 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
24811 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
24812 #
24813 # You can use an operation resource to manage asynchronous API requests.
24814 # For more information, readHandling
24815 # API responses.
24816 #
24817 # Operations can be global, regional or zonal.
24818 #
24819 # - For global operations, use the `globalOperations`
24820 # resource.
24821 # - For regional operations, use the
24822 # `regionOperations` resource.
24823 # - For zonal operations, use
24824 # the `zoneOperations` resource.
24825 #
24826 #
24827 #
24828 # For more information, read
24829 # Global, Regional, and Zonal Resources.
24830 #
24831 # Note that completed Operation resources have a limited
24832 # retention period.
24833 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
24834 # Not present otherwise.
24835 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
24836 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
24837 # set when the operation is created.
24838 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
24839 # text format.
24840 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
24841 # this field will be populated.
24842 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
24843 # operation.
24844 {
24845 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
24846 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
24847 # details. There is a set of defined message types to use for providing
24848 # details.The syntax depends on the error code. For example,
24849 # QuotaExceededInfo will have details when the error code is
24850 # QUOTA_EXCEEDED.
24851 {
24852 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
24853 #
24854 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
24855 # is not enabled:
24856 #
24857 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
24858 # &quot;domain&quot;: &quot;googleapis.com&quot;
24859 # &quot;metadata&quot;: {
24860 # &quot;resource&quot;: &quot;projects/123&quot;,
24861 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
24862 # }
24863 # }
24864 #
24865 # This response indicates that the pubsub.googleapis.com API is not enabled.
24866 #
24867 # Example of an error that is returned when attempting to create a Spanner
24868 # instance in a region that is out of stock:
24869 #
24870 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
24871 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
24872 # &quot;metadata&quot;: {
24873 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
24874 # }
24875 # }
24876 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
24877 # is typically the registered service name of the tool or product that
24878 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
24879 # generated by some common infrastructure, the error domain must be a
24880 # globally unique value that identifies the infrastructure. For Google API
24881 # infrastructure, the error domain is &quot;googleapis.com&quot;.
24882 &quot;metadatas&quot;: { # Additional structured details about this error.
24883 #
24884 # Keys must match a regular expression of `a-z+` but should
24885 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
24886 # length. When identifying the current value of an exceeded limit, the units
24887 # should be contained in the key, not the value. For example, rather than
24888 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
24889 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
24890 # instances that can be created in a single (batch) request.
24891 &quot;a_key&quot;: &quot;A String&quot;,
24892 },
24893 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
24894 # proximate cause of the error. Error reasons are unique within a particular
24895 # domain of errors. This should be at most 63 characters and match a
24896 # regular expression of `A-Z+[A-Z0-9]`, which represents
24897 # UPPER_SNAKE_CASE.
24898 },
24899 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
24900 #
24901 # For example, if a quota check failed with an error indicating the calling
24902 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
24903 # directly to the right place in the developer console to flip the bit.
24904 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
24905 { # Describes a URL link.
24906 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
24907 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
24908 },
24909 ],
24910 },
24911 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
24912 # which can be attached to an RPC error.
24913 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
24914 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
24915 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
24916 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
24917 },
24918 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
24919 &quot;dimensions&quot;: { # The map holding related quota dimensions.
24920 &quot;a_key&quot;: &quot;A String&quot;,
24921 },
24922 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
24923 # type or metric.
24924 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
24925 # or metric.
24926 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
24927 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
24928 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
24929 },
24930 },
24931 ],
24932 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
24933 # This property is optional.
24934 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
24935 },
24936 ],
24937 },
24938 &quot;getVersionOperationMetadata&quot;: {
24939 &quot;inlineSbomInfo&quot;: {
24940 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
24941 # appropriate identifiers.
24942 &quot;a_key&quot;: &quot;A String&quot;,
24943 },
24944 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
24945 # identifiers.
24946 &quot;a_key&quot;: &quot;A String&quot;,
24947 },
24948 },
24949 },
24950 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
24951 # message that was returned, such as `NOT FOUND`.
24952 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
24953 # status code that was returned. For example, a `404` means the
24954 # resource was not found.
24955 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
24956 # defined by the server.
24957 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
24958 # This value is inRFC3339
24959 # text format.
24960 &quot;instancesBulkInsertOperationMetadata&quot;: {
24961 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
24962 # Example key: zones/us-central1-a
24963 &quot;a_key&quot;: {
24964 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
24965 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
24966 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
24967 # error.
24968 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
24969 # if the flow is rolling forward or rolling back.
24970 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
24971 },
24972 },
24973 },
24974 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
24975 # Operation resources.
24976 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
24977 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
24978 # group of operations results from a `bulkInsert` API request.
24979 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
24980 # `update`, or `delete`, and so on.
24981 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
24982 # There is no requirement that this be linear or support any granularity of
24983 # operations. This should not be used to guess when the operation will be
24984 # complete. This number should monotonically increase as the operation
24985 # progresses.
24986 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
24987 # applicable when performing regional operations.
24988 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
24989 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
24990 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
24991 # this field will contain information on all underlying zonal actions and
24992 # their state.
24993 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
24994 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
24995 # Example key: zones/us-central1-a
24996 &quot;a_key&quot;: {
24997 &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
24998 # populated.
24999 # different programming environments, including REST APIs and RPC APIs. It is
25000 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
25001 # three pieces of data: error code, error message, and error details.
25002 #
25003 # You can find out more about this error model and how to work with it in the
25004 # [API Design Guide](https://cloud.google.com/apis/design/errors).
25005 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
25006 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
25007 # message types for APIs to use.
25008 {
25009 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
25010 },
25011 ],
25012 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
25013 # user-facing error message should be localized and sent in the
25014 # google.rpc.Status.details field, or localized by the client.
25015 },
25016 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
25017 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
25018 },
25019 },
25020 },
25021 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
25022 # This value is inRFC3339
25023 # text format.
25024 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
25025 # following:
25026 # `PENDING`, `RUNNING`, or `DONE`.
25027 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
25028 # operation.
25029 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
25030 # of the target resource.
25031 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
25032 # operations related to creating a snapshot, this points to the disk
25033 # that the snapshot was created from.
25034 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
25035 # `[email protected]` or
25036 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
25037 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
25038 # operation, this field will be populated.
25039 {
25040 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
25041 # Engine returns NO_RESULTS_ON_PAGE if there
25042 # are no results in the response.
25043 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
25044 # value format. For example:
25045 #
25046 # &quot;data&quot;: [
25047 # {
25048 # &quot;key&quot;: &quot;scope&quot;,
25049 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
25050 # }
25051 {
25052 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
25053 # returned. For example, for warnings where there are no results in a list
25054 # request for a particular zone, this key might be scope and
25055 # the key value might be the zone name. Other examples might be a key
25056 # indicating a deprecated resource and a suggested replacement, or a
25057 # warning about invalid network settings (for example, if an instance
25058 # attempts to perform IP forwarding but is not enabled for IP forwarding).
25059 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
25060 },
25061 ],
25062 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
25063 },
25064 ],
25065 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
25066 # applicable when performing per-zone operations.
25067 }</pre>
25068 </div>
25069
25070 <div class="method">
25071 <code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
25072 <pre>Updates the Display config for a VM instance. You can
25073 only use this method on a stopped VM instance. This method supportsPATCH
25074 semantics and uses theJSON merge
25075 patch format and processing rules.
25076
25077 Args:
25078 project: string, Project ID for this request. (required)
25079 zone: string, The name of the zone for this request. (required)
25080 instance: string, Name of the instance scoping this request. (required)
25081 body: object, The request body.
25082 The object takes the form of:
25083
25084 { # A set of Display Device options
25085 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
25086 }
25087
25088 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
25089 that if you must retry your request, the server will know to ignore the
25090 request if it has already been completed.
25091
25092 For example, consider a situation where you make an initial request and
25093 the request times out. If you make the request again with the same
25094 request ID, the server can check if original operation with the same
25095 request ID was received, and if so, will ignore the second request. This
25096 prevents clients from accidentally creating duplicate commitments.
25097
25098 The request ID must be
25099 a valid UUID with the exception that zero UUID is not supported
25100 (00000000-0000-0000-0000-000000000000).
25101 x__xgafv: string, V1 error format.
25102 Allowed values
25103 1 - v1 error format
25104 2 - v2 error format
25105
25106 Returns:
25107 An object of the form:
25108
25109 { # Represents an Operation resource.
25110 #
25111 # Google Compute Engine has three Operation resources:
25112 #
25113 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
25114 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
25115 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
25116 #
25117 # You can use an operation resource to manage asynchronous API requests.
25118 # For more information, readHandling
25119 # API responses.
25120 #
25121 # Operations can be global, regional or zonal.
25122 #
25123 # - For global operations, use the `globalOperations`
25124 # resource.
25125 # - For regional operations, use the
25126 # `regionOperations` resource.
25127 # - For zonal operations, use
25128 # the `zoneOperations` resource.
25129 #
25130 #
25131 #
25132 # For more information, read
25133 # Global, Regional, and Zonal Resources.
25134 #
25135 # Note that completed Operation resources have a limited
25136 # retention period.
25137 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
25138 # Not present otherwise.
25139 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
25140 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
25141 # set when the operation is created.
25142 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
25143 # text format.
25144 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
25145 # this field will be populated.
25146 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
25147 # operation.
25148 {
25149 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
25150 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
25151 # details. There is a set of defined message types to use for providing
25152 # details.The syntax depends on the error code. For example,
25153 # QuotaExceededInfo will have details when the error code is
25154 # QUOTA_EXCEEDED.
25155 {
25156 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
25157 #
25158 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
25159 # is not enabled:
25160 #
25161 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
25162 # &quot;domain&quot;: &quot;googleapis.com&quot;
25163 # &quot;metadata&quot;: {
25164 # &quot;resource&quot;: &quot;projects/123&quot;,
25165 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
25166 # }
25167 # }
25168 #
25169 # This response indicates that the pubsub.googleapis.com API is not enabled.
25170 #
25171 # Example of an error that is returned when attempting to create a Spanner
25172 # instance in a region that is out of stock:
25173 #
25174 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
25175 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
25176 # &quot;metadata&quot;: {
25177 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
25178 # }
25179 # }
25180 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
25181 # is typically the registered service name of the tool or product that
25182 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
25183 # generated by some common infrastructure, the error domain must be a
25184 # globally unique value that identifies the infrastructure. For Google API
25185 # infrastructure, the error domain is &quot;googleapis.com&quot;.
25186 &quot;metadatas&quot;: { # Additional structured details about this error.
25187 #
25188 # Keys must match a regular expression of `a-z+` but should
25189 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
25190 # length. When identifying the current value of an exceeded limit, the units
25191 # should be contained in the key, not the value. For example, rather than
25192 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
25193 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
25194 # instances that can be created in a single (batch) request.
25195 &quot;a_key&quot;: &quot;A String&quot;,
25196 },
25197 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
25198 # proximate cause of the error. Error reasons are unique within a particular
25199 # domain of errors. This should be at most 63 characters and match a
25200 # regular expression of `A-Z+[A-Z0-9]`, which represents
25201 # UPPER_SNAKE_CASE.
25202 },
25203 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
25204 #
25205 # For example, if a quota check failed with an error indicating the calling
25206 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
25207 # directly to the right place in the developer console to flip the bit.
25208 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
25209 { # Describes a URL link.
25210 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
25211 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
25212 },
25213 ],
25214 },
25215 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
25216 # which can be attached to an RPC error.
25217 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
25218 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
25219 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
25220 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
25221 },
25222 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
25223 &quot;dimensions&quot;: { # The map holding related quota dimensions.
25224 &quot;a_key&quot;: &quot;A String&quot;,
25225 },
25226 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
25227 # type or metric.
25228 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
25229 # or metric.
25230 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
25231 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
25232 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
25233 },
25234 },
25235 ],
25236 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
25237 # This property is optional.
25238 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
25239 },
25240 ],
25241 },
25242 &quot;getVersionOperationMetadata&quot;: {
25243 &quot;inlineSbomInfo&quot;: {
25244 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
25245 # appropriate identifiers.
25246 &quot;a_key&quot;: &quot;A String&quot;,
25247 },
25248 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
25249 # identifiers.
25250 &quot;a_key&quot;: &quot;A String&quot;,
25251 },
25252 },
25253 },
25254 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
25255 # message that was returned, such as `NOT FOUND`.
25256 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
25257 # status code that was returned. For example, a `404` means the
25258 # resource was not found.
25259 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
25260 # defined by the server.
25261 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
25262 # This value is inRFC3339
25263 # text format.
25264 &quot;instancesBulkInsertOperationMetadata&quot;: {
25265 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
25266 # Example key: zones/us-central1-a
25267 &quot;a_key&quot;: {
25268 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
25269 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
25270 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
25271 # error.
25272 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
25273 # if the flow is rolling forward or rolling back.
25274 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
25275 },
25276 },
25277 },
25278 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
25279 # Operation resources.
25280 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
25281 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
25282 # group of operations results from a `bulkInsert` API request.
25283 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
25284 # `update`, or `delete`, and so on.
25285 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
25286 # There is no requirement that this be linear or support any granularity of
25287 # operations. This should not be used to guess when the operation will be
25288 # complete. This number should monotonically increase as the operation
25289 # progresses.
25290 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
25291 # applicable when performing regional operations.
25292 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
25293 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
25294 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
25295 # this field will contain information on all underlying zonal actions and
25296 # their state.
25297 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
25298 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
25299 # Example key: zones/us-central1-a
25300 &quot;a_key&quot;: {
25301 &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
25302 # populated.
25303 # different programming environments, including REST APIs and RPC APIs. It is
25304 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
25305 # three pieces of data: error code, error message, and error details.
25306 #
25307 # You can find out more about this error model and how to work with it in the
25308 # [API Design Guide](https://cloud.google.com/apis/design/errors).
25309 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
25310 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
25311 # message types for APIs to use.
25312 {
25313 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
25314 },
25315 ],
25316 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
25317 # user-facing error message should be localized and sent in the
25318 # google.rpc.Status.details field, or localized by the client.
25319 },
25320 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
25321 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
25322 },
25323 },
25324 },
25325 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
25326 # This value is inRFC3339
25327 # text format.
25328 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
25329 # following:
25330 # `PENDING`, `RUNNING`, or `DONE`.
25331 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
25332 # operation.
25333 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
25334 # of the target resource.
25335 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
25336 # operations related to creating a snapshot, this points to the disk
25337 # that the snapshot was created from.
25338 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
25339 # `[email protected]` or
25340 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
25341 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
25342 # operation, this field will be populated.
25343 {
25344 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
25345 # Engine returns NO_RESULTS_ON_PAGE if there
25346 # are no results in the response.
25347 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
25348 # value format. For example:
25349 #
25350 # &quot;data&quot;: [
25351 # {
25352 # &quot;key&quot;: &quot;scope&quot;,
25353 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
25354 # }
25355 {
25356 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
25357 # returned. For example, for warnings where there are no results in a list
25358 # request for a particular zone, this key might be scope and
25359 # the key value might be the zone name. Other examples might be a key
25360 # indicating a deprecated resource and a suggested replacement, or a
25361 # warning about invalid network settings (for example, if an instance
25362 # attempts to perform IP forwarding but is not enabled for IP forwarding).
25363 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
25364 },
25365 ],
25366 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
25367 },
25368 ],
25369 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
25370 # applicable when performing per-zone operations.
25371 }</pre>
25372 </div>
25373
25374 <div class="method">
25375 <code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>
25376 <pre>Updates an instance&#x27;s network interface. This method can only update an
25377 interface&#x27;s alias IP range and attached network. See Modifying
25378 alias IP ranges for an existing instance for instructions on
25379 changing alias IP ranges. See Migrating
25380 a VM between networks for instructions on migrating an interface.
25381 This method follows PATCH semantics.
25382
25383 Args:
25384 project: string, Project ID for this request. (required)
25385 zone: string, The name of the zone for this request. (required)
25386 instance: string, The instance name for this request. (required)
25387 networkInterface: string, The name of the network interface to update. (required)
25388 body: object, The request body.
25389 The object takes the form of:
25390
25391 { # A network interface resource attached to an instance.
25392 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
25393 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
25394 # no external internet access.
25395 { # An access configuration attached to an instance&#x27;s network interface.
25396 # Only one access config per instance is supported.
25397 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
25398 # The first IPv6 address of the external IPv6 range associated
25399 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
25400 # use a static external IP address, it must be unused and in the same region
25401 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
25402 # assign an external IPv6 address from the instance&#x27;s subnetwork.
25403 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
25404 # external IPv6 range.
25405 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
25406 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
25407 # (IPv4), the default and recommended name is External NAT, but
25408 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
25409 # recommend name is External IPv6.
25410 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
25411 # address associated with this instance. Specify an unused static
25412 # external IP address available to the project or leave this field undefined
25413 # to use an IP from a shared ephemeral IP address pool. If you specify a
25414 # static external IP address, it must live in the same region as the zone of
25415 # the instance.
25416 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
25417 # configuration and can only take the following values: PREMIUM,STANDARD.
25418 #
25419 # If an AccessConfig is specified without a valid external IP address, an
25420 # ephemeral IP will be created with this networkTier.
25421 #
25422 # If an AccessConfig with a valid external IP address is specified, it must
25423 # match that of the networkTier associated with the Address resource owning
25424 # that IP.
25425 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
25426 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
25427 #
25428 # 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
25429 # first IP in associated external IPv6 range.
25430 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
25431 # config.
25432 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
25433 # external IP address of this access configuration.
25434 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
25435 # external IP address of the instance to a DNS domain name.
25436 #
25437 # This field is not used in ipv6AccessConfig. A default PTR
25438 # record will be created if the VM has external IPv6 range associated.
25439 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
25440 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
25441 },
25442 ],
25443 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
25444 # You can only specify this field for network interfaces in VPC networks.
25445 { # An alias IP range attached to an instance&#x27;s network interface.
25446 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
25447 # must belong to the specified subnetwork and cannot contain IP addresses
25448 # reserved by system or used by other network interfaces. This range may be
25449 # 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).
25450 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
25451 # alias range. If not specified, the primary range of the subnetwork is used.
25452 },
25453 ],
25454 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
25455 # You can only specify this field for network interfaces in VPC networks.
25456 { # An alias IP range attached to an instance&#x27;s network interface.
25457 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
25458 # must belong to the specified subnetwork and cannot contain IP addresses
25459 # reserved by system or used by other network interfaces. This range may be
25460 # 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).
25461 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
25462 # alias range. If not specified, the primary range of the subnetwork is used.
25463 },
25464 ],
25465 &quot;dns64Eligible&quot;: True or False, # If true, this network interface is eligible for DNS64.
25466 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
25467 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
25468 # with network_attachment.
25469 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
25470 # This field will be ignored when inserting an Instance or
25471 # adding a NetworkInterface. An up-to-date
25472 # 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.
25473 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
25474 # or not. If enabled, also indicates the version of IGMP supported.
25475 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
25476 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
25477 # one IPv6 access config, DIRECT_IPV6, is supported. If there
25478 # is no ipv6AccessConfig specified, then this instance will
25479 # have no external IPv6 Internet access.
25480 { # An access configuration attached to an instance&#x27;s network interface.
25481 # Only one access config per instance is supported.
25482 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
25483 # The first IPv6 address of the external IPv6 range associated
25484 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
25485 # use a static external IP address, it must be unused and in the same region
25486 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
25487 # assign an external IPv6 address from the instance&#x27;s subnetwork.
25488 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
25489 # external IPv6 range.
25490 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
25491 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
25492 # (IPv4), the default and recommended name is External NAT, but
25493 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
25494 # recommend name is External IPv6.
25495 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
25496 # address associated with this instance. Specify an unused static
25497 # external IP address available to the project or leave this field undefined
25498 # to use an IP from a shared ephemeral IP address pool. If you specify a
25499 # static external IP address, it must live in the same region as the zone of
25500 # the instance.
25501 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
25502 # configuration and can only take the following values: PREMIUM,STANDARD.
25503 #
25504 # If an AccessConfig is specified without a valid external IP address, an
25505 # ephemeral IP will be created with this networkTier.
25506 #
25507 # If an AccessConfig with a valid external IP address is specified, it must
25508 # match that of the networkTier associated with the Address resource owning
25509 # that IP.
25510 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
25511 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
25512 #
25513 # 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
25514 # first IP in associated external IPv6 range.
25515 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
25516 # config.
25517 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
25518 # external IP address of this access configuration.
25519 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
25520 # external IP address of the instance to a DNS domain name.
25521 #
25522 # This field is not used in ipv6AccessConfig. A default PTR
25523 # record will be created if the VM has external IPv6 range associated.
25524 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
25525 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
25526 },
25527 ],
25528 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
25529 # accessed from the Internet. This field is always inherited from its
25530 # subnetwork.
25531 #
25532 # Valid only if stackType is IPV4_IPV6.
25533 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
25534 # use a static internal IP address, it must be unused and in the same region
25535 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
25536 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
25537 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
25538 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
25539 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
25540 # server. For a VM, the network interface uses the nicN naming
25541 # format. Where N is a value between 0 and7. The default interface value is nic0.
25542 &quot;nat64Eligible&quot;: True or False, # If true, this network interface is eligible for NAT64.
25543 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
25544 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
25545 # instance, if neither the network nor the subnetwork is specified, the
25546 # default network global/networks/default is used. If the
25547 # selected project doesn&#x27;t have the default network, you must specify a
25548 # network or subnet. If the network is not specified but the subnetwork is
25549 # specified, the network is inferred.
25550 #
25551 # If you specify this property, you can specify the network as
25552 # a full or partial URL. For example, the following are all valid URLs:
25553 #
25554 #
25555 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
25556 # - projects/project/global/networks/network
25557 # - global/networks/default
25558 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
25559 # to in the following format:
25560 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
25561 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
25562 # interface. If not specified by the user, an unused internal IP is
25563 # assigned by the system.
25564 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
25565 # VirtioNet.
25566 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
25567 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
25568 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
25569 # if not specified by the users.
25570 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
25571 # interface. Can only be used with network_attachment. It is not possible to
25572 # use on its own however, network_attachment can be used without
25573 # service_class_id.
25574 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
25575 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
25576 #
25577 # This field can be both set at instance creation and update network
25578 # interface operations.
25579 &quot;subinterfaces&quot;: [ # SubInterfaces help enable L2 communication for the instance over
25580 # subnetworks that support L2. Every network interface will get a default
25581 # untagged (vlan not specified) subinterface. Users can specify additional
25582 # tagged subinterfaces which are sub-fields to the Network Interface.
25583 {
25584 &quot;ipAddress&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this
25585 # subinterface. If specified, ip_allocation_mode should be set to
25586 # ALLOCATE_IP.
25587 &quot;ipAllocationMode&quot;: &quot;A String&quot;,
25588 &quot;subnetwork&quot;: &quot;A String&quot;, # If specified, this subnetwork must belong to the same network
25589 # as that of the network interface.
25590 # If not specified the subnet of network interface will be used.
25591 # If you specify this property, you can specify the subnetwork as a full
25592 # or partial URL. For example, the following are all valid URLs:
25593 #
25594 #
25595 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
25596 # - regions/region/subnetworks/subnetwork
25597 &quot;vlan&quot;: 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which
25598 # this subinterface is connecting.
25599 },
25600 ],
25601 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
25602 # resource is inlegacy
25603 # mode, do not specify this field. If the network is in auto subnet
25604 # mode, specifying the subnetwork is optional. If the network is in custom
25605 # subnet mode, specifying the subnetwork is required. If you specify this
25606 # field, you can specify the subnetwork as a full or partial URL. For
25607 # example, the following are all valid URLs:
25608 #
25609 #
25610 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
25611 # - regions/region/subnetworks/subnetwork
25612 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
25613 # from 2 to 255 inclusively.
25614 }
25615
25616 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
25617 that if you must retry your request, the server will know to ignore the
25618 request if it has already been completed.
25619
25620 For example, consider a situation where you make an initial request and
25621 the request times out. If you make the request again with the same
25622 request ID, the server can check if original operation with the same
25623 request ID was received, and if so, will ignore the second request. This
25624 prevents clients from accidentally creating duplicate commitments.
25625
25626 The request ID must be
25627 a valid UUID with the exception that zero UUID is not supported
25628 (00000000-0000-0000-0000-000000000000).
25629 x__xgafv: string, V1 error format.
25630 Allowed values
25631 1 - v1 error format
25632 2 - v2 error format
25633
25634 Returns:
25635 An object of the form:
25636
25637 { # Represents an Operation resource.
25638 #
25639 # Google Compute Engine has three Operation resources:
25640 #
25641 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
25642 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
25643 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
25644 #
25645 # You can use an operation resource to manage asynchronous API requests.
25646 # For more information, readHandling
25647 # API responses.
25648 #
25649 # Operations can be global, regional or zonal.
25650 #
25651 # - For global operations, use the `globalOperations`
25652 # resource.
25653 # - For regional operations, use the
25654 # `regionOperations` resource.
25655 # - For zonal operations, use
25656 # the `zoneOperations` resource.
25657 #
25658 #
25659 #
25660 # For more information, read
25661 # Global, Regional, and Zonal Resources.
25662 #
25663 # Note that completed Operation resources have a limited
25664 # retention period.
25665 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
25666 # Not present otherwise.
25667 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
25668 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
25669 # set when the operation is created.
25670 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
25671 # text format.
25672 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
25673 # this field will be populated.
25674 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
25675 # operation.
25676 {
25677 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
25678 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
25679 # details. There is a set of defined message types to use for providing
25680 # details.The syntax depends on the error code. For example,
25681 # QuotaExceededInfo will have details when the error code is
25682 # QUOTA_EXCEEDED.
25683 {
25684 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
25685 #
25686 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
25687 # is not enabled:
25688 #
25689 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
25690 # &quot;domain&quot;: &quot;googleapis.com&quot;
25691 # &quot;metadata&quot;: {
25692 # &quot;resource&quot;: &quot;projects/123&quot;,
25693 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
25694 # }
25695 # }
25696 #
25697 # This response indicates that the pubsub.googleapis.com API is not enabled.
25698 #
25699 # Example of an error that is returned when attempting to create a Spanner
25700 # instance in a region that is out of stock:
25701 #
25702 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
25703 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
25704 # &quot;metadata&quot;: {
25705 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
25706 # }
25707 # }
25708 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
25709 # is typically the registered service name of the tool or product that
25710 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
25711 # generated by some common infrastructure, the error domain must be a
25712 # globally unique value that identifies the infrastructure. For Google API
25713 # infrastructure, the error domain is &quot;googleapis.com&quot;.
25714 &quot;metadatas&quot;: { # Additional structured details about this error.
25715 #
25716 # Keys must match a regular expression of `a-z+` but should
25717 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
25718 # length. When identifying the current value of an exceeded limit, the units
25719 # should be contained in the key, not the value. For example, rather than
25720 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
25721 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
25722 # instances that can be created in a single (batch) request.
25723 &quot;a_key&quot;: &quot;A String&quot;,
25724 },
25725 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
25726 # proximate cause of the error. Error reasons are unique within a particular
25727 # domain of errors. This should be at most 63 characters and match a
25728 # regular expression of `A-Z+[A-Z0-9]`, which represents
25729 # UPPER_SNAKE_CASE.
25730 },
25731 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
25732 #
25733 # For example, if a quota check failed with an error indicating the calling
25734 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
25735 # directly to the right place in the developer console to flip the bit.
25736 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
25737 { # Describes a URL link.
25738 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
25739 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
25740 },
25741 ],
25742 },
25743 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
25744 # which can be attached to an RPC error.
25745 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
25746 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
25747 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
25748 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
25749 },
25750 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
25751 &quot;dimensions&quot;: { # The map holding related quota dimensions.
25752 &quot;a_key&quot;: &quot;A String&quot;,
25753 },
25754 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
25755 # type or metric.
25756 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
25757 # or metric.
25758 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
25759 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
25760 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
25761 },
25762 },
25763 ],
25764 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
25765 # This property is optional.
25766 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
25767 },
25768 ],
25769 },
25770 &quot;getVersionOperationMetadata&quot;: {
25771 &quot;inlineSbomInfo&quot;: {
25772 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
25773 # appropriate identifiers.
25774 &quot;a_key&quot;: &quot;A String&quot;,
25775 },
25776 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
25777 # identifiers.
25778 &quot;a_key&quot;: &quot;A String&quot;,
25779 },
25780 },
25781 },
25782 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
25783 # message that was returned, such as `NOT FOUND`.
25784 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
25785 # status code that was returned. For example, a `404` means the
25786 # resource was not found.
25787 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
25788 # defined by the server.
25789 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
25790 # This value is inRFC3339
25791 # text format.
25792 &quot;instancesBulkInsertOperationMetadata&quot;: {
25793 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
25794 # Example key: zones/us-central1-a
25795 &quot;a_key&quot;: {
25796 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
25797 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
25798 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
25799 # error.
25800 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
25801 # if the flow is rolling forward or rolling back.
25802 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
25803 },
25804 },
25805 },
25806 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
25807 # Operation resources.
25808 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
25809 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
25810 # group of operations results from a `bulkInsert` API request.
25811 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
25812 # `update`, or `delete`, and so on.
25813 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
25814 # There is no requirement that this be linear or support any granularity of
25815 # operations. This should not be used to guess when the operation will be
25816 # complete. This number should monotonically increase as the operation
25817 # progresses.
25818 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
25819 # applicable when performing regional operations.
25820 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
25821 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
25822 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
25823 # this field will contain information on all underlying zonal actions and
25824 # their state.
25825 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
25826 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
25827 # Example key: zones/us-central1-a
25828 &quot;a_key&quot;: {
25829 &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
25830 # populated.
25831 # different programming environments, including REST APIs and RPC APIs. It is
25832 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
25833 # three pieces of data: error code, error message, and error details.
25834 #
25835 # You can find out more about this error model and how to work with it in the
25836 # [API Design Guide](https://cloud.google.com/apis/design/errors).
25837 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
25838 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
25839 # message types for APIs to use.
25840 {
25841 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
25842 },
25843 ],
25844 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
25845 # user-facing error message should be localized and sent in the
25846 # google.rpc.Status.details field, or localized by the client.
25847 },
25848 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
25849 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
25850 },
25851 },
25852 },
25853 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
25854 # This value is inRFC3339
25855 # text format.
25856 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
25857 # following:
25858 # `PENDING`, `RUNNING`, or `DONE`.
25859 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
25860 # operation.
25861 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
25862 # of the target resource.
25863 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
25864 # operations related to creating a snapshot, this points to the disk
25865 # that the snapshot was created from.
25866 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
25867 # `[email protected]` or
25868 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
25869 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
25870 # operation, this field will be populated.
25871 {
25872 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
25873 # Engine returns NO_RESULTS_ON_PAGE if there
25874 # are no results in the response.
25875 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
25876 # value format. For example:
25877 #
25878 # &quot;data&quot;: [
25879 # {
25880 # &quot;key&quot;: &quot;scope&quot;,
25881 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
25882 # }
25883 {
25884 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
25885 # returned. For example, for warnings where there are no results in a list
25886 # request for a particular zone, this key might be scope and
25887 # the key value might be the zone name. Other examples might be a key
25888 # indicating a deprecated resource and a suggested replacement, or a
25889 # warning about invalid network settings (for example, if an instance
25890 # attempts to perform IP forwarding but is not enabled for IP forwarding).
25891 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
25892 },
25893 ],
25894 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
25895 },
25896 ],
25897 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
25898 # applicable when performing per-zone operations.
25899 }</pre>
25900 </div>
25901
25902 <div class="method">
25903 <code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
25904 <pre>Updates the Shielded Instance config for an instance. You can
25905 only use this method on a stopped instance. This method supportsPATCH
25906 semantics and uses theJSON merge
25907 patch format and processing rules.
25908
25909 Args:
25910 project: string, Project ID for this request. (required)
25911 zone: string, The name of the zone for this request. (required)
25912 instance: string, Name or id of the instance scoping this request. (required)
25913 body: object, The request body.
25914 The object takes the form of:
25915
25916 { # A set of Shielded Instance options.
25917 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
25918 # default.
25919 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
25920 # default.
25921 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
25922 # default.
25923 }
25924
25925 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
25926 that if you must retry your request, the server will know to ignore the
25927 request if it has already been completed.
25928
25929 For example, consider a situation where you make an initial request and
25930 the request times out. If you make the request again with the same
25931 request ID, the server can check if original operation with the same
25932 request ID was received, and if so, will ignore the second request. This
25933 prevents clients from accidentally creating duplicate commitments.
25934
25935 The request ID must be
25936 a valid UUID with the exception that zero UUID is not supported
25937 (00000000-0000-0000-0000-000000000000).
25938 x__xgafv: string, V1 error format.
25939 Allowed values
25940 1 - v1 error format
25941 2 - v2 error format
25942
25943 Returns:
25944 An object of the form:
25945
25946 { # Represents an Operation resource.
25947 #
25948 # Google Compute Engine has three Operation resources:
25949 #
25950 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
25951 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
25952 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
25953 #
25954 # You can use an operation resource to manage asynchronous API requests.
25955 # For more information, readHandling
25956 # API responses.
25957 #
25958 # Operations can be global, regional or zonal.
25959 #
25960 # - For global operations, use the `globalOperations`
25961 # resource.
25962 # - For regional operations, use the
25963 # `regionOperations` resource.
25964 # - For zonal operations, use
25965 # the `zoneOperations` resource.
25966 #
25967 #
25968 #
25969 # For more information, read
25970 # Global, Regional, and Zonal Resources.
25971 #
25972 # Note that completed Operation resources have a limited
25973 # retention period.
25974 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
25975 # Not present otherwise.
25976 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
25977 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
25978 # set when the operation is created.
25979 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
25980 # text format.
25981 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
25982 # this field will be populated.
25983 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
25984 # operation.
25985 {
25986 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
25987 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
25988 # details. There is a set of defined message types to use for providing
25989 # details.The syntax depends on the error code. For example,
25990 # QuotaExceededInfo will have details when the error code is
25991 # QUOTA_EXCEEDED.
25992 {
25993 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
25994 #
25995 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
25996 # is not enabled:
25997 #
25998 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
25999 # &quot;domain&quot;: &quot;googleapis.com&quot;
26000 # &quot;metadata&quot;: {
26001 # &quot;resource&quot;: &quot;projects/123&quot;,
26002 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
26003 # }
26004 # }
26005 #
26006 # This response indicates that the pubsub.googleapis.com API is not enabled.
26007 #
26008 # Example of an error that is returned when attempting to create a Spanner
26009 # instance in a region that is out of stock:
26010 #
26011 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
26012 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
26013 # &quot;metadata&quot;: {
26014 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
26015 # }
26016 # }
26017 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
26018 # is typically the registered service name of the tool or product that
26019 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
26020 # generated by some common infrastructure, the error domain must be a
26021 # globally unique value that identifies the infrastructure. For Google API
26022 # infrastructure, the error domain is &quot;googleapis.com&quot;.
26023 &quot;metadatas&quot;: { # Additional structured details about this error.
26024 #
26025 # Keys must match a regular expression of `a-z+` but should
26026 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
26027 # length. When identifying the current value of an exceeded limit, the units
26028 # should be contained in the key, not the value. For example, rather than
26029 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
26030 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
26031 # instances that can be created in a single (batch) request.
26032 &quot;a_key&quot;: &quot;A String&quot;,
26033 },
26034 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
26035 # proximate cause of the error. Error reasons are unique within a particular
26036 # domain of errors. This should be at most 63 characters and match a
26037 # regular expression of `A-Z+[A-Z0-9]`, which represents
26038 # UPPER_SNAKE_CASE.
26039 },
26040 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
26041 #
26042 # For example, if a quota check failed with an error indicating the calling
26043 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
26044 # directly to the right place in the developer console to flip the bit.
26045 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
26046 { # Describes a URL link.
26047 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
26048 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
26049 },
26050 ],
26051 },
26052 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
26053 # which can be attached to an RPC error.
26054 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
26055 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
26056 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
26057 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
26058 },
26059 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
26060 &quot;dimensions&quot;: { # The map holding related quota dimensions.
26061 &quot;a_key&quot;: &quot;A String&quot;,
26062 },
26063 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
26064 # type or metric.
26065 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
26066 # or metric.
26067 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
26068 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
26069 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
26070 },
26071 },
26072 ],
26073 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
26074 # This property is optional.
26075 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
26076 },
26077 ],
26078 },
26079 &quot;getVersionOperationMetadata&quot;: {
26080 &quot;inlineSbomInfo&quot;: {
26081 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
26082 # appropriate identifiers.
26083 &quot;a_key&quot;: &quot;A String&quot;,
26084 },
26085 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
26086 # identifiers.
26087 &quot;a_key&quot;: &quot;A String&quot;,
26088 },
26089 },
26090 },
26091 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
26092 # message that was returned, such as `NOT FOUND`.
26093 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
26094 # status code that was returned. For example, a `404` means the
26095 # resource was not found.
26096 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
26097 # defined by the server.
26098 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
26099 # This value is inRFC3339
26100 # text format.
26101 &quot;instancesBulkInsertOperationMetadata&quot;: {
26102 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
26103 # Example key: zones/us-central1-a
26104 &quot;a_key&quot;: {
26105 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
26106 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
26107 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
26108 # error.
26109 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
26110 # if the flow is rolling forward or rolling back.
26111 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
26112 },
26113 },
26114 },
26115 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
26116 # Operation resources.
26117 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
26118 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
26119 # group of operations results from a `bulkInsert` API request.
26120 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
26121 # `update`, or `delete`, and so on.
26122 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
26123 # There is no requirement that this be linear or support any granularity of
26124 # operations. This should not be used to guess when the operation will be
26125 # complete. This number should monotonically increase as the operation
26126 # progresses.
26127 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
26128 # applicable when performing regional operations.
26129 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
26130 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
26131 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
26132 # this field will contain information on all underlying zonal actions and
26133 # their state.
26134 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
26135 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
26136 # Example key: zones/us-central1-a
26137 &quot;a_key&quot;: {
26138 &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
26139 # populated.
26140 # different programming environments, including REST APIs and RPC APIs. It is
26141 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
26142 # three pieces of data: error code, error message, and error details.
26143 #
26144 # You can find out more about this error model and how to work with it in the
26145 # [API Design Guide](https://cloud.google.com/apis/design/errors).
26146 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
26147 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
26148 # message types for APIs to use.
26149 {
26150 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
26151 },
26152 ],
26153 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
26154 # user-facing error message should be localized and sent in the
26155 # google.rpc.Status.details field, or localized by the client.
26156 },
26157 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
26158 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
26159 },
26160 },
26161 },
26162 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
26163 # This value is inRFC3339
26164 # text format.
26165 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
26166 # following:
26167 # `PENDING`, `RUNNING`, or `DONE`.
26168 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
26169 # operation.
26170 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
26171 # of the target resource.
26172 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
26173 # operations related to creating a snapshot, this points to the disk
26174 # that the snapshot was created from.
26175 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
26176 # `[email protected]` or
26177 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
26178 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
26179 # operation, this field will be populated.
26180 {
26181 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
26182 # Engine returns NO_RESULTS_ON_PAGE if there
26183 # are no results in the response.
26184 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
26185 # value format. For example:
26186 #
26187 # &quot;data&quot;: [
26188 # {
26189 # &quot;key&quot;: &quot;scope&quot;,
26190 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
26191 # }
26192 {
26193 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
26194 # returned. For example, for warnings where there are no results in a list
26195 # request for a particular zone, this key might be scope and
26196 # the key value might be the zone name. Other examples might be a key
26197 # indicating a deprecated resource and a suggested replacement, or a
26198 # warning about invalid network settings (for example, if an instance
26199 # attempts to perform IP forwarding but is not enabled for IP forwarding).
26200 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
26201 },
26202 ],
26203 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
26204 },
26205 ],
26206 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
26207 # applicable when performing per-zone operations.
26208 }</pre>
26209 </div>
26210
26211 <div class="method">
26212 <code class="details" id="updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
26213 <pre>Updates the Shielded VM config for a VM instance. You can
26214 only use this method on a stopped VM instance. This method supportsPATCH
26215 semantics and uses theJSON merge
26216 patch format and processing rules.
26217
26218 Args:
26219 project: string, Project ID for this request. (required)
26220 zone: string, The name of the zone for this request. (required)
26221 instance: string, Name of the instance scoping this request. (required)
26222 body: object, The request body.
26223 The object takes the form of:
26224
26225 { # A set of Shielded VM options.
26226 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
26227 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
26228 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
26229 }
26230
26231 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
26232 that if you must retry your request, the server will know to ignore the
26233 request if it has already been completed.
26234
26235 For example, consider a situation where you make an initial request and
26236 the request times out. If you make the request again with the same
26237 request ID, the server can check if original operation with the same
26238 request ID was received, and if so, will ignore the second request. This
26239 prevents clients from accidentally creating duplicate commitments.
26240
26241 The request ID must be
26242 a valid UUID with the exception that zero UUID is not supported
26243 (00000000-0000-0000-0000-000000000000).
26244 x__xgafv: string, V1 error format.
26245 Allowed values
26246 1 - v1 error format
26247 2 - v2 error format
26248
26249 Returns:
26250 An object of the form:
26251
26252 { # Represents an Operation resource.
26253 #
26254 # Google Compute Engine has three Operation resources:
26255 #
26256 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
26257 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
26258 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
26259 #
26260 # You can use an operation resource to manage asynchronous API requests.
26261 # For more information, readHandling
26262 # API responses.
26263 #
26264 # Operations can be global, regional or zonal.
26265 #
26266 # - For global operations, use the `globalOperations`
26267 # resource.
26268 # - For regional operations, use the
26269 # `regionOperations` resource.
26270 # - For zonal operations, use
26271 # the `zoneOperations` resource.
26272 #
26273 #
26274 #
26275 # For more information, read
26276 # Global, Regional, and Zonal Resources.
26277 #
26278 # Note that completed Operation resources have a limited
26279 # retention period.
26280 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
26281 # Not present otherwise.
26282 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
26283 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
26284 # set when the operation is created.
26285 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
26286 # text format.
26287 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
26288 # this field will be populated.
26289 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
26290 # operation.
26291 {
26292 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
26293 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
26294 # details. There is a set of defined message types to use for providing
26295 # details.The syntax depends on the error code. For example,
26296 # QuotaExceededInfo will have details when the error code is
26297 # QUOTA_EXCEEDED.
26298 {
26299 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
26300 #
26301 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
26302 # is not enabled:
26303 #
26304 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
26305 # &quot;domain&quot;: &quot;googleapis.com&quot;
26306 # &quot;metadata&quot;: {
26307 # &quot;resource&quot;: &quot;projects/123&quot;,
26308 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
26309 # }
26310 # }
26311 #
26312 # This response indicates that the pubsub.googleapis.com API is not enabled.
26313 #
26314 # Example of an error that is returned when attempting to create a Spanner
26315 # instance in a region that is out of stock:
26316 #
26317 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
26318 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
26319 # &quot;metadata&quot;: {
26320 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
26321 # }
26322 # }
26323 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
26324 # is typically the registered service name of the tool or product that
26325 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
26326 # generated by some common infrastructure, the error domain must be a
26327 # globally unique value that identifies the infrastructure. For Google API
26328 # infrastructure, the error domain is &quot;googleapis.com&quot;.
26329 &quot;metadatas&quot;: { # Additional structured details about this error.
26330 #
26331 # Keys must match a regular expression of `a-z+` but should
26332 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
26333 # length. When identifying the current value of an exceeded limit, the units
26334 # should be contained in the key, not the value. For example, rather than
26335 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
26336 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
26337 # instances that can be created in a single (batch) request.
26338 &quot;a_key&quot;: &quot;A String&quot;,
26339 },
26340 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
26341 # proximate cause of the error. Error reasons are unique within a particular
26342 # domain of errors. This should be at most 63 characters and match a
26343 # regular expression of `A-Z+[A-Z0-9]`, which represents
26344 # UPPER_SNAKE_CASE.
26345 },
26346 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
26347 #
26348 # For example, if a quota check failed with an error indicating the calling
26349 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
26350 # directly to the right place in the developer console to flip the bit.
26351 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
26352 { # Describes a URL link.
26353 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
26354 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
26355 },
26356 ],
26357 },
26358 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
26359 # which can be attached to an RPC error.
26360 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
26361 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
26362 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
26363 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
26364 },
26365 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
26366 &quot;dimensions&quot;: { # The map holding related quota dimensions.
26367 &quot;a_key&quot;: &quot;A String&quot;,
26368 },
26369 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
26370 # type or metric.
26371 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
26372 # or metric.
26373 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
26374 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
26375 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
26376 },
26377 },
26378 ],
26379 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
26380 # This property is optional.
26381 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
26382 },
26383 ],
26384 },
26385 &quot;getVersionOperationMetadata&quot;: {
26386 &quot;inlineSbomInfo&quot;: {
26387 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
26388 # appropriate identifiers.
26389 &quot;a_key&quot;: &quot;A String&quot;,
26390 },
26391 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
26392 # identifiers.
26393 &quot;a_key&quot;: &quot;A String&quot;,
26394 },
26395 },
26396 },
26397 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
26398 # message that was returned, such as `NOT FOUND`.
26399 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
26400 # status code that was returned. For example, a `404` means the
26401 # resource was not found.
26402 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
26403 # defined by the server.
26404 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
26405 # This value is inRFC3339
26406 # text format.
26407 &quot;instancesBulkInsertOperationMetadata&quot;: {
26408 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
26409 # Example key: zones/us-central1-a
26410 &quot;a_key&quot;: {
26411 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
26412 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
26413 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
26414 # error.
26415 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
26416 # if the flow is rolling forward or rolling back.
26417 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
26418 },
26419 },
26420 },
26421 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
26422 # Operation resources.
26423 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
26424 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
26425 # group of operations results from a `bulkInsert` API request.
26426 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
26427 # `update`, or `delete`, and so on.
26428 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
26429 # There is no requirement that this be linear or support any granularity of
26430 # operations. This should not be used to guess when the operation will be
26431 # complete. This number should monotonically increase as the operation
26432 # progresses.
26433 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
26434 # applicable when performing regional operations.
26435 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
26436 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
26437 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
26438 # this field will contain information on all underlying zonal actions and
26439 # their state.
26440 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
26441 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
26442 # Example key: zones/us-central1-a
26443 &quot;a_key&quot;: {
26444 &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
26445 # populated.
26446 # different programming environments, including REST APIs and RPC APIs. It is
26447 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
26448 # three pieces of data: error code, error message, and error details.
26449 #
26450 # You can find out more about this error model and how to work with it in the
26451 # [API Design Guide](https://cloud.google.com/apis/design/errors).
26452 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
26453 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
26454 # message types for APIs to use.
26455 {
26456 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
26457 },
26458 ],
26459 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
26460 # user-facing error message should be localized and sent in the
26461 # google.rpc.Status.details field, or localized by the client.
26462 },
26463 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
26464 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
26465 },
26466 },
26467 },
26468 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
26469 # This value is inRFC3339
26470 # text format.
26471 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
26472 # following:
26473 # `PENDING`, `RUNNING`, or `DONE`.
26474 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
26475 # operation.
26476 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
26477 # of the target resource.
26478 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
26479 # operations related to creating a snapshot, this points to the disk
26480 # that the snapshot was created from.
26481 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
26482 # `[email protected]` or
26483 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
26484 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
26485 # operation, this field will be populated.
26486 {
26487 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
26488 # Engine returns NO_RESULTS_ON_PAGE if there
26489 # are no results in the response.
26490 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
26491 # value format. For example:
26492 #
26493 # &quot;data&quot;: [
26494 # {
26495 # &quot;key&quot;: &quot;scope&quot;,
26496 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
26497 # }
26498 {
26499 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
26500 # returned. For example, for warnings where there are no results in a list
26501 # request for a particular zone, this key might be scope and
26502 # the key value might be the zone name. Other examples might be a key
26503 # indicating a deprecated resource and a suggested replacement, or a
26504 # warning about invalid network settings (for example, if an instance
26505 # attempts to perform IP forwarding but is not enabled for IP forwarding).
26506 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
26507 },
26508 ],
26509 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
26510 },
26511 ],
26512 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
26513 # applicable when performing per-zone operations.
26514 }</pre>
26515 </div>
26516
26517 </body></html>